PeerTube · Example Payload

Confirmtwofactorrequest

Confirm a two factor authentication request

Users

Confirmtwofactorrequest is an example object payload from PeerTube, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses

Example Payload

Raw ↑ 
{
  "operationId": "confirmTwoFactorRequest",
  "method": "POST",
  "path": "/api/v1/users/{id}/two-factor/confirm-request",
  "summary": "Confirm two factor auth",
  "description": "Confirm a two factor authentication request",
  "tags": [
    "Users"
  ],
  "parameters": [
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    }
  ],
  "requestBody": {
    "contentType": "application/json",
    "schema": {
      "type": "object",
      "properties": {
        "requestToken": {
          "type": "string",
          "description": "Token to identify the two factor request"
        },
        "otpToken": {
          "type": "string",
          "description": "OTP token generated by the app"
        }
      },
      "required": [
        "requestToken",
        "otpToken"
      ]
    },
    "example": {}
  },
  "responses": {
    "204": {
      "description": "successful operation",
      "examples": {}
    },
    "403": {
      "description": "invalid request token or OTP token",
      "examples": {}
    },
    "404": {
      "description": "user not found",
      "examples": {}
    }
  }
}