Update a user​
Update an existing user with data based on a user schema.
Path Parameters
unique identifier of the user.
Request Body required
contact object
Add or update the contact information (email, phone) for the user if needed.
email object
Possible values: non-empty
and <= 200 characters
Set the email address.
sendCode object
Let ZITADEL send the link to the user via email.
Possible values: non-empty
and <= 200 characters
Optionally set a url_template, which will be used in the verification mail sent by ZITADEL to guide the user to your verification page. If no template is set, the default ZITADEL url will be used.
Get the code back to provide it to the user in your preferred mechanism.
Set the email as already verified.
phone object
Possible values: non-empty
and <= 20 characters
Set the user's phone number.
Let ZITADEL send the link to the user via SMS.
Get the code back to provide it to the user in your preferred mechanism.
Set the phone as already verified.
Possible values: non-empty
and <= 200 characters
Change the schema the user's data schema by providing it's ID if needed.
Update the user data if needed. It will be validated based on the specified schema.
Request Body required
contact object
Add or update the contact information (email, phone) for the user if needed.
email object
Possible values: non-empty
and <= 200 characters
Set the email address.
sendCode object
Let ZITADEL send the link to the user via email.
Possible values: non-empty
and <= 200 characters
Optionally set a url_template, which will be used in the verification mail sent by ZITADEL to guide the user to your verification page. If no template is set, the default ZITADEL url will be used.
Get the code back to provide it to the user in your preferred mechanism.
Set the email as already verified.
phone object
Possible values: non-empty
and <= 20 characters
Set the user's phone number.
Let ZITADEL send the link to the user via SMS.
Get the code back to provide it to the user in your preferred mechanism.
Set the phone as already verified.
Possible values: non-empty
and <= 200 characters
Change the schema the user's data schema by providing it's ID if needed.
Update the user data if needed. It will be validated based on the specified schema.
Request Body required
contact object
Add or update the contact information (email, phone) for the user if needed.
email object
Possible values: non-empty
and <= 200 characters
Set the email address.
sendCode object
Let ZITADEL send the link to the user via email.
Possible values: non-empty
and <= 200 characters
Optionally set a url_template, which will be used in the verification mail sent by ZITADEL to guide the user to your verification page. If no template is set, the default ZITADEL url will be used.
Get the code back to provide it to the user in your preferred mechanism.
Set the email as already verified.
phone object
Possible values: non-empty
and <= 20 characters
Set the user's phone number.
Let ZITADEL send the link to the user via SMS.
Get the code back to provide it to the user in your preferred mechanism.
Set the phone as already verified.
Possible values: non-empty
and <= 200 characters
Change the schema the user's data schema by providing it's ID if needed.
Update the user data if needed. It will be validated based on the specified schema.
- 200
- 403
- 404
- default
User successfully updated
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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
The email code will be set if a contact email was set with a return_code verification option.
The phone code will be set if a contact phone was set with a return_code verification option.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.358Z",
"resourceOwner": "69629023906488334"
},
"emailCode": "SKJd342k",
"phoneCode": "IFi39dk2"
}
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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
The email code will be set if a contact email was set with a return_code verification option.
The phone code will be set if a contact phone was set with a return_code verification option.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.358Z",
"resourceOwner": "69629023906488334"
},
"emailCode": "SKJd342k",
"phoneCode": "IFi39dk2"
}
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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
The email code will be set if a contact email was set with a return_code verification option.
The phone code will be set if a contact phone was set with a return_code verification option.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.359Z",
"resourceOwner": "69629023906488334"
},
"emailCode": "SKJd342k",
"phoneCode": "IFi39dk2"
}
Returned when the user does not have permission to access the resource.
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"
}
]
}
Returned when the resource does not exist.
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"
}
]
}
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"
}
]
}