Second Factor Endpoints

GET /users/me/2fa

Get a list of second factor methods enabled for the current user.

Scoped Session

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

Parameters

Name	Type	Location	Required	Description
`limit`	number	query	No	The maximum number of second factors to return. The max and default is 50
`offset`	number	query	No	The number of second factors 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/me/2fa

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

Responses

200 OK
- List<SecondFactor>
401 Unauthorized
- InvalidSession
403 Forbidden
- InsufficientPermissions
- Banned
429 Too Many Requests
- RateLimited
500 Internal Server Error
- InternalServerError
503 Service Unavailable
- ServiceUnavailable

GET /users/:id/2fa

Get a list of second factor methods enabled for the 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_READ_SECOND_FACTORS scope.

Parameters

Name	Type	Location	Required	Description
`id`	string	path	Yes	The User's ID
`limit`	number	query	No	The maximum number of second factors to return. The max and default is 50
`offset`	number	query	No	The number of second factors 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/1234567890123/2fa

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

Responses

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

GET /users/me/2fa/:id

Get the specified second factor for the current user.

Scoped Session

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

Parameters

Name	Type	Location	Required	Description
`id`	string	path	Yes	The ID of the second factor to return.

Example Requests

cURLJS Fetch

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

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

Responses

200 OK
- SecondFactor
401 Unauthorized
- InvalidSession
403 Forbidden
- InsufficientPermissions
- Banned
404 Not Found
- InvalidSecondFactor
429 Too Many Requests
- RateLimited
500 Internal Server Error
- Internal
503 Service Unavailable
- ServiceUnavailable

GET /users/:uid/2fa/:id

Get the specified second factor for the 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_READ_SECOND_FACTORS scope.

Parameters

Name	Type	Location	Required	Description
`uid`	string	path	Yes	The User's ID
`id`	string	path	Yes	The ID of the second factor to return.

Example Requests

cURLJS Fetch

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

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

Responses

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

POST /users/me/2fa/totp

Begins the process of registering a new TOTP second factor for the current user.

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 are not allowed in order to prevent second factors being registered without explicit user consent.

Identity Reverification

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

Parameters

This endpoint does not require any parameters.

Example Requests

cURLJS Fetch

curl -X POST \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"password": "password"}' \
https://alekeagle.me/api/users/me/2fa/totp

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

Responses

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

POST /users/me/2fa/totp/confirm

Completes the process of registering a new TOTP second factor for the current user.

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 are not allowed in order to prevent second factors being registered without explicit user consent.

Parameters

Name	Type	Location	Required	Description
`token`	string	body	Yes	The token returned from `SecondFactorTOTPRegistration`
`name`	string	body	Yes	The name of the second factor.
`code`	string	body	Yes	The TOTP code to verify the second factor.

Example Requests

cURLJS Fetch

curl -X POST \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"token": "token", "name": "name", "code": "123456"}' \
https://alekeagle.me/api/users/me/2fa/totp/confirm

fetch('https://alekeagle.me/api/users/me/2fa/totp/confirm', {
  method: 'POST',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ token: 'token', name: 'name', code: '123456' }),
});

Responses

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

POST /users/me/2fa/webauthn

Begins the process of registering a new WebAuthn second factor for the current user.

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 are not allowed in order to prevent second factors being registered without explicit user consent.

Identity Reverification

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

Parameters

This endpoint does not require any parameters.

Example Requests

cURLJS Fetch

curl -X POST \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"password": "password"}' \
https://alekeagle.me/api/users/me/2fa/webauthn

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

Responses

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

POST /users/me/2fa/webauthn/confirm

Completes the process of registering a new WebAuthn second factor for the current user.

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 are not allowed in order to prevent second factors being registered without explicit user consent.

Parameters

Name	Type	Location	Required	Description
`token`	string	body	Yes	The token returned from `SecondFactorWebAuthnRegistration`
`name`	string	body	Yes	The name of the second factor.
`response`	object	body	Yes	The response from the WebAuthn registration.

Example Requests

cURLJS Fetch

curl -X POST \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"token": "token", "name": "name", "response": {}}' \
https://alekeagle.me/api/users/me/2fa/webauthn/confirm

fetch('https://alekeagle.me/api/users/me/2fa/webauthn/confirm', {
  method: 'POST',
  headers: {
    'Authorization': 'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    token: 'token
    name: 'name',
    response: {}
  }),
});

Responses

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

POST /users/me/2fa/backup

Regenerate backup codes for the current user. You must have at least one second factor enabled to use this endpoint.

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 are not allowed in order to prevent second factors being registered without explicit user consent.

Identity Reverification

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

Parameters

This endpoint does not require any parameters.

Example Requests

cURLJS Fetch

curl -X POST \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"password": "password"}' \
https://alekeagle.me/api/users/me/2fa/backup

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

Responses

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

DELETE /users/me/2fa/:id

Deletes the specified second factor for the current user.

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 are not allowed in order to prevent second factors being registered without explicit user consent.

Identity Reverification

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

Parameters

Name	Type	Location	Required	Description
`id`	string	path	Yes	The ID of the second factor to delete.

Example Requests

cURLJS Fetch

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

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

Responses

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

DELETE /users/:uid/2fa/:id

Deletes the specified second factor for the 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_SECOND_FACTORS scope.

Identity Reverification

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

Parameters

Name	Type	Location	Required	Description
`uid`	string	path	Yes	The User's ID
`id`	string	path	Yes	The ID of the second factor to delete.

Example Requests

cURLJS Fetch

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

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

Responses

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

DELETE /users/me/2fa/all

Deletes all second factors for the current user.

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 are not allowed in order to prevent second factors being removed without explicit user consent.

Identity Reverification

This endpoint will require you to provide your password to confirm it's you. More information can be 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/2fa/all

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

Responses

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

DELETE /users/:uid/2fa/all

Deletes all second factors for the 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_SECOND_FACTORS scope.

Identity Reverification

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

Parameters

Name	Type	Location	Required	Description
`uid`	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/2fa/all

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

Responses

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

Second Factor Endpoints ​

GET /users/me/2fa ​

GET /users/:id/2fa ​

GET /users/me/2fa/:id ​

GET /users/:uid/2fa/:id ​

POST /users/me/2fa/totp ​

POST /users/me/2fa/totp/confirm ​

POST /users/me/2fa/webauthn ​

POST /users/me/2fa/webauthn/confirm ​

POST /users/me/2fa/backup ​

DELETE /users/me/2fa/:id ​

DELETE /users/:uid/2fa/:id ​

DELETE /users/me/2fa/all ​

DELETE /users/:uid/2fa/all ​

Second Factor Endpoints

GET /users/me/2fa

GET /users/:id/2fa

GET /users/me/2fa/:id

GET /users/:uid/2fa/:id

POST /users/me/2fa/totp

POST /users/me/2fa/totp/confirm

POST /users/me/2fa/webauthn

POST /users/me/2fa/webauthn/confirm

POST /users/me/2fa/backup

DELETE /users/me/2fa/:id

DELETE /users/:uid/2fa/:id

DELETE /users/me/2fa/all

DELETE /users/:uid/2fa/all