Account Endpoints

POST /register

Kill Switch Behavior

This endpoint is affected by the following kill switches:

ACCOUNT_CREATE(0)
ACCOUNT_EMAIL_VERIFY(3)

and will fail with the error ServiceUnavailable if any of these kill switches are enabled.

Ratelimit

This endpoint uses a ratelimit that is separate from the rest of the API. This ratelimit is 1 request per 30 minutes per IP address. If you try to register an account while providing a session, you will receive an InvalidSession error.

Parameters

Name	Type	Location	Required	Description
`username`	string	body	Yes	The new user's username
`email`	string	body	Yes	The new user's email
`password`	string	body	Yes	The new user's password
`confirmPassword`	string	body	Yes	The new user's password confirmation
`rememberMe`	boolean	body	No	Whether or not to remember the user's session

Example Requests

cURLJS Fetch

curl -X POST \
-H "Content-Type: application/json" \
-d '{"username": "alekeagle", "email": "[email protected]", "password": "password", "confirmPassword": "password", "rememberMe": true}' \
https://alekeagle.me/api/register

fetch('https://alekeagle.me/api/register', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    username: 'alekeagle',
    email: '[email protected]',
    password: 'password',
    confirmPassword: 'password',
    rememberMe: true,
  }),
});

Responses

201 Created
- SuccessfulAuth
400 Bad Request
401 Unauthorized
- InvalidSession
409 Conflict
- UserExists
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal
503 Service Unavailable
- ServiceUnavailable

GET /users

Fetches a list of users.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_READ_ACCOUNTS scope.

Parameters

Name	Type	Location	Required	Description
`limit`	number	query	No	The maximum number of users to return. The max and default is 50
`offset`	number	query	No	The number of users to skip before returning results. The default is 0

Example Requests

cURLJS Fetch

curl -X GET \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
https://alekeagle.me/api/users

fetch('https://alekeagle.me/api/users', {
  method: 'GET',
  headers: {
    Authorization:
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
  },
});

Responses

200 OK
- List<User>
401 Unauthorized
- InvalidSession
- EndpointRequiresSecondFactor
403 Forbidden
- InsufficientPermissions
- Banned
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal

GET /users/me

Fetches the current user.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the ACCOUNT_READ scope.

Parameters

There are no parameters for this endpoint.

Example Requests

cURLJS Fetch

curl -X GET \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
https://alekeagle.me/api/users/me

fetch('https://alekeagle.me/api/users/me', {
  method: 'GET',
  headers: {
    Authorization:
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
  },
});

Responses

200 OK
- User
401 Unauthorized
- InvalidSession
403 Forbidden
- InsufficientPermissions
- Banned
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal
503 Service Unavailable
- ServiceUnavailable

GET /users/:id

Fetches a user by their ID.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_READ_ACCOUNTS scope.

Parameters

Name	Type	Location	Required	Description
`id`	string	path	Yes	The User's ID

Example Requests

cURLJS Fetch

curl -X GET \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
https://alekeagle.me/api/users/1234567890123

fetch('https://alekeagle.me/api/users/1234567890123', {
  method: 'GET',
  headers: {
    Authorization:
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
  },
});

Responses

200 OK
- User
401 Unauthorized
- InvalidSession
- EndpointRequiresSecondFactor
403 Forbidden
- InsufficientPermissions
- Banned
404 Not Found
- InvalidUser
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal

PUT /users/me/username

Updates the current user's username.

Kill Switch Behavior

This endpoint is affected by the following kill switches:

ACCOUNT_MODIFY(1)

and will fail with the error ServiceUnavailable if any of these kill switches are enabled.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the ACCOUNT_MODIFY scope.

Identity Reverification

This endpoint will require you to provide at least your password to confirm it's you. More information can found in the Identity Reverification section.

Parameters

Name	Type	Location	Required	Description
`username`	string	body	Yes	The user's new username. Must be between 1 and 64 characters in length

