controllers / users.phpUsers
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
group_list
(
)
public
group_list
(
)
List all groups. Requires 'manage_users' or 'manage_permissions' permissions to show more than the basic set of permissions.
groups
GET
/api/v2/users/groups
public
permissions_manage_addedit
(
)
public
permissions_manage_addedit
(
)
Edit or create a new user permissions group. Requires 'manage_permissions' permission.
name |
|
id |
|
permissions |
PUT
/api/v2/users/permissions/(:id:)
public
permissions_manage_delete
(
)
public
permissions_manage_delete
(
)
Delete a user permissions group. Requires 'manage_permissions' permission.
id |
DELETE
/api/v2/users/permissions/(:id:)
public
permissions_manage_list
(
)
public
permissions_manage_list
(
)
List all permissions by category as well as the permissions linked to each player. Requires 'manage_permissions' permission.
permissions
GET
/api/v2/users/permissions
public
user_list
(
)
public
user_list
(
)
Return a list of all users.
[display_name, id, email]
GET
/api/v2/users/all
public
user_manage_addedit
(
)
public
user_manage_addedit
(
)
Update or save a new user. Requires the 'manage_users' permission.
id |
|
name |
|
username |
|
email |
|
display_name |
|
enabled |
|
password |
|
password_confirm |
|
group_ids |
|
appkeys |
PUT
/api/v2/users/(:id:)
public
user_manage_delete
(
)
public
user_manage_delete
(
)
Delete a user. Requires the 'manager_users' permission.
id |
DELETE
/api/v2/users/(:id:)
public
user_manage_key_delete
(
)
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.
id |
|
user_id |
is_deleted?
DELETE
/api/v2/users/appkeys/(:user_id:)/(:id:)
public
user_manage_key_load
(
)
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.
id |
appkeys
GET
/api/v2/users/appkeys/(:id:)
public
user_manage_key_new
(
)
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.
id |
[id, name, key]
POST
/api/v2/users/appkeys
public
user_manage_list
(
)
public
user_manage_list
(
)
Return a sorted list of all users with more detailed information. Unlike user_list(), this requires the 'manage_users' permission.
sort_col |
Column to sort by. |
sort_desc |
Whether or not to sort descendingly. |
users
GET
/api/v2/users
public
user_registration_get
(
)
public
user_registration_get
(
)
Return the user registration settings.
user_registration
GET
/api/v2/users/can-register
public
user_registration_set
(
)
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.
user_registration |
PUT
/api/v2/users/can-register