ZITADEL Docs
APIsCore ResourcesV1Organization Objects

ImportHumanUser

Create/Import User (Human)

Deprecated: use user service v2 UpdateHumanUser instead.

Create/import a new user. 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.

POST
/users/human/_import

Request Body

application/json

userName*string
profile*
email*
phone?
password?string
hashedPassword?
passwordChangeRequired?boolean
requestPasswordlessRegistration?boolean
otpCode?string
idps?
recoveryCodes?
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/users/human/_import" \  -H "Content-Type: application/json" \  -d '{    "userName": "string",    "profile": {      "firstName": "string",      "lastName": "string"    },    "email": {      "email": "string"    }  }'
{
  "userId": "string",
  "details": {
    "sequence": 0,
    "creationDate": "1s",
    "changeDate": "1s",
    "resourceOwner": "string"
  },
  "passwordlessRegistration": {
    "link": "string",
    "lifetime": "string",
    "expiration": "string"
  }
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?