Skip to main content

Retrieve all

GET 
/admin/realms/:realmId/users

Returns a stream of Users.

Request​

Path Parameters

    realmId stringrequired

    The realm's id

Query Parameters

    userId string

    (optional) The id of the User to obtain results for specific user(s).

    exact boolean

    Defines whether the parameter "username" must match exactly.

Responses​

OK

Schema
  • Array [
    • id string

    The id of the user.

    origin string
    createdTimestamp number
    username string

    The username of the user.

    enabled boolean

    Boolean representing if user is enabled or not.

    totp boolean

    Boolean representing if time-based OTP is enabled or not.

    emailVerified boolean

    Informs if the email of the user has been verified.

    firstName string

    The first name of the user.

    lastName string

    The last name of the user.

    email string

    The email of the user.

    serviceAccountClientId string
    groups array
    requiredActions array

    Possible values: [VERIFY_EMAIL, UPDATE_PROFILE, CONFIGURE_TOTP, UPDATE_PASSWORD, TERMS_AND_CONDITIONS]

    Actions a user must perform during the authentication process.

  • ]
Loading...