Role Object
Contains information about a security role on the API platform, and in some cases also the users who are assigned to it.
This object is used by the following operations:
- PUT /api/roles/{ResourceID}/{RoleName} (in the response)
- GET /api/roles/{ResourceID}/{RoleName} (in the response)
- GET /api/roles/{ResourceID} (in the response)
The properties included in the Role object are listed below.
| Property | Type | Description |
|---|---|---|
| roleName | string | The name of the security role. |
| description | string | The description of the security role. Returned in some operations. |
| resourceID | string | The ID of the resource that the role applies to. |
| users | RoleUser | An array of UserIDs; one or more users who are assigned to the role. Used in some operations; see examples. |
| Link | URL | A link to the information about the role and users assigned to it. |