mirror of
https://github.com/cadmium-im/cadmium-docs-legacy.git
synced 2024-11-09 12:11:03 +00:00
Fix to
property in CPE 2/3 use cases section, add urn:cadmium
prefix to all identifiers in these CPEs
This commit is contained in:
parent
2380309051
commit
5643c80979
@ -6,12 +6,12 @@ This extension is intended for logging into user account on a server by username
|
|||||||
|
|
||||||
## Message type identifiers
|
## Message type identifiers
|
||||||
|
|
||||||
- `profile:login`
|
- `urn:cadmium:profile:login`
|
||||||
|
|
||||||
## Errors
|
## Errors
|
||||||
|
|
||||||
- Ratelimit system: enabled
|
- Ratelimit system: enabled
|
||||||
- `invalid_creds`: user ID/password isn't valid
|
- `urn:cadmium:profile:login:invalid_creds`: user ID/password isn't valid
|
||||||
|
|
||||||
## Use cases
|
## Use cases
|
||||||
|
|
||||||
@ -20,8 +20,8 @@ This extension is intended for logging into user account on a server by username
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"id": "abcd",
|
"id": "abcd",
|
||||||
"type": "profile:login",
|
"type": "urn:cadmium:profile:login",
|
||||||
"to": "cadmium.org",
|
"to": ["cadmium.org"],
|
||||||
"payload": {
|
"payload": {
|
||||||
"username": "juliet",
|
"username": "juliet",
|
||||||
"password": "romeo1"
|
"password": "romeo1"
|
||||||
@ -34,7 +34,7 @@ This extension is intended for logging into user account on a server by username
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"id": "abcd",
|
"id": "abcd",
|
||||||
"type": "profile:login",
|
"type": "urn:cadmium:profile:login",
|
||||||
"from": "cadmium.org",
|
"from": "cadmium.org",
|
||||||
"ok": true,
|
"ok": true,
|
||||||
"payload": {
|
"payload": {
|
||||||
@ -49,11 +49,11 @@ This extension is intended for logging into user account on a server by username
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"id": "abcd",
|
"id": "abcd",
|
||||||
"type": "profile:login",
|
"type": "urn:cadmium:profile:login",
|
||||||
"from": "cadmium.org",
|
"from": "cadmium.org",
|
||||||
"ok": false,
|
"ok": false,
|
||||||
"payload": {
|
"payload": {
|
||||||
"errID": "invalid_creds",
|
"errID": "urn:cadmium:profile:login:invalid_creds",
|
||||||
"errText": "Username/password isn't valid"
|
"errText": "Username/password isn't valid"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -6,13 +6,13 @@ This extension is intended for creating user accounts on a server
|
|||||||
|
|
||||||
## Message type identifiers
|
## Message type identifiers
|
||||||
|
|
||||||
- `profile:register`
|
- `urn:cadmium:profile:register`
|
||||||
|
|
||||||
## Errors
|
## Errors
|
||||||
|
|
||||||
- Ratelimit system: enabled
|
- Ratelimit system: enabled
|
||||||
- `id_exists`: username/third party ID already taken
|
- `urn:cadmium:profile:register:id_exists`: username/third party ID already taken
|
||||||
- `reg_disabled`: registration isn't allowed on a server
|
- `urn:cadmium:profile:register:reg_disabled`: registration isn't allowed on a server
|
||||||
|
|
||||||
## Use cases
|
## Use cases
|
||||||
|
|
||||||
@ -25,8 +25,8 @@ This extension is intended for creating user accounts on a server
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"id": "abcd",
|
"id": "abcd",
|
||||||
"type": "profile:register",
|
"type": "urn:cadmium:profile:register",
|
||||||
"to": "cadmium.org",
|
"to": ["cadmium.org"],
|
||||||
"payload": {
|
"payload": {
|
||||||
"username": "juliet",
|
"username": "juliet",
|
||||||
"thirdPIDs": [
|
"thirdPIDs": [
|
||||||
@ -44,7 +44,7 @@ This extension is intended for creating user accounts on a server
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"id": "abcd",
|
"id": "abcd",
|
||||||
"type": "profile:register",
|
"type": "urn:cadmium:profile:register",
|
||||||
"from": "cadmium.org",
|
"from": "cadmium.org",
|
||||||
"ok": true,
|
"ok": true,
|
||||||
"payload": {
|
"payload": {
|
||||||
@ -58,11 +58,11 @@ This extension is intended for creating user accounts on a server
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"id": "abcd",
|
"id": "abcd",
|
||||||
"type": "profile:register",
|
"type": "urn:cadmium:profile:register",
|
||||||
"from": "cadmium.org",
|
"from": "cadmium.org",
|
||||||
"ok": false,
|
"ok": false,
|
||||||
"payload": {
|
"payload": {
|
||||||
"errID": "id_exists",
|
"errID": "urn:cadmium:profile:register:id_exists",
|
||||||
"errText": "Username/email/msisdn already taken"
|
"errText": "Username/email/msisdn already taken"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user