Add User to Security Group.

Assign a Security Group to a User Profile.

SecurityApiKeyAuth or BasicAuth
Request
path Parameters
id
required
string

Specify a User Profile ID.

header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

Authorization
required
string

Provided by Authentication Token creation operation

AccessToken
required
string

JWT token provided by Authentication Token creation operation.

Request Body schema: application/json
required

The Request Body must be a JSON object

userGroupId
string <uuid>

group-id of a valid existing user-security-group of customer

userGroupName
string

group-name of a valid existing user-security-group of a customer

Responses
200

The Response Body will be a JSON object

400

Bad Request, Group is not valid or User is already part of group

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Forbidden. Missing X-API-key

patch/user/{id}/add-to-group
Request samples
application/json
{
  • "userGroupId": "7d6207c0-f423-11e9-8071-89c0c4052141",
  • "userGroupName": "string"
}
Response samples
application/json
{
  • "status": "success",
  • "message": "User Profile update was successful"
}