Account / Cognito forgot password confirm
Route: /api/sys/v{version:apiVersion}/account/cognito_forgot_password_confirm
Method: POST
Authorisation: No authentication needed
Request Arguments
| Name | Type | Source |
|---|---|---|
| input | DTO_cognito_forgot_password_confirm | Body |
Request body example
Response object
Response status: 200 (OK)
Response type: DTO_cognito_forgot_password_confirm_response
Wrapper: DTO_response_wrap
Other response statuses: 400 (BadRequest)
Response body example
DTO_cognito_forgot_password_confirm
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| String | |||
| verification_code | String | Verification code | |
| new_password | String | New password |
DTO_cognito_forgot_password_confirm_response
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| message | String | Message | |
| login_response | DTO_logged_in_response | Login response |
DTO_logged_in_response
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| challenge_mfa | Boolean | Challenge mfa | |
| action | ENUM logged_in_response_action | Action | |
| info_messages | String[] | Can contain for example "Joined tenant". "Auth method Google added" | |
| warning_messages | String[] | Warning messages | |
| redirect_url | String | Redirect url |
ENUM logged_in_response_action
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | REDIRECT | REDIRECT |
| 2 | SELECT_TENANT | SELECT_TENANT |
| 3 | CREATE_TENANT | CREATE_TENANT |
| 4 | CONTINUE_TO_APP | CONTINUE_TO_APP |
| 5 | LOGIN | LOGIN |
