List groups

get https://{hostname}/identity-management/v3/user-admin/groups

This operation lists all groups the administrator can manage for the current account and contract type or other managed accounts using the accountSwitchKey parameter. The account and contract type are determined by the access tokens in your API client.

Response

Response body

array of objects

object

actions

object

Specifies activities available for the group.

createdBy

string

required

length ≥ 1

The user who created the group.

createdDate

date-time

required

ISO 8601 timestamp indicating when the group was created.

groupId

integer

required

≥ 1

Unique identifier for each group.

groupName

string

required

length ≥ 1

Descriptive label for the group.

modifiedBy

string

required

length ≥ 1

The user who last edited the group.

modifiedDate

date-time

required

ISO 8601 timestamp indicating when the group was last updated.

parentGroupId

integer

≥ 0

Unique identifier for the parent group within the group tree. If you're viewing group info for a root-level group, you may not see this member.

subGroups

array of objects

required

length ≥ 0

Children of the parent group. Permissions cascade downward from parent to child unless the child group's isBlocked is true.

subGroups*

object

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/identity-management/v3/user-admin/groups \
3
     --header 'accept: application/json'


xxxxxxxxxx
45
]
1
[
2
  {
3
    "actions": {
4
      "delete": false,
5
      "edit": true
6
    },
7
    "createdBy": "szhang",
8
    "createdDate": "2012-04-28T00:00:00.000Z",
9
    "groupId": 12345,
10
    "groupName": "Main Street Corporation",
11
    "modifiedBy": "hgildong",
12
    "modifiedDate": "2012-04-28T00:00:00.000Z",
13
    "subGroups": [
14
      {
15
        "actions": {
16
          "delete": false,
17
          "edit": true
18
        },
19
        "createdBy": "szhang",
20
        "createdDate": "2013-10-29T19:05:52.000Z",
21
        "groupId": 12345,
22
        "groupName": "Internet Company",
23
        "modifiedBy": "mrossi",
24
        "modifiedDate": "2017-07-25T22:30:20.000Z",
25
        "parentGroupId": 12345,

200The response provides the groups.