Create Group

This endpoint creates a new group

URL

https://{{HOST}}/security/group?groupId=groupId&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

Request Header Parameters

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

Request Body Parameters

Name Description Type
Id
required		 Id of new group string
organization
required		 Organization the group belongs to string

Example

Request

curl -X POST 
  'https://{{HOST}}/security/group?groupId=testGroup&v=2.0' 
  -H 'Authorization: Bearer {access_token}' 
  -H 'Content-Type: application/json' 
  -d '{
    "Id": "testGroup",
    "organization": "testOrganization"
  }'

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