Users¶
This covers the current user-api of Ayaka.
A session_id
is, in lamens terms, just a stringized snowflake.
Note
Session ID’s will only be seeable once you connect to the Gateway,
the READY
events d payload witholds your user data,
of which includes the session_ids
object.
User¶
The following Represents a Ayaka user.
name |
type |
id |
integer |
username |
string |
separator |
integer |
bio |
string |
avatar_url |
string |
banner_url |
string |
flags |
list of strings |
verified |
boolean |
string |
|
password |
string(hashed) |
system |
boolean |
email_verified |
boolean |
session_ids |
list strings |
users/@me¶
- POST /users/@me¶
Creates a User
Arguments:
name
type
username
string
separator
integer
bio?
string
email
string
password
string
- Status Codes
201 Created – Success
400 Bad Request – Invalid Data
- PATCH /users/@me¶
Edits a User
name
type
username
string
separator
integer
bio?
string
email?
string
password?
string
- Status Codes
200 OK – Success
400 Bad Request – Invalid Data
401 Unauthorized – Unauthorized
- GET /users/@me¶
Gives a user object of your currently identified account.
- Request Headers
Authorization – One of
session_id
- Status Codes
200 OK – Success
401 Unauthorized – Unauthorized