Example Requests

cURLJS Fetch

curl -X PUT \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"username": "alekeagle"}' \
https://alekeagle.me/api/users/me/username

fetch('https://alekeagle.me/api/users/me/username', {
  method: 'PUT',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ username: 'alekeagle' }),
});

Responses

200 OK
- User
400 Bad Request
401 Unauthorized
- InvalidSession
- SecondFactorChallengeRequired
403 Forbidden
- InsufficientPermissions
- Banned
409 Conflict
- UserExists
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal
503 Service Unavailable
- ServiceUnavailable

PUT /users/:id/username

Updates another user's username.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_ACCOUNTS scope.

Identity Reverification

This endpoint will require you to provide at least your password to confirm it's you. More information can found in the Identity Reverification section.

Parameters

Name	Type	Location	Required	Description
`id`	string	path	Yes	The User's ID
`username`	string	body	Yes	The user's new username. Must be between 1 and 64 characters in length

Example Requests

cURLJS Fetch

curl -X PUT \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"username": "alekeagle"}' \
https://alekeagle.me/api/users/1234567890123/username

fetch('https://alekeagle.me/api/users/1234567890123/username', {
  method: 'PUT',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ username: 'alekeagle' }),
});

Responses

200 OK
- User
400 Bad Request
401 Unauthorized
403 Forbidden
- InsufficientPermissions
- Banned
404 Not Found
- InvalidUser
409 Conflict
- UserExists
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal

PUT /users/me/email

Updates the current user's email. You will need to verify your new email address.

Kill Switch Behavior

This endpoint is affected by the following kill switches:

ACCOUNT_MODIFY(1)
ACCOUNT_EMAIL_VERIFY(3)

and will fail with the error ServiceUnavailable if any of these kill switches are enabled.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the ACCOUNT_MODIFY scope.

Identity Reverification

This endpoint will require you to provide at least your password to confirm it's you. More information can found in the Identity Reverification section.

Parameters

Name	Type	Location	Required	Description
`email`	string	body	Yes	The user's new email. Must be a valid email address

Example Requests

cURLJS Fetch

curl -X PUT \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"email": "[email protected]"}' \
https://alekeagle.me/api/users/me/email

fetch('https://alekeagle.me/api/users/me/email', {
  method: 'PUT',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    email: '[email protected]',
  }),
});

Responses

200 OK
- User
400 Bad Request
401 Unauthorized
- InvalidSession
- SecondFactorChallengeRequired
403 Forbidden
- InsufficientPermissions
- Banned
409 Conflict
- UserExists
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal
503 Service Unavailable
- ServiceUnavailable

PUT /users/:id/email

Updates another user's email.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_ACCOUNTS scope.

Identity Reverification

This endpoint will require you to provide at least your password to confirm it's you. More information can found in the Identity Reverification section.

Parameters

Name	Type	Location	Required	Description
`id`	string	path	Yes	The User's ID
`email`	string	body	Yes	The user's new email. Must be a valid email address

Example Requests

cURLJS Fetch

curl -X PUT \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"email": "[email protected]"}' \
https://alekeagle.me/api/users/1234567890123/email

fetch('https://alekeagle.me/api/users/1234567890123/email', {
  method: 'PUT',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    email: '[email protected]',
  }),
});

Responses

200 OK
- User
400 Bad Request
401 Unauthorized
403 Forbidden
- InsufficientPermissions
- Banned
404 Not Found
- InvalidUser
409 Conflict
- UserExists
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal

PUT /users/verify

Verifies a user's email using the token sent to their email.

Authorization Not Required

This endpoint does not require an authorization header.

Kill Switch Behavior

This endpoint is affected by the following kill switches:

ACCOUNT_MODIFY(1)
ACCOUNT_EMAIL_VERIFY(3)

and will fail with the error ServiceUnavailable if any of these kill switches are enabled.

