Models

RegisterUser

object

usernameusernamerequired

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

Show child attributes

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

Example

chocobozzz

passwordpassword<password>required

emailstring<email>required

email of the user, used for login or service communications

displayNamestring

editable name of the user, displayed in its representations

channelobject

channel base information used to create the first channel of the user

Show child attributes

nameusernameChannel

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

Example

framasoft_videos

displayNamestring

signupClientstringpeertube-app

PeerTube >= 9.0 Client used to sign up. If set, links of the verification and registration accepted emails make the web client propose to open this client

Example

{
  "password": "********",
  "email": "user@example.com",
  "displayName": "string",
  "channel": {
    "name": "framasoft_videos",
    "displayName": "string"
  },
  "signupClient": "peertube-app"
}

Docs by Sourcey