mirror of
https://github.com/cadmium-im/cadmium-docs-legacy.git
synced 2024-11-08 19:51:02 +00:00
Lint Account Registration
This commit is contained in:
parent
4e0c4b1d11
commit
50807e52c0
@ -1,17 +1,23 @@
|
||||
# Account registration
|
||||
|
||||
## Introduction
|
||||
|
||||
This extension is intended for creating user accounts on a server
|
||||
|
||||
## Message type identifiers
|
||||
- `profile:register`
|
||||
|
||||
- `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",
|
||||
@ -29,6 +35,7 @@ This extension is intended for creating user accounts on a server
|
||||
```
|
||||
|
||||
- Response:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "abcd",
|
||||
@ -56,12 +63,15 @@ This extension is intended for creating user accounts on a server
|
||||
```
|
||||
|
||||
## Business Rules
|
||||
|
||||
None.
|
||||
|
||||
## JSON Schema
|
||||
**Payload**
|
||||
|
||||
### Payload
|
||||
|
||||
- Request:
|
||||
|
||||
```typescript
|
||||
interface RegistrationRequestPayload {
|
||||
/**
|
||||
@ -92,7 +102,9 @@ interface ThirdPartyID {
|
||||
value: string
|
||||
}
|
||||
```
|
||||
|
||||
- Response:
|
||||
|
||||
```typescript
|
||||
interface RegistrationResponsePayload {
|
||||
/**
|
||||
@ -100,4 +112,4 @@ interface RegistrationResponsePayload {
|
||||
*/
|
||||
userID: EntityID
|
||||
}
|
||||
```
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user