Get All Roles

Gets a list of all roles.

continuationToken: Required for v2. Used for paging. Pull the token from the paging section in the previous response to get the next page. Leave blank to get the first page. If no token is returned, there are no more results.

URL

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

Method

GET

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

Request Header Parameters

Type Value Description
Authorization
required		 Bearer {access_token} IMS access token
continuationToken
optional		 {continuationToken} Continuation Token used for pagination

Example

Request

Curl Example Request

Response

{
    "data": [
        {
            "name": "Analytics Admin",
            "description": "Admin for Analytics service",
            "org": "jci.com",
            "id": "Analytics Admin",
            "subject": "5f597832-3a0f-c472-7cd2-aea417621f9d"
        },
        {
            "name": "Analytics Read Only",
            "description": "Can only read data from Analytics service",
            "org": "jci.com",
            "id": "Analytics Read Only",
            "subject": "28b989f7-b66a-26a2-2e07-9c198b2225e4"
        },
        {
            "name": "IdentityManager Admin",
            "description": "Admin for the IdentityManager application",
            "org": "jci.com",
            "id": "IdentityManager Admin",
            "subject": "9806a5a1-05b5-3c0a-adb7-84ce0c3da8c4"
        }
    ],
    "paging": {
        "continuationToken": null,
        "totalCount": 3
    }
}

Errors

Error Description
Error Name Description of Error

Response Body Parameters

Name Description Schema
Object Name Description object definition
data Description object definition
paging Description object definition