Users endpoints
RBAC enables you to manage local users as well as those
who are created remotely, on a directory service. With the users
endpoints, you can get lists of users and create new local
users.
-
Users keys
The following keys are used with the RBAC v1 API'susers
endpoints. -
GET /users
Fetches all users, both local and remote (including the superuser). Supports filtering by ID through query parameters. Authentication is required. -
GET /users/<sid>
Fetches a single user by its subject ID (sid). Authentication is required. -
GET /users/current
Fetches the data about the current authenticated user, with the exact same behavior asGET /users/<sid>
, except that<sid>
is assumed from the authentication context. Authentication is required. -
POST /users
Creates a new local user. You can add the new user to user roles by specifying an array of roles inrole_ids
. You can set a password for the user inpassword
. For the password to work in the PE console, it needs to be a minimum of six characters. Authentication is required. -
PUT /users/<sid>
Replaces the user with the specified ID (sid) with a new user object. Authentication is required. -
DELETE /users/<sid>
Deletes the user with the specified ID (sid), regardless of whether they are a user defined in RBAC or a user defined by a directory service. In the case of directory service users, while this action removes a user from the console, that user is still able to log in (at which point they are re-added to the console) if they are not revoked. Authentication is required.