Users

Request two factor auth

POST

https://peertube2.cpy.re/api/v1/users/{id}/two-factor/request

Request two factor authentication for a user

curl -X POST 'https://peertube2.cpy.re/api/v1/users/42/two-factor/request' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "currentPassword": "string"
}'

const body = `{
  "currentPassword": "string"
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/users/42/two-factor/request', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "currentPassword": "string"
}'''

response = requests.post(
    'https://peertube2.cpy.re/api/v1/users/42/two-factor/request',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "currentPassword": "string"
}

200

[
  {
    "otpRequest": {
      "requestToken": "string",
      "secret": "string",
      "uri": "string"
    }
  }
]

Body

application/json

currentPasswordstring

Password of the currently authenticated user

Parameters

idid>= 1requiredpath

Entity id

Response

200OKArray<RequestTwoFactorResponse>

successful operation

Response fields application/json

Array<RequestTwoFactorResponse>

Show child attributes

otpRequestobject

Show child attributes

requestTokenstring

The token to send to confirm this request

secretstring

The OTP secret

uristring

The OTP URI

403Forbidden

invalid password

404Not Found

user not found

429Too Many Requests

too many password checks for this user

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Docs by Sourcey