Models

AddUser

object

usernameusernamerequired

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

Example

chocobozzz

passwordpassword<password>required

emailstring<email>required

The user email

videoQuotainteger

The user video quota in bytes

Example

-1

videoQuotaDailyinteger

The user daily video quota in bytes

Example

-1

channelNameusernameChannel

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

Example

framasoft_videos

roleUserRole012required

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

Example

adminFlagsUserAdminFlags01

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

Example

currentPasswordcurrentPassword

Required to create an administrator, see password confirmation

Show child attributes

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

currentPassword<password>

Example

{
  "username": "chocobozzz",
  "password": "********",
  "email": "user@example.com",
  "videoQuota": -1,
  "videoQuotaDaily": -1,
  "channelName": "framasoft_videos",
  "role": 2,
  "adminFlags": 1
}

Docs by Sourcey