Create Role

Creates a new role for an organization.

URL

https://{{HOST}}/security/role?v={version}&roleId={roleId}

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 /role?v=2.0 number
roleId
optional		 The ID of the role. /role?roleId=testRole 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
Name
required		 Name of the new role. string
Description
required		 The description of the new Role to help explain its purpose. string
Organization
required		 The organization this role is to be tied to. organization

Example

Request

curl -X POST 
  'https://{{HOST}}/security/role?v=2.0&roleId=testRole' 
  -H 'Authorization: Bearer {access_token}' 
  -H 'Content-Type: application/json' 
  -d '{
      "name": "testRole",
      "description": "This is a test role",
      "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