Roles

Get role users

Changed on

Get users who have the role assigned with pagination.

get/api/roles/{id}/users

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/roles/{id}/users
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Path parameters

idstring required

The unique identifier of the role.

Query parameters

pageinteger

Page number (starts from 1).

page_sizeinteger

Entries per page.

search_paramsobject

Search query parameters.

Response

An array of users who have the role assigned.

idstring required
usernamestring nullable required
primaryEmailstring nullable required
primaryPhonestring nullable required
namestring nullable required
avatarstring nullable required
customDataobject required

arbitrary

identitiesobject required
lastSignInAtnumber nullable required
createdAtnumber required
updatedAtnumber required
applicationIdstring nullable required
cimdClientIdstring nullable required

The identifier of the CIMD (client ID metadata document) client from the user's first consent. null unless the user's first consent was granted to a CIMD client. Mutually exclusive with applicationId.

isSuspendedboolean required
hasPasswordboolean
hasSecurityVerificationMethodboolean

Changes

  • f6be196bc327Revision changes
    • breaking

      the / response property's maxLength was increased from 12 to 128 for the response status

    • breaking

      the /// response property's maxLength was increased from 12 to 128 for the response status

  • 0287c6a59ebaRevision changes
    • info

      added the required property / to the response with the status