ZITADEL Docs
APIsCore ResourcesV2User

AddHumanUser

Create a new human user

Deprecated: Use CreateUser to create a new user of type human instead.

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.

POST
/v2/users/human

Request Body

application/json

userId?string

optionally set your own id unique for the user.

username?string

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

organization?|
profile?
email?||
phone?||
metadata?
idpLinks?
totpSecret?string

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.

hashedPassword*
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/v2/users/human" \  -H "Content-Type: application/json" \  -d '{    "profile": {      "givenName": "string",      "familyName": "string"    },    "email": {      "email": "string",      "isVerified": true    },    "hashedPassword": {      "hash": "string"    }  }'
{
  "userId": "string",
  "details": {
    "sequence": 0,
    "changeDate": "1s",
    "resourceOwner": "string",
    "creationDate": "1s"
  },
  "emailCode": "string",
  "phoneCode": "string"
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?