Skip to main content

Create a new human user

POST 
/v2/users/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 string

    Possible values: non-empty and <= 200 characters

    optionally set your own id unique for the user.

    username string

    Possible values: non-empty and <= 200 characters

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

    organization

    object

    orgId string
    orgDomain string

    profile

    object

    required

    givenName stringrequired

    Possible values: non-empty and <= 200 characters

    familyName stringrequired

    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 stringrequired

    Possible values: non-empty and <= 200 characters

    sendCode

    object

    urlTemplate string

    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

    phone

    object

    phone string

    Possible values: <= 200 characters

    sendCode object
    returnCode object
    isVerified boolean

    metadata

    object[]

  • Array [

    • key stringrequired

    Possible values: non-empty and <= 200 characters

    value byterequired

    Possible values: non-empty and <= 500000 characters

    The value has to be base64 encoded.

  • ]

    • password

    object

    password stringrequired

    Possible values: non-empty and <= 200 characters

    changeRequired boolean

    hashedPassword

    object

    hash stringrequired

    Possible values: non-empty and <= 200 characters

    "Encoded hash of a password in Modular Crypt Format: https://zitadel.com/docs/concepts/architecture/secrets#hashed-secrets"

    changeRequired boolean

    idpLinks

    object[]

  • Array [

    • idpId string

    Possible values: non-empty and <= 200 characters

    ID of the identity provider

    userId string

    Possible values: non-empty and <= 200 characters

    ID of the user of the identity provider

    userName string

    Possible values: non-empty and <= 200 characters

    username of the user of the identity provider

  • ]

    • totpSecret string

    Possible values: non-empty and <= 200 characters

    An Implementation of RFC 6238 is used, with HMAC-SHA-1 and time-step of 30 seconds. Currently no other options are supported, and if anything different is used the validation will fail.

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 (string)
    emailCode string
    phoneCode string
Loading...