Skip to main content

Deprecated: Create User (Human)​

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

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.

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.

Request 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
    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
POST /users/human

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN/management/v1
Bearer Token
x-zitadel-orgid — header
Content-Type
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"

}
Accept
curl / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/users/human' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "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"
}'