Register new user

Register a new user account. A verification email will be sent to the provided email address. User must verify their email before they can log in.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*Email

Email address (will be used as username)

Formatemail

password*Password

Password (complexity enforced by Zitadel policy)

Length8 <= length <= 128

first_name*First Name

User's first name

Length1 <= length <= 100

last_name*Last Name

User's last name

Length1 <= length <= 100

organization_name*Organization Name

Organization name for the user's new organization

Length2 <= length <= 200

preferred_language?Preferred Language

Preferred language code (ISO 639-1)

Default"en"

Lengthlength <= 5

accept_terms?Accept Terms

User accepts terms of service

Defaultfalse

Response Body

`application/json`

curl -X post "http://localhost:8000/api/v1/auth/register" \  -H "Content-Type: application/json" \  -d '{    "accept_terms": true,    "email": "[email protected]",    "first_name": "Jane",    "last_name": "Doe",    "organization_name": "Acme Corp",    "password": "SecureP@ssw0rd!"  }'

{
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "idp_user_id": "string",
  "email": "string",
  "display_name": "string",
  "state": "pending_verification",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "verification_sent": true,
  "created_at": "2019-08-24T14:15:22Z"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Register new user

Request Body

Response Body

201application/json

422application/json

`application/json`

`application/json`