mirror of
https://github.com/cadmium-im/cadmium-docs-legacy.git
synced 2024-11-25 11:52:22 +00:00
Lint Account Registration
This commit is contained in:
parent
4e0c4b1d11
commit
50807e52c0
@ -1,17 +1,23 @@
|
|||||||
# Account registration
|
# Account registration
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
This extension is intended for creating user accounts on a server
|
This extension is intended for creating user accounts on a server
|
||||||
|
|
||||||
## Message type identifiers
|
## Message type identifiers
|
||||||
|
|
||||||
- `profile:register`
|
- `profile:register`
|
||||||
|
|
||||||
## Error codes
|
## Error codes
|
||||||
|
|
||||||
- 0: limit exceed
|
- 0: limit exceed
|
||||||
- 1: username/third party ID already taken
|
- 1: username/third party ID already taken
|
||||||
- 2: registration isn't allowed on a server
|
- 2: registration isn't allowed on a server
|
||||||
|
|
||||||
## Use cases
|
## Use cases
|
||||||
|
|
||||||
- Request:
|
- Request:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"id": "abcd",
|
"id": "abcd",
|
||||||
@ -29,6 +35,7 @@ This extension is intended for creating user accounts on a server
|
|||||||
```
|
```
|
||||||
|
|
||||||
- Response:
|
- Response:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"id": "abcd",
|
"id": "abcd",
|
||||||
@ -56,12 +63,15 @@ This extension is intended for creating user accounts on a server
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Business Rules
|
## Business Rules
|
||||||
|
|
||||||
None.
|
None.
|
||||||
|
|
||||||
## JSON Schema
|
## JSON Schema
|
||||||
**Payload**
|
|
||||||
|
### Payload
|
||||||
|
|
||||||
- Request:
|
- Request:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
interface RegistrationRequestPayload {
|
interface RegistrationRequestPayload {
|
||||||
/**
|
/**
|
||||||
@ -92,7 +102,9 @@ interface ThirdPartyID {
|
|||||||
value: string
|
value: string
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
- Response:
|
- Response:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
interface RegistrationResponsePayload {
|
interface RegistrationResponsePayload {
|
||||||
/**
|
/**
|
||||||
|
Loading…
Reference in New Issue
Block a user