Parameters

Name	Type	Location	Required	Description
`token`	string	body	Yes	The verification token received via email

Example Requests

cURLJS Fetch

curl -X PUT \
-H "Content-Type: application/json" \
-d '{"token": "1234567890123456789012345678901234567890123456789012345678901234"}' \
https://alekeagle.me/api/users/verify

fetch('https://alekeagle.me/api/users/verify', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    token: '1234567890123456789012345678901234567890123456789012345678901234',
  }),
});

Responses

200 OK
- VerifyEmail
400 Bad Request
403 Forbidden
- Banned
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal
503 Service Unavailable
- ServiceUnavailable

PUT /users/:id/verify

Verifies another user's email.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_ACCOUNTS scope.

Identity Reverification

This endpoint will require you to provide at least your password to confirm it's you. More information can found in the Identity Reverification section.

Parameters

Name	Type	Location	Required	Description
`id`	string	path	Yes	The User's ID

Example Requests

cURLJS Fetch

curl -X PUT \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
https://alekeagle.me/api/users/1234567890123/verify

fetch('https://alekeagle.me/api/users/1234567890123/verify', {
  method: 'PUT',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
});

Responses

200 OK
- User
400 Bad Request
- EmailAlreadyVerified
- InvalidSecondFactorResponse
401 Unauthorized
403 Forbidden
- InsufficientPermissions
- Banned
404 Not Found
- InvalidUser
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal

DELETE /users/:id/verify

Removes the verified email flag from a user's account.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_ACCOUNTS scope.

Identity Reverification

This endpoint will require you to provide your password to confirm it's you. More information can found in the Identity Reverification section.

Parameters

Name	Type	Location	Required	Description
`id`	string	path	Yes	The User's ID

Example Requests

cURLJS Fetch

curl -X DELETE \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
https://alekeagle.me/api/users/1234567890123/verify

fetch('https://alekeagle.me/api/users/1234567890123/verify', {
  method: 'DELETE',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
});

Responses

200 OK
- User
400 Bad Request
- EmailNotVerified
- InvalidSecondFactorResponse
401 Unauthorized
403 Forbidden
- InsufficientPermissions
- Banned
404 Not Found
- InvalidUser
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal

GET /users/me/verify

Resend the current user's verification email.

Ratelimit

This endpoint uses a ratelimit that is separate from the rest of the API. This ratelimit is 1 request per 5 minutes per IP address.

Kill Switch Behavior

This endpoint is affected by the following kill switches:

ACCOUNT_MODIFY(1)
ACCOUNT_EMAIL_VERIFY(3)

and will fail with the error ServiceUnavailable if any of these kill switches are enabled.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the ACCOUNT_MODIFY scope.

Parameters

There are no parameters for this endpoint.

Example Requests

cURLJS Fetch

curl -X GET \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
https://alekeagle.me/api/users/me/verify

fetch('https://alekeagle.me/api/users/me/verify', {
  method: 'GET',
  headers: {
    Authorization:
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
  },
});

Responses

201 Created
- SendVerificationEmail
400 Bad Request
- EmailAlreadyVerified
401 Unauthorized
- InvalidSession
403 Forbidden
- InsufficientPermissions
- Banned
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal
503 Service Unavailable
- ServiceUnavailable

GET /users/:id/verify

Resend another user's verification email.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_ACCOUNTS scope.

Parameters

Name	Type	Location	Required	Description
`id`	string	path	Yes	The User's ID

Example Requests

cURLJS Fetch

curl -X GET \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
https://alekeagle.me/api/users/1234567890123/verify

fetch('https://alekeagle.me/api/users/1234567890123/verify', {
  method: 'GET',
  headers: {
    Authorization:
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
  },
});

Responses

201 Created
- SendVerificationEmail
400 Bad Request
- EmailAlreadyVerified
401 Unauthorized
- InvalidSession
403 Forbidden
- InsufficientPermissions
- Banned
404 Not Found
- InvalidUser
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal

