OpenBroadcaster Documentation
controllers / account.php

Account

Controller

Manages everything account related. Covers logging and logging out, permissions, groups, account settings, creating new accounts, and recovering passwords. Specifically to be used by individual accounts; for managing lists of permissions, users, and groups, use the Users controller.

public  login ( )

Login using the provided username and password.

Parameters
username
password
Returns [id, key, key_expiry]
public  uid ( )

Return currently logged in username and user id.

Returns [id, username]
public  permissions ( )

Return currently logged in user permissions.

Returns permission_array
public  groups ( )

Return currently logged in user groups.

Returns group_names_array
public  logout ( )

Logout currently logged in user.

public  settings ( )

Return userdata (except for sensitive information) for currently logged in user.

Returns user_fields_array
public  update_settings ( )

Update currently logged in user settings.

Parameters
name
password
password_again
email
display_name
language
theme
dyslexia_friendly_font Boolean set to TRUE for using a dyslexia-friendly font.
sidebar_display_left Boolean set to TRUE when displaying the sidebar on the left side.
public  forgotpass ( )

Send message to provided email to aid in recovering account with forgotten password.

Parameters
email
public  newaccount ( )

Create a new account using the provided fields if user registration is currently enabled, and all the fields are validated.

Parameters
name
email
username
public  key_new ( )

Generate a new App Key for the logged in user. Requires the 'manage_appkeys' permission. Connects to the users model.

Returns [id, name, key]
public  key_delete ( )

Delete App Key for currently logged in user. Requires 'manage_appkeys' permission. Connects to users model.

Parameters
id
Returns is_deleted?
public  key_permissions_save ( )

Save App Key permissions. Requires 'manage_appkeys' permission. Connects to users model.

Parameters
id
permissions
public  key_load ( )

Load App Keys for currently logged in user. Requires 'manage_appkeys' permission. Connects to users model.

Returns appkeys