OpenBroadcaster Documentation
controllers / users.php

Users

Controller

Manages users more globally. Where the Account controller is used by a single account, the Users controller is for administrating users in a more global way.

public  user_registration_set ( )

Set user registration in the global settings. This is set to 1 (or TRUE) when users can register from the login screen, or to 0 (FALSE) if not. Requires 'manage_users' permission.

Parameters
user_registration
public  user_registration_get ( )

Return the user registration settings.

Returns user_registration
public  user_list ( )

Return a list of all users.

Returns [display_name, id, email]
public  user_manage_list ( )

Return a sorted list of all users with more detailed information. Unlike user_list(), this requires the 'manage_users' permission.

Parameters
sort_col Column to sort by.
sort_desc Whether or not to sort descendingly.
Returns users
public  user_manage_addedit ( )

Update a user. Requires the 'manage_users' permission.

Parameters
id
name
username
email
display_name
enabled
password
password_confirm
group_ids
appkeys
public  user_manage_delete ( )

Delete a user. Requires the 'manager_users' permission.

Parameters
id
public  user_manage_key_new ( )

Generate a new App Key for the user. Done through the addedit modal, and requires the 'manager_users' permission for that reason.

Parameters
id
Returns [id, name, key]
public  user_manage_key_delete ( )

Delete an App Key associated with a user. Done through the addedit modal, and requires the 'manager_users' permission for that reason.

Parameters
id
user_id
Returns is_deleted?
public  user_manage_key_load ( )

Loads all App Keys associated with a user. Done through the addedit modal, and requires the 'manager_uesrs' permission for that reason.

Parameters
id
Returns appkeys
public  group_list ( )

List all groups. Requires 'manage_users' or 'manage_permissions' permissions to show more than the basic set of permissions.

Returns groups
public  permissions_manage_delete ( )

Delete a user permissions group. Requires 'manage_permissions' permission.

Parameters
id
public  permissions_manage_addedit ( )

Edit a user permissions group. Requires 'manage_permissions' permission.

Parameters
name
id
permissions
public  permissions_manage_list ( )

List all permissions by category as well as the permissions linked to each player. Requires 'manage_permissions' permission.

Returns permissions