Users

Update a user

PUT

https://peertube2.cpy.re/api/v1/users/{id}

Update a user

curl -X PUT 'https://peertube2.cpy.re/api/v1/users/42' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "emailVerified": true,
  "videoQuota": 0,
  "videoQuotaDaily": 0,
  "pluginAuth": "peertube-plugin-auth-saml2",
  "role": 2,
  "adminFlags": 1,
  "password": "********"
}'

const body = `{
  "emailVerified": true,
  "videoQuota": 0,
  "videoQuotaDaily": 0,
  "pluginAuth": "peertube-plugin-auth-saml2",
  "role": 2,
  "adminFlags": 1,
  "password": "********"
}`;

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

const data = await response.text();

import requests

body = '''{
  "emailVerified": true,
  "videoQuota": 0,
  "videoQuotaDaily": 0,
  "pluginAuth": "peertube-plugin-auth-saml2",
  "role": 2,
  "adminFlags": 1,
  "password": "********"
}'''

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

Request Body

{
  "emailVerified": true,
  "videoQuota": 0,
  "videoQuotaDaily": 0,
  "pluginAuth": "peertube-plugin-auth-saml2",
  "role": 2,
  "adminFlags": 1,
  "password": "********"
}

Body

application/json

emailemail

The updated email of the user

Show child attributes

The user email

email<email>

emailVerifiedboolean

Set the email as verified

videoQuotainteger

The updated video quota of the user in bytes

videoQuotaDailyinteger

The updated daily video quota of the user in bytes

pluginAuthstring | null

The auth plugin to use to authenticate the user

Example

peertube-plugin-auth-saml2

roleUserRole012

The user role (Admin = 0, Moderator = 1, User = 2)

Example

adminFlagsUserAdminFlags01

Admin flags for the user (None = 0, Bypass video blocklist = 1)

Example

passwordpassword<password>

currentPasswordcurrentPassword

Required to give the administrator role, or to change the password, email or auth plugin of an administrator, see password confirmation

Show child attributes

Password of the authenticated user, required if password confirmation is enabled

currentPassword<password>

Parameters

idid>= 1requiredpath

Entity id

Response

204No Content

successful operation

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