User roles REST API

Use this REST API to manage user roles.

Get all user roles

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

Returns a list of users 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

[
   {
      "id": "/admin/resources/users_roles/bd640355-8482-4595-9220-45380b1df36e",
      "created_time_raw": 1470431321868,
      "users": "/admin/resources/users/795a34da-10c1-4481-a5d5-94fd3c75a8c6",
      "updated_time_raw": 1470431321868,
      "roles": "/admin/resources/roles/1180e322-67dc-40ee-a5ca-d3e5e5a83764",
      "state": "available",
      "isas_rn": 1,
      "label_text": "Security Role Member",
      "created_time": "Fri 05 Aug 2016 21:08:41.868 UTC",
      "label_key": "pure8504",
      "updated_time": "Fri 05 Aug 2016 21:08:41.868 UTC",
      "version": "2.2.2.0"
   }
]
created_time
The time at which the object is created
id
The unique ID of the object in the system.
label_key
Key for retrieving label for the user role
label_text
Default translated message text
roles
The URI of an existing role in the system
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 URI of an existing user in the system

Get a specific user role

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

Returns a single user 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.