Zitadel · Schema

User

AuthenticationAuthorizationIdentity ManagementOpen SourceOAuth 2.0OIDC

Properties

Name Type Description
id string Unique identifier of the user
state string
userName string
loginNames array
preferredLoginName string
human object
machine object
View JSON Schema on GitHub

JSON Schema

zitadel-user-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/User",
  "title": "User",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the user"
    },
    "state": {
      "type": "string",
      "enum": [
        "UNSPECIFIED",
        "ACTIVE",
        "INACTIVE",
        "LOCKED",
        "DELETED",
        "INITIAL"
      ]
    },
    "userName": {
      "type": "string"
    },
    "loginNames": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "preferredLoginName": {
      "type": "string"
    },
    "human": {
      "$ref": "#/components/schemas/HumanUser"
    },
    "machine": {
      "$ref": "#/components/schemas/MachineUser"
    }
  }
}