Link User to Group

Link a specific user to a Group

Only Admin can link a user to a group.

URL

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

Method

POST

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

Request Header Parameters

Type Value Description
Authorization
required		 Bearer {access_token} IMS access token
Content-Type application/json
required		 Description

Example

Request

curl -X POST 
  'https://{{HOST}}/security/group/user?groupId=testGroup&userId=testUser&v=2.0' 
  -H 'Authorization: Bearer {access_token}'

Response

{
    "success": true
}

Errors

Error Description
Error Name Description of Error

Response Body Parameters

Name Description Schema
Object Name Description object definition
success Description object definition