Create/Import User (Human)​
Create/import 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
The default is always the organization of the requesting user. If you like to add users to another organization include the header. Make sure the user has permission in the requested organization.
Request Body required
- Array [
- ]
profile object required
Profile includes the basic information of a user, like first name, last name, etc.
Possible values: non-empty
and <= 200 characters
Possible values: non-empty
and <= 200 characters
Possible values: <= 200 characters
Possible values: <= 200 characters
Possible values: <= 10 characters
Possible values: [GENDER_UNSPECIFIED
, GENDER_FEMALE
, GENDER_MALE
, GENDER_DIVERSE
]
Default value: GENDER_UNSPECIFIED
email object required
Object that contains the email address and a verified flag.
If email verified is set to true, the email will be added as verified and the user doesn't have to verify.
phone object
Object that contains the number and a verified flag
Possible values: non-empty
and <= 50 characters
mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)
hashedPassword object
Use this to import hashed passwords from another system.
Encoded hash of a password in Modular Crypt Format: https://zitadel.com/docs/concepts/architecture/secrets#hashed-secrets
If this is set to true, the user has to change the password on the next login.
If this is set to true, you will get a link for the passwordless/passkey registration in the response.
idps object[]
To link your user directly with an external identity provider (Identity brokering)
Possible values: non-empty
and <= 200 characters
The internal ID of the identity provider configured in ZITADEL.
Possible values: non-empty
and <= 200 characters
The id of the user in the external identity provider
Possible values: <= 200 characters
A display name ZITADEL can show on the linked provider.
Request Body required
- Array [
- ]
profile object required
Profile includes the basic information of a user, like first name, last name, etc.
Possible values: non-empty
and <= 200 characters
Possible values: non-empty
and <= 200 characters
Possible values: <= 200 characters
Possible values: <= 200 characters
Possible values: <= 10 characters
Possible values: [GENDER_UNSPECIFIED
, GENDER_FEMALE
, GENDER_MALE
, GENDER_DIVERSE
]
Default value: GENDER_UNSPECIFIED
email object required
Object that contains the email address and a verified flag.
If email verified is set to true, the email will be added as verified and the user doesn't have to verify.
phone object
Object that contains the number and a verified flag
Possible values: non-empty
and <= 50 characters
mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)
hashedPassword object
Use this to import hashed passwords from another system.
Encoded hash of a password in Modular Crypt Format: https://zitadel.com/docs/concepts/architecture/secrets#hashed-secrets
If this is set to true, the user has to change the password on the next login.
If this is set to true, you will get a link for the passwordless/passkey registration in the response.
idps object[]
To link your user directly with an external identity provider (Identity brokering)
Possible values: non-empty
and <= 200 characters
The internal ID of the identity provider configured in ZITADEL.
Possible values: non-empty
and <= 200 characters
The id of the user in the external identity provider
Possible values: <= 200 characters
A display name ZITADEL can show on the linked provider.
Request Body required
- Array [
- ]
profile object required
Profile includes the basic information of a user, like first name, last name, etc.
Possible values: non-empty
and <= 200 characters
Possible values: non-empty
and <= 200 characters
Possible values: <= 200 characters
Possible values: <= 200 characters
Possible values: <= 10 characters
Possible values: [GENDER_UNSPECIFIED
, GENDER_FEMALE
, GENDER_MALE
, GENDER_DIVERSE
]
Default value: GENDER_UNSPECIFIED
email object required
Object that contains the email address and a verified flag.
If email verified is set to true, the email will be added as verified and the user doesn't have to verify.
phone object
Object that contains the number and a verified flag
Possible values: non-empty
and <= 50 characters
mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)
hashedPassword object
Use this to import hashed passwords from another system.
Encoded hash of a password in Modular Crypt Format: https://zitadel.com/docs/concepts/architecture/secrets#hashed-secrets
If this is set to true, the user has to change the password on the next login.
If this is set to true, you will get a link for the passwordless/passkey registration in the response.
idps object[]
To link your user directly with an external identity provider (Identity brokering)
Possible values: non-empty
and <= 200 characters
The internal ID of the identity provider configured in ZITADEL.
Possible values: non-empty
and <= 200 characters
The id of the user in the external identity provider
Possible values: <= 200 characters
A display name ZITADEL can show on the linked provider.
- 200
- default
A successful response.
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
passwordlessRegistration object
{
"userId": "string",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.417Z",
"changeDate": "2024-06-13T06:44:37.417Z",
"resourceOwner": "69629023906488334"
},
"passwordlessRegistration": {
"link": "string",
"lifetime": "string",
"expiration": "string"
}
}
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
passwordlessRegistration object
{
"userId": "string",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.417Z",
"changeDate": "2024-06-13T06:44:37.417Z",
"resourceOwner": "69629023906488334"
},
"passwordlessRegistration": {
"link": "string",
"lifetime": "string",
"expiration": "string"
}
}
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
passwordlessRegistration object
{
"userId": "string",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.417Z",
"changeDate": "2024-06-13T06:44:37.417Z",
"resourceOwner": "69629023906488334"
},
"passwordlessRegistration": {
"link": "string",
"lifetime": "string",
"expiration": "string"
}
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}