API ReferenceRoles

Get users by role

Get users that have the specified role name assigned.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

role-namestringRequired
the role name.
realmstringRequired

Query parameters

briefRepresentationbooleanOptional

Boolean which defines whether brief representations are returned (default: false)

firstintegerOptional

first result to return. Ignored if negative or {@code null}.

maxintegerOptional

maximum number of results to return. Ignored if negative or {@code null}.

Response

organizationslist of strings or null
idstring or null
usernamestring or null
firstNamestring or null
lastNamestring or null
emailstring or null
emailVerifiedboolean or null
attributesmap from strings to lists of strings or null
userProfileMetadataobject or null
enabledboolean or null
selfstring or null
originstring or null
createdTimestamplong or null
totpboolean or null
serviceAccountClientIdstring or null
credentialslist of objects or null
disableableCredentialTypeslist of strings or null
requiredActionslist of strings or null
federatedIdentitieslist of objects or null
realmRoleslist of strings or null
clientRolesmap from strings to lists of strings or null
clientConsentslist of objects or null
notBeforeinteger or null
groupslist of strings or null
accessmap from strings to booleans or null
applicationRolesmap from strings to lists of strings or nullDeprecated

Errors