PeerTube · OAuth Scopes

PeerTube OAuth Scopes

OAuth 2.0 derived

PeerTube publishes 3 OAuth 2.0 scopes via the password flow. Scopes are the fine-grained permissions an application requests at authorization time to act against the PeerTube API on a user’s behalf.

Tokens are issued from /api/v1/users/token.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

VideoDecentralizedFederationOpen SourceActivityPubSelf-HostedStreaming

Scopes: 3 Flows: password Method: derived

OAuth endpoints

Token URL
/api/v1/users/token

Flows
password

Scopes (3)

Scope	Description	Flows
admin	Admin scope	password
moderator	Moderator scope	password
user	User scope	password

📄 Provider scope reference:

Source

OAuth Scopes

generated: '2026-07-11'
method: derived
source: openapi/openapi.json, openapi/openapi.yaml
schemes:
- name: OAuth2
  source: openapi/openapi.json
  flows:
  - flow: password
    tokenUrl: /api/v1/users/token
  description: |-
    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__.

    [Generate]: https://docs.joinpeertube.org/api/rest-getting-started
- name: OAuth2
  source: openapi/openapi.yaml
  flows:
  - flow: password
    tokenUrl: /api/v1/users/token
  description: |-
    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__.

    [Generate]: https://docs.joinpeertube.org/api/rest-getting-started
scopes:
- scope: admin
  description: Admin scope
  flows:
  - password
  sources:
  - openapi/openapi.json
  - openapi/openapi.yaml
- scope: moderator
  description: Moderator scope
  flows:
  - password
  sources:
  - openapi/openapi.json
  - openapi/openapi.yaml
- scope: user
  description: User scope
  flows:
  - password
  sources:
  - openapi/openapi.json
  - openapi/openapi.yaml