Roles REST API

Use this REST API to manage roles.

Get all roles

Table 1. Get all roles
REST API information	Value	Description
URI	/admin/resources/roles
Method	GET
Returns	200	Returns a list of all roles
	404	The role list was not found
	500	Platform System Manager encountered an internal error while processing the request.

Returns a list of roles.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

Response body

[
   {
      "created_time_raw": 1463767207627,
      "users": [
         "/admin/resources/users/7c230fd0-bcbe-4bc7-bfed-27b5b85a51dc",
         "/admin/resources/users/e026ec1c-5282-42af-95b1-365bd6b2d04f",
         "/admin/resources/users/dd598e73-7cf3-4d1e-af94-0c71121515da"
      ],
      "role_id": 1,
      "isas_rn": 1,
      "state": "available",
      "label_text": "Security Role",
      "updated_time": "Fri 20 May 2016 18:00:07.627 UTC",
      "label_key": "pure8503",
      "version": "2.2.2.0",
      "id": "/admin/resources/roles/48c42d54-52a0-46b1-812f-477124298ae2",
      "updated_time_raw": 1463767207627,
      "is_hidden": "F",
      "name": "SUPER_USER",
      "role_permissions": [
         "/admin/resources/role_permissions/6c578d2d-058d-4c44-96e1-e9d76bcec015",
         "/admin/resources/role_permissions/115f2642-f213-46aa-a1da-42c1de347491",
         "/admin/resources/role_permissions/4cd22fcc-c76f-45c1-8688-2aff1bbaf389",
         "/admin/resources/role_permissions/08f2cd8f-494c-46de-ac32-6353ef16ce85",
         "/admin/resources/role_permissions/227d734e-e1ae-4f99-9210-1829ad0013dc",
         "/admin/resources/role_permissions/7fd17b14-b113-4993-901a-7b1de4a089d3",
         "/admin/resources/role_permissions/75caa16c-087d-4869-8ffc-3e9994090b3f",
         "/admin/resources/role_permissions/e2505112-eda6-4338-a553-2d45c6616235",
         "/admin/resources/role_permissions/2485c499-7ac5-4964-a515-de69148b3ee9",
         "/admin/resources/role_permissions/399ae1b3-9096-41a6-94d6-830081536b09",
         "/admin/resources/role_permissions/ca80ce3f-4e2c-44fb-8e85-e56ee3a96a26",
         "/admin/resources/role_permissions/f0de6f5e-4999-41ac-931e-d1a512dff4af",
         "/admin/resources/role_permissions/b68cedba-7b59-4905-8198-814a5533eb95",
         "/admin/resources/role_permissions/7b1677d9-7fe1-49a0-bf1d-f0453a06c726",
         "/admin/resources/role_permissions/83dad963-e7db-4a21-a1d2-49e9990ad598"
      ],
      "created_time": "Fri 20 May 2016 18:00:07.627 UTC"
   }
]

created_time: The time at which the object is created
id: The unique ID of the object in the system.
is_hidden: Flag indicating if the role is hidden or not
label_key: Key for retrieving label for the role
label_text: Default translated message text
name: The name of the role
role_id: Role's identifier
state: The general availability of the object. If "pending" the object has been created but not activated. If "available" the object is active in the system.
updated_time: The time at which the object was last updated
users: The users in this role

Children:

role_permissions

Get a specific role

Table 2. Get a specific role
REST API information	Value	Description
URI	/admin/resources/roles/{id}
Method	GET
Returns	200	The role was returned.
	404	The role was not found
	500	Platform System Manager encountered an internal error while processing the request.

Returns a single role identified by {id}.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.