Skip to main content

Deprecated: Create User (Human)

POST 
https://$CUSTOM-DOMAIN/management/v1/users/human
deprecated

Create a new user with the type human. The newly created user will get an initialization email if either the email address is not marked as verified or no password is set. If a password is set the user will not be requested to set a new one on the first login.

Deprecated: use ImportHumanUser

Request​

Header Parameters

    x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.

Body

required

    userName string

    profile

    object

    firstName string
    lastName string
    nickName string
    displayName string
    preferredLanguage string
    gender string

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

    Default value: GENDER_UNSPECIFIED

    email

    object

    email string
    isEmailVerified boolean

    phone

    object

    phone has to be a global number (string)
    isPhoneVerified boolean
    initialPassword string

Responses​

A successful response.

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

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: 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

    resourceOwner resource_owner is the organization an object belongs to (string)
curl -L 'https://$CUSTOM-DOMAIN/management/v1/users/human' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "userName": "string",
  "profile": {
    "firstName": "string",
    "lastName": "string",
    "nickName": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "gender": "GENDER_UNSPECIFIED"
  },
  "email": {
    "email": "string",
    "isEmailVerified": true
  },
  "phone": {
    "phone": "string",
    "isPhoneVerified": true
  },
  "initialPassword": "string"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/management/v1
Auth
Parameters
— header
Body required
{
  "userName": "string",
  "profile": {
    "firstName": "string",
    "lastName": "string",
    "nickName": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "gender": "GENDER_UNSPECIFIED"
  },
  "email": {
    "email": "string",
    "isEmailVerified": true
  },
  "phone": {
    "phone": "string",
    "isPhoneVerified": true
  },
  "initialPassword": "string"
}
ResponseClear

Click the Send API Request button above and see the response here!