PeerTube

Create a user

Live Test Server (live data - latest nightly version)

https://peertube2.cpy.re/api/v1

POST

/users

Users

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://peertube2.cpy.re/api/v1/users' \
--header 'Content-Type: application/json' \
--data-raw '{
    "adminFlags": 1,
    "channelName": "framasoft_videos",
    "email": "user@example.com",
    "password": "pa$$word",
    "role": 2,
    "username": "chocobozzz",
    "videoQuota": -1,
    "videoQuotaDaily": -1
}'

Response Example

200 - Example 1

{
    "user": {
        "account": {
            "id": 42
        },
        "id": 42
    }
}

Request

Body Params application/json

adminFlags

enum<integer>

optional

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

Allowed values:

Example:

channelName

string

optional

immutable name of the channel, used to interact with its actor

>= 1 characters<= 50 characters

Example:

framasoft_videos

Match pattern:

/^[a-zA-Z0-9\\-_.:]+$/

string <email>

required

The user email

password

string <password>

required

>= 6 characters<= 255 characters

role

enum<integer>

required

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

Allowed values:

012

Example:

username

string

required

immutable name of the user, used to find or mention its actor

>= 1 characters<= 50 characters

Example:

chocobozzz

Match pattern:

/^[a-z0-9._]+$/

videoQuota

integer

required

The user video quota in bytes

Example:

-1

videoQuotaDaily

integer

required

The user daily video quota in bytes

Example:

-1

Examples

Responses

🟢200user created

application/json

Body

user

object

optional

account

object

optional

integer

optional

>= 1

Example:

🟠403insufficient authority to create an admin or moderator

Modified at 2022-09-10 22:29:49

List users

Resend user verification link