Skip to main content

Create a user (Human)​

Create/import a new user with the type human. The newly created user will get a verification email if either the email address is not marked as verified and you did not request the verification to be returned.

Request Body required
  • userId optionally set your own id unique for the user

    Possible values: non-empty and <= 200 characters

  • username optionally set a unique username, if none is provided the email will be used

    Possible values: non-empty and <= 200 characters

  • organisation object
  • orgId string
  • profile object required
  • firstName string required

    Possible values: non-empty and <= 200 characters

  • lastName string required

    Possible values: non-empty and <= 200 characters

  • nickName string

    Possible values: <= 200 characters

  • displayName string

    Possible values: <= 200 characters

  • preferredLanguage string

    Possible values: <= 10 characters

  • gender string

    Possible values: [GENDER_UNSPECIFIED, GENDER_FEMALE, GENDER_MALE, GENDER_DIVERSE]

    Default value: GENDER_UNSPECIFIED

  • email object required
  • email string required

    Possible values: non-empty and <= 200 characters

  • sendCode object
  • urlTemplate string required

    Possible values: non-empty and <= 200 characters

    "Optionally set a url_template, which will be used in the verification mail sent by ZITADEL to guide the user to your verification page. If no template is set, the default ZITADEL url will be used."

  • returnCode object
  • isVerified boolean
  • metadata object[]
  • Array [
  • key string required

    Possible values: non-empty and <= 200 characters

  • value byte required

    Possible values: non-empty and <= 500000 characters

    The value has to be base64 encoded.

  • ]
  • password object
  • password string required

    Possible values: non-empty and <= 200 characters

  • changeRequired boolean
  • hashedPassword object
  • hash string required

    Possible values: non-empty and <= 200 characters

    "hashed password"

  • algorithm string required

    Possible values: non-empty and <= 200 characters

    "algorithm used for the hash. currently only bcrypt is supported"

  • changeRequired boolean
Responses

OK

Schema
  • userId string
  • details object
  • sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

  • changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

  • resourceOwner resource_owner is the organization or instance_id an object belongs to
  • emailCode string
POST /v2alpha/users/human

Request

Base URL
https://$ZITADEL_DOMAIN
Content-Type
Body required
{

  "userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",

  "username": "minnie-mouse",

  "organisation": {

    "orgId": "string"

  },

  "profile": {

    "firstName": "Minnie",

    "lastName": "Mouse",

    "nickName": "Mini",

    "displayName": "Minnie Mouse",

    "preferredLanguage": "en",

    "gender": "GENDER_FEMALE"

  },

  "email": {

    "email": "mini@mouse.com",

    "sendCode": {

      "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"

    },

    "returnCode": {},

    "isVerified": true

  },

  "metadata": [

    {

      "key": "my-key",

      "value": "VGhpcyBpcyBteSB0ZXN0IHZhbHVl"

    }

  ],

  "password": {

    "password": "Secr3tP4ssw0rd!",

    "changeRequired": true

  },

  "hashedPassword": {

    "hash": "$2a$12$lJ08fqVr8bFJilRVnDT9QeULI7YW.nT3iwUv6dyg0aCrfm3UY8XR2",

    "algorithm": "bcrypt",

    "changeRequired": true

  }

}
Accept
curl -L -X POST 'https://$ZITADEL_DOMAIN/v2alpha/users/human' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
  "username": "minnie-mouse",
  "organisation": {
    "orgId": "string"
  },
  "profile": {
    "firstName": "Minnie",
    "lastName": "Mouse",
    "nickName": "Mini",
    "displayName": "Minnie Mouse",
    "preferredLanguage": "en",
    "gender": "GENDER_FEMALE"
  },
  "email": {
    "email": "mini@mouse.com",
    "sendCode": {
      "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
    },
    "returnCode": {},
    "isVerified": true
  },
  "metadata": [
    {
      "key": "my-key",
      "value": "VGhpcyBpcyBteSB0ZXN0IHZhbHVl"
    }
  ],
  "password": {
    "password": "Secr3tP4ssw0rd!",
    "changeRequired": true
  },
  "hashedPassword": {
    "hash": "$2a$12$lJ08fqVr8bFJilRVnDT9QeULI7YW.nT3iwUv6dyg0aCrfm3UY8XR2",
    "algorithm": "bcrypt",
    "changeRequired": true
  }
}'