Get User Groups

Gets groups linked to a specific user.

URL

https://{{HOST}}/security/user/groups?v={version}&userId={userId}

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 /user?v=2.0 number
userId
required		 The ID of the user. /user?userId=testUser string

Request Header Parameters

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

Example

Request

curl -X GET 
  'https://{{HOST}}/securityapi/user/groups?v=2.0&userId=testUser' 
  -H 'Authorization: Bearer {access_token}'

Response

[
  {
    "id": "JCI_test",
    "subject": null
  }
]

Errors

Error Description
Error Name Description of Error

Response Body Parameters

Name Description Schema
Object Name Description object definition
id Description object definition
subject Description object definition