PUT /users/me/password

Updates the current user's password.

Kill Switch Behavior

This endpoint is affected by the following kill switches:

ACCOUNT_MODIFY(1)

and will fail with the error ServiceUnavailable if any of these kill switches are enabled.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the ACCOUNT_MODIFY scope.

Identity Reverification

This endpoint will require you to provide your password to confirm it's you. More information can found in the Identity Reverification section.

Parameters

Name	Type	Location	Required	Description
`newPassword`	string	body	Yes	The user's new password. Must be no more than 64 characters in length
`confirmNewPassword`	string	body	Yes	The user's new password confirmation. Must be no more than 64 characters in length

Example Requests

cURLJS Fetch

curl -X PUT \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{ "newPassword": "password1", "confirmNewPassword": "password1"}' \
https://alekeagle.me/api/users/me/password

fetch('https://alekeagle.me/api/users/me/password', {
  method: 'PUT',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    newPassword: 'password1',
    confirmNewPassword: 'password1',
  }),
});

Responses

200 OK
- User
400 Bad Request
401 Unauthorized
- InvalidSession
- SecondFactorChallengeRequired
403 Forbidden
- InsufficientPermissions
- Banned
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal
503 Service Unavailable
- ServiceUnavailable

PUT /users/:id/password

Updates another user's password.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_ACCOUNTS scope.

Identity Reverification

This endpoint will require you to provide your password to confirm it's you. More information can found in the Identity Reverification section.

Parameters

Name	Type	Location	Required	Description
`id`	string	path	Yes	The User's ID
`newPassword`	string	body	Yes	The user's new password. Must be no more than 64 characters in length
`confirmNewPassword`	string	body	Yes	The user's new password confirmation. Must be no more than 64 characters in length

Example Requests

cURLJS Fetch

curl -X PUT \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{ "newPassword": "password1", "confirmNewPassword": "password1"}' \
https://alekeagle.me/api/users/1234567890123/password

fetch('https://alekeagle.me/api/users/1234567890123/password', {
  method: 'PUT',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    newPassword: 'password1',
    confirmNewPassword: 'password1',
  }),
});

Responses

200 OK
- User
400 Bad Request
401 Unauthorized
403 Forbidden
- InsufficientPermissions
- Banned
404 Not Found
- InvalidUser
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal

PUT /users/:id/staff

Promotes a specified user to staff.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_ACCOUNTS scope.

Identity Reverification

This endpoint will require you to provide your password to confirm it's you. More information can found in the Identity Reverification section.

Parameters

Name	Type	Location	Required	Description
`id`	string	path	Yes	The User's ID

Example Requests

cURLJS Fetch

curl -X PUT \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
https://alekeagle.me/api/users/1234567890123/staff

fetch('https://alekeagle.me/api/users/1234567890123/staff', {
  method: 'PUT',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
});

Responses

200 OK
- User
400 Bad Request
401 Unauthorized
403 Forbidden
- InsufficientPermissions
- Banned
404 Not Found
- InvalidUser
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal

DELETE /users/:id/staff

Demotes a specified user from staff.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_ACCOUNTS scope.

Identity Reverification

This endpoint will require you to provide your password to confirm it's you. More information can found in the Identity Reverification section.

Parameters

Name	Type	Location	Required	Description
`id`	string	path	Yes	The User's ID

Example Requests

cURLJS Fetch

curl -X DELETE \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
https://alekeagle.me/api/users/1234567890123/staff

fetch('https://alekeagle.me/api/users/1234567890123/staff', {
  method: 'DELETE',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
});

Responses

200 OK
- User
400 Bad Request
- MissingFields
- InvalidSecondFactorResponse
401 Unauthorized
403 Forbidden
- InsufficientPermissions
- Banned
404 Not Found
- InvalidUser
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal

