Cattura CaptureCast HTTP API Documentation

User

The User object represents a user account in CaptureCast.

Fields

Note: The terms "object," "array," "string," and "number," refer to JSON data types. The term "boolean" refers to the JSON values true and false. All other type names refer to data types specific to the CaptureCast platform.

Name	Type	Required	Description
id	number	Yes	ID of user.
username	string	Yes	Login name of user.
roles	array of string	Yes	Array of roles held by the user. Each role has certain privileges associated with it. For example, someone with the Presenter role cannot manage users.

JSON Example

{
    "username": "guest",
    "roles": [
        "Administrator"
    ],
    "id": 2
}