Roles API

A role effectively represents a collection of permissions for a user. A user’s roles can be accessed in the IMS Token. User’s roles can not be used for ACL Permissions.

Example Role

Property Type Description
Id String Friendly identifier. Identifies the name of the role.
Subject String A consistent identifier that is usually a GUID. This is useful when deleting and recreating an identical representation to distinguish between the previous one and the new one.
Name String A secondary ID property. This is required when updating the ID.
Description String Describes the purpose of the role.

Example Role Object

{
  "name": "Analytics Admin",
  "description": "Admin for Analytics service",
  "id": "Analytics Admin",
  "subject": "5f597832-3a0f-c472-7cd2-aea417621f9d"
}