RBAC API
Use the RBAC API v1 and v2 endpoints to manage users, roles, tokens, password, and LDAP connections.
Endpoint | Use |
---|---|
users
|
Manage local users as well as those from a directory service, get lists of users, and create new local users. |
groups
|
Get lists of groups and add a new remote user group. |
roles
|
Get lists of user roles and create new roles. |
permissions
|
Get information about available objects and the permissions that can be constructed for those objects. |
ds (Directory service) |
Get information about the directory service, test your directory service connection, and replace directory service connection settings. |
password
|
Generate password reset tokens and update user passwords. |
tokens
|
Generate the authentication tokens used to access PE. The v1/tokens endpoints are for creating tokens,
while the v2/tokens endpoints are for
revoking them. |
rbac-service
|
Check the status of the RBAC service. |
-
Forming RBAC API requests
Token-based authentication is required to access the RBAC API v1 and v2 endpoints. You can authenticate requests by using either user authentication tokens or allowed certificates. -
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. -
RBAC API v1
The role-based access control (RBAC) API v1 service enables you to manage users, directory groups, and roles. -
RBAC API v2
The role-based access control (RBAC) API v2 service enables you to validate groups and revoke tokens.
Related information