Request a code to reset a password​
Request a code to reset a password
Path Parameters
Request Body required
sendLink object
Possible values: [NOTIFICATION_TYPE_Unspecified
, NOTIFICATION_TYPE_Email
, NOTIFICATION_TYPE_SMS
]
Default value: NOTIFICATION_TYPE_Unspecified
Possible values: non-empty
and <= 200 characters
"Optionally set a url_template, which will be used in the password reset mail sent by ZITADEL to guide the user to your password change page. If no template is set, the default ZITADEL url will be used."
Request Body required
sendLink object
Possible values: [NOTIFICATION_TYPE_Unspecified
, NOTIFICATION_TYPE_Email
, NOTIFICATION_TYPE_SMS
]
Default value: NOTIFICATION_TYPE_Unspecified
Possible values: non-empty
and <= 200 characters
"Optionally set a url_template, which will be used in the password reset mail sent by ZITADEL to guide the user to your password change page. If no template is set, the default ZITADEL url will be used."
Request Body required
sendLink object
Possible values: [NOTIFICATION_TYPE_Unspecified
, NOTIFICATION_TYPE_Email
, NOTIFICATION_TYPE_SMS
]
Default value: NOTIFICATION_TYPE_Unspecified
Possible values: non-empty
and <= 200 characters
"Optionally set a url_template, which will be used in the password reset mail sent by ZITADEL to guide the user to your password change page. If no template is set, the default ZITADEL url will be used."
- 200
- 403
- 404
- default
OK
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
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.860Z",
"resourceOwner": "69629023906488334"
},
"verificationCode": "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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.860Z",
"resourceOwner": "69629023906488334"
},
"verificationCode": "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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.860Z",
"resourceOwner": "69629023906488334"
},
"verificationCode": "string"
}
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"
}
]
}