Query parameters

• page integer

  Page number (starts from 1).

  Minimum value is 1. Default value is 1.

• page_size integer

  Entries per page.

  Minimum value is 1. Default value is 20.

• search_params object

  Search query parameters.

  Hide search_params attributes Show search_params attributes

  • Additional properties
  • key string

Responses

• 200 application/json

  An array of users that match the given criteria.

  Hide response attributes Show response attributes object

  • id string Required

    Minimum length is 1, maximum length is 12.

  • username string | null Required

    Maximum length is 128.

  • primaryEmail string | null Required

    Maximum length is 128.

  • primaryPhone string | null Required

    Maximum length is 128.

  • name string | null Required

    Maximum length is 128.

  • avatar string | null Required

    Maximum length is 2048.

  • customData object Required

    arbitrary

  • identities object Required
    Hide identities attributes Show identities attributes

    • Additional properties
    • userId string Required
    • details object

      arbitrary

  • lastSignInAt number | null Required
  • createdAt number Required
  • updatedAt number Required
  • profile object Required
    Hide profile attributes Show profile attributes

    • familyName string
    • givenName string
    • middleName string
    • nickname string
    • preferredUsername string
    • profile string
    • website string
    • gender string
    • birthdate string
    • zoneinfo string
    • locale string
    • address object
      Hide address attributes Show address attributes

      • formatted string
      • streetAddress string
      • locality string
      • region string
      • postalCode string
      • country string
  • applicationId string | null Required

    Maximum length is 21.

  • isSuspended boolean Required
  • hasPassword boolean
  • ssoIdentities array[object]
    Hide ssoIdentities attributes Show ssoIdentities attributes object

    • tenantId string Required

      Maximum length is 21.

    • id string Required

      Minimum length is 1, maximum length is 21.

    • userId string Required

      Minimum length is 1, maximum length is 12.

    • issuer string Required

      Minimum length is 1, maximum length is 256.

    • identityId string Required

      Minimum length is 1, maximum length is 128.

    • detail object Required

      arbitrary

    • createdAt number Required
    • ssoConnectorId string Required

      Minimum length is 1, maximum length is 128.

• 400

  Bad Request

• 401

  Unauthorized

• 403

  Forbidden