mirror of
https://github.com/cadmium-im/cadmium-docs-legacy.git
synced 2024-11-22 02:12:21 +00:00
Some update
This commit is contained in:
parent
7474e63fd3
commit
f55dbf9967
@ -15,7 +15,7 @@ This extension is intended for logging into user account on a server by username
|
||||
|
||||
## Use cases
|
||||
|
||||
*Request*:
|
||||
- Request:
|
||||
|
||||
```json
|
||||
{
|
||||
@ -29,7 +29,7 @@ This extension is intended for logging into user account on a server by username
|
||||
}
|
||||
```
|
||||
|
||||
*Response*:
|
||||
- Response:
|
||||
|
||||
```json
|
||||
{
|
||||
@ -44,7 +44,7 @@ This extension is intended for logging into user account on a server by username
|
||||
}
|
||||
```
|
||||
|
||||
*<b>Error</b> response*:
|
||||
- Error response:
|
||||
|
||||
```json
|
||||
{
|
||||
@ -72,10 +72,14 @@ None.
|
||||
```typescript
|
||||
interface LoginRequestPayload {
|
||||
/**
|
||||
* The username of account which user wants to login
|
||||
* The username of account which user wants to login (can be omit if we set thirdPID)
|
||||
*/
|
||||
username: string,
|
||||
|
||||
/**
|
||||
* Third party ID which have user (can be omit if we set username)
|
||||
*/
|
||||
thirdPID: string,
|
||||
|
||||
/**
|
||||
* Password of new account
|
||||
|
@ -18,6 +18,8 @@ This extension is intended for creating user accounts on a server
|
||||
|
||||
### Basic registration flow
|
||||
|
||||
`// TODO: introduce email/msisdn confirmation which prevents spam attacks`
|
||||
|
||||
- Client:
|
||||
|
||||
```json
|
||||
@ -31,7 +33,8 @@ This extension is intended for creating user accounts on a server
|
||||
{"type":"email", "value":"juliet@capulett.com"},
|
||||
{"type":"msisdn", "value":"+1234567890"},
|
||||
],
|
||||
"password": "romeo1"
|
||||
"password": "romeo1",
|
||||
"loginOnSuccess": false
|
||||
}
|
||||
}
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user