Roles Resource

Provides role management functions.

GET /{tenantGuid}/api/v1/roles/admin

Available Since:
12.13.0

Get a list of all admin roles in the system.

Sample

 
 {
     "roles": [
         {
             "guid": "8186600a-f084-46c2-b0c0-f34317c77094",
             "name": "Security administrator",
             "description": "Full permissions to manage the BlackBerry Enterprise Solution. Only administrators assigned this role can create and edit roles."
         },
         {
             "guid": "18def094-0c4b-4581-b346-3f4566bf5cf9",
             "name": "Enterprise administrator",
             "description": "Permissions to perform advanced administrative tasks."
         }
     ]
 }

Response Codes
Code Condition Data type
200 OK.
Response Body
Media type Data type Description
application/vnd.blackberry.adminroles-v1+json Admin roles (JSON)

GET /{tenantGuid}/api/v1/roles/admin/{adminRoleGuid}

Available Since:
12.13.0

Get an admin role by GUID.

Sample

 
 {
      "guid": "8186600a-f084-46c2-b0c0-f34317c77094",
      "name": "Security administrator",
      "description": "Full permissions to manage the BlackBerry Enterprise Solution. Only administrators assigned this role can create and edit roles."
 }

Request Parameters
Name Location Description
adminRoleGuid path GUID of the admin role.
Response Codes
Code Condition Data type
200 OK.
404 Admin role not found.
Response Body
Media type Data type Description
application/vnd.blackberry.adminrole-v1+json Admin role (JSON)

GET /{tenantGuid}/api/v1/roles/admin/{adminRoleGuid}/users

Available Since:
12.13.0

Get a list of users assigned to the given Admin Role.

Sample

 
 {
     "users": [
         {
             "username": "pmorley",
             "emailAddress": "pmorley@example.com",
             "guid": "63b8c0fe-5930-4172-b107-8e34e1d4abee"
         },
         {
             "username": "jromphf",
             "emailAddress": "jromphf@example.com",
             "guid": "6acca88d-e0a5-4182-b094-ed64bb671ef8"
         }
     ]
 }

Request Parameters
Name Location Description
adminRoleGuid path GUID of the admin role.
Response Codes
Code Condition Data type
200 OK.
404 Admin role not found.
Response Body
Media type Data type Description
application/vnd.blackberry.users-v1+json Users (JSON)

DELETE /{tenantGuid}/api/v1/roles/admin/{adminRoleGuid}/users/{userGuid}

Available Since:
12.13.0

Remove the specific admin role from the specific user.

Request Parameters
Name Location Description
adminRoleGuid path GUID of the admin role
userGuid path GUID of the user to update
Response Codes
Code Condition Data type
200 OK.
    404 Admin role not found.
    409 Unable to remove last security admin.

    PUT /{tenantGuid}/api/v1/roles/admin/{adminRoleGuid}/users/{userGuid}

    Available Since:
    12.13.0

    Assign (add or replace) the given user's Admin role with the specific Admin Role.

    Request Parameters
    Name Location Description
    adminRoleGuid path GUID of the admin role
    userGuid path GUID of the user to update
    Response Codes
    Code Condition Data type
    200 OK.
      404 Admin role not found.
      409 Unable to remove last security admin.