Get Groups

Gets all of the groups.

URL

https://{{HOST}}/security/group?v={version}

Method

GET

Required IMS Scopes

  • securityapi_all

Versions Supported

  • 2.0 (Default)

URL Query Parameters

Name Description Example Type
v
optional		 Version of the api to use /group?v=2.0 number

Request Header Parameters

Type Value Description
Authorization
required		 Bearer {access_token} IMS access token
continuationToken
optional		 {continuationToken} Continuation Token used for pagination

Example

Request

curl -X GET 
  'https://{{HOST}}/security/group?v=2.0' 
  -H 'Authorization: Bearer {access_token}'

Response

{
    "data": [
        {
            "id": "testGroup1",
            "subject": null,
            "organization": "testOrganization"
        },
        {
            "id": "testGroup2",
            "subject": null,
            "organization": "testOrganization"
        },
        {
            "id": "testGroup3",
            "subject": null,
            "organization": "testOrganization"
        },
        {
            "id": "testGroup4",
            "subject": null,
            "organization": "testOrganization"
        }
    ],
    "paging": {
        "continuationToken": null,
        "totalCount": 4
    }
}

Errors

Error Description
Error Name Description of Error

Response Body Parameters

Name Description Schema
Object Name Description object definition
data Description object definition
paging Description object definition