User groups endpoints keys
These keys are used with the RBAC API v1 groups
endpoints.
Key | Definition | Example |
---|---|---|
id
|
A UUID string identifying the group. | "c099d420-5557-11e4-916c-0800200c9a66"
|
login
|
The identifier for the user group on the directory server. | "admins"
|
display_name
|
The group's name as a string. | "Admins"
|
role_ids
|
An array of role IDs indicating roles to assign to the
group's members. An empty array is valid. This is the
only field that can be updated via RBAC; the rest are immutable or
synced from the directory service. |
[3 6 5]
|
|
These flags indicate that the group is a group, derived from the directory service, and not a super user (inherently, a group can't be a user). | These are set to true ,
true , and false ,
respectively |
is_revoked
|
No effect. Because groups are not user objects,
setting this flag to true does nothing. |
true orfalse |
user_ids
|
An array of UUIDs indicating which users belong to the group. | ["3a96d280-54c9-11e4-916c-0800200c9a66"]
|
identity_provider_id
|
The UUID of the LDAP identity provider associated with the group. | "4522ca7e-5623-11ed-bdc3-0242ac120002"
|