Sign in

v1

latestOpenAPI 3.0.0AGPLv3.02026-07-14186117194.3 KB
Users

Create a user

post/api/v1/users

Request body

adminFlags0 | 1

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

channelNamestring

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

emailstring email required

The user email

passwordstring password required
role0 | 1 | 2 required

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

usernamestring required

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

videoQuotainteger required

The user video quota in bytes

videoQuotaDailyinteger required

The user daily video quota in bytes

Example request

{
  "adminFlags": 1,
  "channelName": "framasoft_videos",
  "role": 2,
  "username": "chocobozzz",
  "videoQuota": -1,
  "videoQuotaDaily": -1
}

Response

user created

Example response

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