Search for Groups

Overview

Use this API to retrieve user groups in a department. Only user groups that the logged in user can view are returned.

Permissions

Actor Permission
User All of the following are required:
  • If logged in user is a department user:
    • The department must be the home department of the user, or a department in which the user is a foreign user.
  • If the logged in user is a global user, one of the below is required:
    • User must have 'Administer' permission on the provided department.
    • User must have one of following privileges: 'View partition resources', 'Manage partition resources'
Client Application No additional permission is required.
SecurityoAuthUser or oAuthClient
Request
path Parameters
id
required
string

Department Id to be used in filtering. API returns the user groups of the department.

Example: 999
query Parameters
$sort
string

Objects returned in server response are sorted based on the attribute supplied under $sort.

Enum: "id" "name"
$order
string

Common query parameter $order.

Enum: "asc" "desc"
$pagenum
string

Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
Default value: 1

$pagesize
string

Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
Default value: 25

$rangestart
string

Range parameter that specifies the starting index of the range of results to be returned. Used in conjunction with $rangesize.
Default value: 1

$rangesize
string

Range parameter that specifies the number (range) of results to be returned. Used in conjunction with $rangestart.
Default value: 25

header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Responses
200

OK

204

NO Content

  • No matches were found for given search criteria.
  • Matches found for this search, however the requested page or range doesn't contain any results.
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal server error

get/department/{id}/groups
Request samples
Response samples
application/json
    

  • GET core/usermgr/v3/department/1002/groups
    • 

  • This example demonstrates the following:
      

    • Search for groups based on department.
      • 

    

    • 



{
  • "group": [
    ],
  • "paginationInfo": {
    }
}