PUT /users/:id/ban

Bans a user.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_ACCOUNTS scope.

Identity Reverification

This endpoint will require you to provide your password to confirm it's you. More information can found in the Identity Reverification section.

Parameters

Name	Type	Location	Required	Description
`id`	string	path	Yes	The User's ID
`reason`	string	body	Yes	The reason for banning the user's account.

Example Requests

cURLJS Fetch

curl -X PUT \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"reason":"Hurt my feel goods :("}' \
https://alekeagle.me/api/users/1234567890123/ban

fetch('https://alekeagle.me/api/users/1234567890123/ban', {
  method: 'PUT',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    reason: 'Hurt my feel goods :(',
  }),
});

Responses

200 OK
- User
400 Bad Request
- InvalidSecondFactorResponse
401 Unauthorized
403 Forbidden
- InsufficientPermissions
- Banned
404 Not Found
- InvalidUser
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal

DELETE /users/:id/ban

Unbans a user.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_ACCOUNTS scope.

Identity Reverification

This endpoint will require you to provide your password to confirm it's you. More information can found in the Identity Reverification section.

Parameters

Name	Type	Location	Required	Description
`id`	string	path	Yes	The User's ID

Example Requests

cURLJS Fetch

curl -X DELETE \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
https://alekeagle.me/api/users/1234567890123/ban

fetch('https://alekeagle.me/api/users/1234567890123/ban', {
  method: 'DELETE',
  headers: {
    Authorization:
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
  },
});

Responses

200 OK
- User
400 Bad Request
- InvalidSecondFactorResponse
401 Unauthorized
- InvalidSession
- SecondFactorChallengeRequired
403 Forbidden
- InsufficientPermissions
- Banned
404 Not Found
- InvalidUser
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal

PUT /users/me/domain

Updates the current user's domain.

Kill Switch Behavior

This endpoint is affected by the following kill switches:

ACCOUNT_MODIFY(1)

and will fail with the error ServiceUnavailable if any of these kill switches are enabled.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the ACCOUNT_MODIFY scope.

Parameters

Name	Type	Location	Required	Description
`domain`	string	body	Yes	The user's new domain
`subdomain`	string	body	No	The user's new subdomain

Example Requests

cURLJS Fetch

curl -X PUT \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"domain": "example.com", "subdomain": "this-is-an"}' \
https://alekeagle.me/api/users/me/domain

fetch('https://alekeagle.me/api/users/me/domain', {
  method: 'PUT',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    domain: 'example.com',
    subdomain: 'this-is-an',
  }),
});

Responses

200 OK
- User
400 Bad Request
401 Unauthorized
- InvalidSession
403 Forbidden
- InsufficientPermissions
- Banned
404 Not Found
- InvalidDomain
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal
503 Service Unavailable
- ServiceUnavailable

PUT /users/:id/domain

Updates another user's domain.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_ACCOUNTS scope.

Parameters

Name	Type	Location	Required	Description
`id`	string	path	Yes	The User's ID
`domain`	string	body	Yes	The user's domain
`subdomain`	string	body	No	The user's subdomain

Example Requests

cURLJS Fetch

curl -X PUT \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"domain": "example.com", "subdomain": "this-is-an"}' \
https://alekeagle.me/api/users/1234567890123/domain

fetch('https://alekeagle.me/api/users/1234567890123/domain', {
  method: 'PUT',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    domain: 'example.com',
    subdomain: 'this-is-an',
  }),
});

Responses

200 OK
- User
400 Bad Request
401 Unauthorized
- InvalidSession
- EndpointRequiresSecondFactor
403 Forbidden
- InsufficientPermissions
- Banned
404 Not Found
- InvalidDomain
- InvalidUser
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal

DELETE /users/me

Deletes the current user.

Kill Switch Behavior

This endpoint is affected by the following kill switches:

ACCOUNT_DELETE(2)

