Users endpoints keys
These keys are used with the RBAC API v1 users
endpoints.
| Key | Definition | Example |
|---|---|---|
id
|
A UUID string identifying the user. | "4fee7450-54c7-11e4-916c-0800200c9a66"
|
login
|
A string used by the user to log in. Must be unique among users and groups. | "admin"
|
email
|
An email address string. Not currently utilized by any code in PE. | "hill@example.com"
|
display_name
|
The user's name as a string. | "Kalo Hill"
|
role_ids
|
An array of role IDs indicating roles to directly assign to the user. An empty array is valid. | [3 6 5]
|
|
|
These flags indicate whether a user is remote and/or a
super user. For all users, is_group is always false. |
true or
false |
is_revoked
|
Setting this flag to true prevents
the user from accessing any routes until the flag is unset or the user's
password is reset via token. |
true or
false |
last_login
|
A timestamp in UTC-based ISO-8601 format (YYYY-MM-DDThh:mm:ssZ) indicating when the
user last logged in. If the user has never logged in, this value is
null. |
"2014-05-04T02:32:00Z"
|
inherited_role_ids (remote users
only) |
An array of role IDs indicating which roles a remote user inherits from their groups. | [9 1 3]
|
group_ids (remote users only) |
An array of UUIDs indicating which groups a remote user inherits roles from. | ["3a96d280-54c9-11e4-916c-0800200c9a66"]
|
identity_provider_id
|
The UUID of the LDAP identity provider associated with the user. | "4522ca7e-5623-11ed-bdc3-0242ac120002"
|
