RBAC API v1
The role-based access control (RBAC) service enables you to manage users, directory groups, and roles.
-
Endpoints
The role-based access control (RBAC) service enables you to manage users, directory groups, and roles. -
Forming RBAC API requests
Token-based authentication is required to access the RBAC API. You can authenticate requests by using either user authentication tokens or whitelisted certificates. -
Users endpoints
RBAC enables you to manage local users as well as those who are created remotely, on a directory service. With theusers
endpoints, you can get lists of users and create new local users. -
User group endpoints
Groups are used to assign roles to a group of users, which is vastly more efficient than managing roles for each user individually. Thegroups
endpoints enable you to get lists of groups, and to add a new directory group. -
User roles endpoints
By assigning roles to users, you can manage them in sets that are granted access permissions to various PE objects. This makes tracking user access more organized and easier to manage. Theroles
endpoints enable you to get lists of roles and create new roles. -
Permissions endpoints
You assign permissions to user roles to manage user access to objects. Thepermissions
endpoints enable you to get information about available objects and the permissions that can be constructed for those objects. -
Token endpoints
A user's access to PE services can be controlled using authentication tokens. Users can generate their own authentication tokens using thetoken
endpoint. -
Directory service endpoints
Use theds
(directory service) API endpoints to get information about the directory service, test your directory service connection, and replace directory service connection settings. -
Password endpoints
When local users forget passwords or lock themselves out of PE by attempting to log in with incorrect credentials too many times, you must generate a password reset token for them. Thepassword
endpoints enable you to generate password reset tokens for a specific local user or with a token that contains a temporary password in the body. -
RBAC service errors
You’re likely to encounter some errors when using the RBAC API. You’ll want to familiarize yourself with the error response descriptions and the general error responses. -
Configuration options
There are various configuration options for the RBAC service. Each section can exist in its own file or in separate files.
Related information