Get Group

Gets a specific group.

URL

https://{{HOST}}/security/group?groupId={groupId}&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
groupId
required		 The ID of the group. /group?groupId=testGroup string

Request Header Parameters

Type Value Description
Authorization
required		 Bearer {access_token} IMS access token

Example

Request

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

Response

{
    "id":"testGroup",
    "subject":"null"
}

Errors

Error Description
Error Name Description of Error

Response Body Parameters

Name Description Schema
id Description object definition
subject Description object definition