and will fail with the error ServiceUnavailable if any of these kill switches are enabled.

Scoped Session

This endpoint is not accessible using a scoped session. This is to prevent user accounts from being deleted without explicit user consent.

Identity Reverification

This endpoint will require you to provide your password to confirm it's you. More information can found in the Identity Reverification section.

Parameters

This endpoint does not require any parameters.

Example Requests

cURLJS Fetch

curl -X DELETE \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
https://alekeagle.me/api/users/me

fetch('https://alekeagle.me/api/users/me', {
  method: 'DELETE',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
});

Responses

200 OK
- DeleteUser
400 Bad Request
- MissingFields
- InvalidPassword
401 Unauthorized
- InvalidSession
- SecondFactorChallengeRequired
403 Forbidden
- InsufficientPermissions
- Banned
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal
503 Service Unavailable
- ServiceUnavailable

DELETE /users/:id

Deletes a specified user.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_ACCOUNTS scope.

Identity Reverification

This endpoint will require you to provide your password to confirm it's you. More information can found in the Identity Reverification section.

Parameters

Name	Type	Location	Required	Description
`id`	string	path	Yes	The User's ID

Example Requests

cURLJS Fetch

curl -X DELETE \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"username": "alekeagle", "password": "password"}' \
https://alekeagle.me/api/users/1234567890123

fetch('https://alekeagle.me/api/users/1234567890123', {
  method: 'DELETE',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    username: 'alekeagle',
    password: 'password',
  }),
});

Responses

200 OK
- DeleteUser
400 Bad Request
- MissingFields
- InvalidPassword
401 Unauthorized
403 Forbidden
- InsufficientPermissions
- Banned
404 Not Found
- InvalidUser
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal

DELETE /users

Delete multiple users.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_ACCOUNTS scope.

Identity Reverification

This endpoint will require you to provide your password to confirm it's you. More information can found in the Identity Reverification section.

Parameters

Name	Type	Location	Required	Description
`ids`	string	body	Yes	An array of User IDs

Example Requests

cURLJS Fetch

curl -X DELETE \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"ids": ["1647015028626", "1647015028626"]}' \
https://alekeagle.me/api/users

fetch('https://alekeagle.me/api/users', {
  method: 'DELETE',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    ids: ['1647015028626', '1647015028626'],
  }),
});

Responses

200 OK
- DeleteUsers
400 Bad Request
- MissingFields
- InvalidUser
401 Unauthorized
403 Forbidden
- InsufficientPermissions
- Banned
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal

Account Endpoints ​

POST /register ​

GET /users ​

GET /users/me ​

GET /users/:id ​

PUT /users/me/username ​

PUT /users/:id/username ​

PUT /users/me/email ​

PUT /users/:id/email ​

PUT /users/verify ​

PUT /users/:id/verify ​

DELETE /users/:id/verify ​

GET /users/me/verify ​

GET /users/:id/verify ​

PUT /users/me/password ​

PUT /users/:id/password ​

PUT /users/:id/staff ​

DELETE /users/:id/staff ​

PUT /users/:id/ban ​

DELETE /users/:id/ban ​

PUT /users/me/domain ​

PUT /users/:id/domain ​

DELETE /users/me ​

DELETE /users/:id ​

DELETE /users ​

Account Endpoints

POST /register

GET /users

GET /users/me

GET /users/:id

PUT /users/me/username

PUT /users/:id/username

PUT /users/me/email

PUT /users/:id/email

PUT /users/verify

PUT /users/:id/verify

DELETE /users/:id/verify

GET /users/me/verify

GET /users/:id/verify

PUT /users/me/password

PUT /users/:id/password

PUT /users/:id/staff

DELETE /users/:id/staff

PUT /users/:id/ban

DELETE /users/:id/ban

PUT /users/me/domain

PUT /users/:id/domain

DELETE /users/me

DELETE /users/:id

DELETE /users