cadmium-im/cadmium-docs-legacy
1
0
Fork 0
mirror of https://github.com/cadmium-im/cadmium-docs-legacy.git synced 2024-11-21 18:02:24 +00:00
Code Issues Projects Releases Wiki Activity

Separate the extension of the user account registration system into a separate CE document

Browse Source
This commit is contained in:
ChronosX88 2019-12-15 20:04:30 +04:00
parent 6b6e1cd101
commit 4963602bbd
Signed by: ChronosXYZ
GPG Key ID: 085A69A82C8C511A
2 changed files with 103 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

103
protocol-spec/account-registration.md Normal file
View File

@ -0,0 +1,103 @@
# Account registration
## Introduction
This extension is intended for creating user accounts on a server
## Message type identifiers
- `profile:register`
## Error codes
- 0: limit exceed
- 1: username/third party ID already taken
- 2: registration isn't allowed on a server
## Use cases
- Request:
```json
{
"id": "abcd",
"type": "profile:register",
"to": "cadmium.org",
"payload": {
"username": "juliet",
"thirdPIDs": [
{"type":"email", "value":"juliet@capulett.com"},
{"type":"msisdn", "value":"+1234567890"},
],
"password": "romeo1"
}
}
```
- Response:
```json
{
"id": "abcd",
"type": "profile:register",
"from": "cadmium.org",
"ok": true,
"payload": {
"userID": "@juliet@cadmium.org"
}
}
```
*<b>Error</b> response*:
```json
{
"id": "abcd",
"type": "profile:register",
"from": "cadmium.org",
"ok": false,
"payload": {
"errCode": 1,
"errText": "{Username/email/msisdn} already taken"
}
}
```
## Business Rules
None.
## JSON Schema
**Payload**
- Request:
```typescript
interface RegistrationRequestPayload {
/**
* The username that the user wants to register
*/
username: string,
/**
* Array of user third party IDs (email and/or MSISDN)
*/
thirdPIDs: ThirdPartyID[],
/**
* Password of new account
*/
password: string
}
interface ThirdPartyID {
/**
* Type of third party ID
*/
type: string,
/**
* String contains third party ID. Examples: "juliet@capulett.com", "+1234567890".
*/
value: string
}
```
- Response:
```typescript
interface RegistrationResponsePayload {
/**
* ID of user (Username in priority. If we haven't username, then we put to this field one of user's third party IDs)
*/
userID: EntityID
}
```

98
protocol-spec/core.md
View File

@ -7,7 +7,6 @@
- [Errors](#errors)
- [User devices](#user-devices)
- [Account registration/login](#account-registrationlogin)
- [Create account](#create-account)
- [Login into account (by username)](#login-into-account-by-username)
## Transport
@ -128,103 +127,6 @@ interface ErrorPayload {
`todo`
## Account registration/login
### Create account
**Description**: Create user account on a server
**Type**: `profile:register`
**Payload**:
- Request:
```typescript
interface RegistrationRequestPayload {
/**
* The username that the user wants to register
*/
username: string,
/**
* Array of user third party IDs (email and/or MSISDN)
*/
thirdPIDs: ThirdPartyID[],
/**
* Password of new account
*/
password: string
}
interface ThirdPartyID {
/**
* Type of third party ID
*/
type: string,
/**
* String contains third party ID. Examples: "juliet@capulett.com", "+1234567890".
*/
value: string
}
```
- Response:
```typescript
interface RegistrationResponsePayload {
/**
* ID of user (Username in priority. If we haven't username, then we put to this field one of user's third party IDs)
*/
userID: EntityID
}
```
**Errors**:
- 0: limit exceed
- 1: username/third party ID already taken
- 2: registration isn't allowed on a server
**Usecase**:
*Request*:
```json
{
"id": "abcd",
"type": "profile:register",
"to": "cadmium.org",
"payload": {
"username": "juliet",
"thirdPIDs": [
{"type":"email", "value":"juliet@capulett.com"},
{"type":"msisdn", "value":"+1234567890"},
],
"password": "romeo1"
}
}
```
*Response*:
```json
{
"id": "abcd",
"type": "profile:register",
"from": "cadmium.org",
"ok": true,
"payload": {
"userID": "@juliet@cadmium.org"
}
}
```
*<b>Error</b> response*:
```json
{
"id": "abcd",
"type": "profile:register",
"from": "cadmium.org",
"ok": false,
"payload": {
"errCode": 1,
"errText": "{Username/email/msisdn} already taken"
}
}
```
**Special business rules**: none.
### Login into account (by username)
**Description**: Login into user account on a server by username