|
|
The account api allows general the management of the user account.
|
|
|
|
|
|
# Available api actions
|
|
|
| Action | Url | Method | Description |
|
|
|
| Action | Url | Method | Session required | Description |
|
|
|
| --- | --- | --- | --- |
|
|
|
| reset | `/api/1.0/account/reset` | GET | Reset the user account |
|
|
|
| reset | `/api/1.0/account/reset` | POST | Reset the user account |
|
|
|
| challenge/get | `/api/1.0/account/challenge/get` | GET | Get the current login challenge |
|
|
|
| challenge/set | `/api/1.0/account/challenge/set` | POST | Set or update the login challenge |
|
|
|
| [reset](#the-reset-action) | `/api/1.0/account/reset` | GET | yes | Reset the user account |
|
|
|
| [reset](#the-reset-action) | `/api/1.0/account/reset` | POST | yes | Reset the user account |
|
|
|
| [challenge/get](#the-get-challenge-action) | `/api/1.0/account/challenge/get` | GET | no | Get the current login challenge |
|
|
|
| [challenge/set](#the-set-challenge-action) | `/api/1.0/account/challenge/set` | POST | no | Set or update the login challenge |
|
|
|
|
|
|
|
|
|
# The reset action
|
... | ... | @@ -29,9 +31,12 @@ The success status code is `200 Ok` or `202 Accepted`. |
|
|
|
|
|
#### Notes
|
|
|
- This request will close the session
|
|
|
- This request requires an active session to work
|
|
|
- This request will not delete any app or device tokens
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# The get challenge action
|
|
|
The get challenge action will return the current password challenge.
|
|
|
|
... | ... | @@ -44,8 +49,10 @@ The request returns an object with the challenge data and the property `token` w |
|
|
The format matches the one in of the `challenge` property from [request session](./Session-Api#the-request-action).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# The set challenge action
|
|
|
This action will create or update the user challenge and enable CSE and SSEv2.
|
|
|
The set challenge action will create or update the user challenge and enable CSE and SSEv2.
|
|
|
It is not possible to specify the challenge type and the server always expects you to use the latest challenge method.
|
|
|
This is currently `PWDv1r1`.
|
|
|
|
... | ... | @@ -54,7 +61,7 @@ This is currently `PWDv1r1`. |
|
|
| --- | --- | --- | --- | --- |
|
|
|
| secret | string | - | yes | The computed secret of the new challenge |
|
|
|
| data | array | - | yes | An array with the challenge data |
|
|
|
| oldSecret | string/null | null | no | If the user already has CSE set up, the secret of the current challenge is required |
|
|
|
| oldSecret | string/null | null | sometimes | If the user already has CSE set up, the secret of the current challenge is required |
|
|
|
|
|
|
#### Return value
|
|
|
The success status code is `200 Ok` .
|
... | ... | |