Get users by role | Auth.it Documentation

[
  {
    "organizations": [
      "string"
    ],
    "id": "string",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "emailVerified": true,
    "attributes": {},
    "userProfileMetadata": {
      "attributes": [
        {
          "name": "string",
          "displayName": "string",
          "required": true,
          "readOnly": true,
          "annotations": {},
          "validators": {},
          "group": "string",
          "multivalued": true
        }
      ],
      "groups": [
        {
          "name": "string",
          "displayHeader": "string",
          "displayDescription": "string",
          "annotations": {}
        }
      ]
    },
    "enabled": true,
    "self": "string",
    "origin": "string",
    "createdTimestamp": 1,
    "totp": true,
    "federationLink": "string",
    "serviceAccountClientId": "string",
    "credentials": [
      {
        "id": "string",
        "type": "string",
        "userLabel": "string",
        "createdDate": 1,
        "secretData": "string",
        "credentialData": "string",
        "priority": 1,
        "value": "string",
        "temporary": true,
        "config": {},
        "federationLink": "string",
        "device": "string",
        "hashedSaltedValue": "string",
        "salt": "string",
        "hashIterations": 1,
        "counter": 1,
        "algorithm": "string",
        "digits": 1,
        "period": 1
      }
    ],
    "disableableCredentialTypes": [
      "string"
    ],
    "requiredActions": [
      "string"
    ],
    "federatedIdentities": [
      {
        "identityProvider": "string",
        "userId": "string",
        "userName": "string"
      }
    ],
    "realmRoles": [
      "string"
    ],
    "clientRoles": {},
    "clientConsents": [
      {
        "clientId": "string",
        "grantedClientScopes": [
          "string"
        ],
        "createdDate": 1,
        "lastUpdatedDate": 1,
        "grantedRealmRoles": [
          "string"
        ]
      }
    ],
    "notBefore": 1,
    "groups": [
      "string"
    ],
    "access": {},
    "applicationRoles": {},
    "socialLinks": [
      {
        "socialProvider": "string",
        "socialUserId": "string",
        "socialUsername": "string"
      }
    ]
  }
]

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 stringsOptional

idstringOptional

usernamestringOptional

firstNamestringOptional

lastNamestringOptional

emailstringOptional

emailVerifiedbooleanOptional

attributesmap from strings to lists of stringsOptional

userProfileMetadataobjectOptional

enabledbooleanOptional

selfstringOptional

originstringOptional

createdTimestamplongOptional

totpbooleanOptional

federationLinkstringOptional

serviceAccountClientIdstringOptional

credentialslist of objectsOptional

disableableCredentialTypeslist of stringsOptional

requiredActionslist of stringsOptional

federatedIdentitieslist of objectsOptional

realmRoleslist of stringsOptional

clientRolesmap from strings to lists of stringsOptional

clientConsentslist of objectsOptional

notBeforeintegerOptional

groupslist of stringsOptional

accessmap from strings to booleansOptional

applicationRolesmap from strings to lists of stringsOptionalDeprecated

socialLinkslist of objectsOptionalDeprecated

Errors

403

Forbidden Error

404

Not Found Error