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 attribute Show search_params attribute object

  • * string Additional properties
• identityType string

  The external identity type to use for an exact user lookup. Use social for a social connector identity or sso for an enterprise SSO identity. Must be provided together with identityProvider and identityId. External identity filters are combined with other user filters using AND logic.

  Values are social or sso.

• identityProvider string

  The connector target for a social identity (for example, dingtalk), or the issuer for an enterprise SSO identity. Must be provided together with identityType and identityId.

• identityId string

  The user identifier issued by the external identity provider, such as a DingTalk OpenID. Must be provided together with identityType and identityProvider.

• customData array[string]

  A repeatable filter for exact user lookup by custom data. Each value must be a URL-encoded JSON object, for example customData=%7B%22customId%22%3A114514%7D for {"customId":114514}. Matching uses PostgreSQL JSONB containment (users.custom_data @> value::jsonb) with strict JSON types: the number 114514 does not match the string "114514", strings are case-sensitive without phone/date normalization, and null only matches an explicit JSON null, not a missing key. Nested objects are matched recursively, and arrays are matched by element regardless of order or duplicates. All keys within one object are combined with AND, repeated customData parameters are combined with OR, and the whole custom data condition is combined with search, identity, excludeRoleId, and excludeOrganizationId filters using AND. Empty objects and empty arrays are rejected with 400, and at most 20 customData values are allowed per request. The mode, joint, and isCaseSensitive parameters do not apply to customData, and nested syntax such as customData.customId or mode.customData is not supported.

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 128.

  • 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

    Additional properties are allowed.

  • identities object Required
    Hide identities attribute Show identities attribute object

    • * object Additional properties
      Hide * attributes Show * attributes object

      • userId string Required
      • details object

        arbitrary

        Additional properties are allowed.

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

    • 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 object

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

    Maximum length is 21.

  • cimdClientId string | null 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.

    Maximum length is 2048.

  • isSuspended boolean Required
  • hasPassword boolean
  • hasSecurityVerificationMethod 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 128.

    • 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

      Additional properties are allowed.

    • createdAt number Required
    • updatedAt number Required
    • ssoConnectorId string Required

      Minimum length is 1, maximum length is 128.

  • passwordDigest string | null

    Maximum length is 256.

  • passwordAlgorithm string | null

    Values are Argon2i, Argon2id, Argon2d, SHA1, SHA256, MD5, Bcrypt, or Legacy.

• 400

  Bad Request

• 401

  Unauthorized

• 403

  Forbidden