Create an invite

Create a new user invite. A Zitadel user is created without a password, and an invite email is sent. The invite includes workspace assignment configuration that is applied when the user completes setup.

Authorization

HTTPBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*Email

Email address of the user to invite

Formatemail

first_name*First Name

User's first name

Length1 <= length <= 100

last_name*Last Name

User's last name

Length1 <= length <= 100

role_keys?array<string>

Role keys to assign to the user

workspace_ids?array<>|

Specific workspace IDs to assign. If None, uses include_default.

include_default?Include Default

Whether to include the organization's default workspace

Defaulttrue

preferred_language?Preferred Language

Preferred language code (ISO 639-1)

Default"en"

Lengthlength <= 5

Response Body

`application/json`

curl -X post "http://localhost:8000/api/v1/admin/invite/" \  -H "Content-Type: application/json" \  -d '{    "email": "[email protected]",    "first_name": "Jane",    "include_default": true,    "last_name": "Doe",    "role_keys": [      "developer"    ],    "workspace_ids": [      "550e8400-e29b-41d4-a716-446655440000"    ]  }'

{
  "invite_id": "7218104b-c64c-4f30-a184-1a1802b5c56b",
  "idp_user_id": "string",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "email": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "state": "pending",
  "expires_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "invited_by": "0fdabe0c-eb7c-440a-96d2-2c65906c3777"
}

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

Create an invite

Authorization

Request Body

Response Body

201application/json

422application/json

`application/json`

`application/json`