ZITADEL Docs
APIsCore ResourcesV2User

Search Users

Search for users. By default, we will return all users of your instance that you have permission to read. Make sure to include a limit and sorting for pagination.

POST
/v2/users

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://loading/v2/users" \  -H "Content-Type: application/json" \  -d '{}'
{
  "details": {
    "totalResult": 0,
    "processedSequence": 0,
    "timestamp": "2023-01-15T01:30:15.01Z"
  },
  "sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "userId": "string",
      "details": {
        "sequence": 0,
        "changeDate": "2023-01-15T01:30:15.01Z",
        "resourceOwner": "string",
        "creationDate": "2023-01-15T01:30:15.01Z"
      },
      "state": "USER_STATE_UNSPECIFIED",
      "username": "string",
      "loginNames": [
        "string"
      ],
      "preferredLoginName": "string",
      "human": {
        "userId": "string",
        "state": "USER_STATE_UNSPECIFIED",
        "username": "string",
        "loginNames": [
          "string"
        ],
        "preferredLoginName": "string",
        "profile": {
          "givenName": "string",
          "familyName": "string",
          "nickName": "string",
          "displayName": "string",
          "preferredLanguage": "string",
          "gender": "GENDER_UNSPECIFIED",
          "avatarUrl": "string"
        },
        "email": {
          "email": "string",
          "isVerified": true
        },
        "phone": {
          "phone": "string",
          "isVerified": true
        },
        "passwordChangeRequired": true,
        "passwordChanged": "2023-01-15T01:30:15.01Z",
        "mfaInitSkipped": "2023-01-15T01:30:15.01Z"
      }
    }
  ]
}

Was this page helpful?