Add a OTP Email authenticator​
Add a new one-time-password (OTP) Email authenticator to a user. If the email is not passed as verified, a verification code will be generated, which can be either returned or will be sent to the user by email.
Path Parameters
unique identifier of the user.
Request Body required
email object
Set the user's email for the OTP Email authenticator and it's verification state.
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.
Request Body required
email object
Set the user's email for the OTP Email authenticator and it's verification state.
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.
Request Body required
email object
Set the user's email for the OTP Email authenticator and it's verification state.
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.
- 200
- 403
- 404
- default
OTP Email authenticator successfully added
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
unique identifier of the OTP Email registration.
The OTP verification code will be set if a email was set with a return_code verification option.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.416Z",
"resourceOwner": "69629023906488334"
},
"otpEmailId": "163840776835432705",
"verificationCode": "SKJd342k"
}
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
unique identifier of the OTP Email registration.
The OTP verification code will be set if a email was set with a return_code verification option.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.416Z",
"resourceOwner": "69629023906488334"
},
"otpEmailId": "163840776835432705",
"verificationCode": "SKJd342k"
}
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
unique identifier of the OTP Email registration.
The OTP verification code will be set if a email was set with a return_code verification option.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.416Z",
"resourceOwner": "69629023906488334"
},
"otpEmailId": "163840776835432705",
"verificationCode": "SKJd342k"
}
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"
}
]
}