View roles and invite users to roles
A list of all roles
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST
Accept: application/json
RESPONSE
200 (OK)
{
"roles": [
{
"id": 2,
"name": "Admin",
"auth_token": "<MY_AUTH_TOKEN>",
"can_create_players": true,
"can_edit_players": true,
"can_edit_player_style_and_restrictions": true,
"can_view_billing": true,
"can_invite_users": true,
"can_access_analytics": true,
"can_create_roles": true,
"can_push_to_youtube": true,
"can_invite_child_account_users": true,
"can_create_child_accounts": true
},
{
"id": 3,
"name": "User",
"auth_token": "<MY_AUTH_TOKEN>",
"can_create_players": true,
"can_edit_players": false,
"can_edit_player_style_and_restrictions": true,
"can_view_billing": false,
"can_invite_users": false,
"can_access_analytics": true,
"can_create_roles": false,
"can_push_to_youtube": false,
"can_invite_child_account_users": false,
"can_create_child_accounts": false
}
],
"summary": {
"page": 1,
"per_page": 15,
"count": 2
}
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
per_page optional |
The number of items to show per page Validations:
|
|
page optional |
The page number to include in the response Validations:
|
Get a role within the current organization by id
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST
Accept: application/json
RESPONSE
200 (OK)
{
"id": 2,
"name": "Admin",
"auth_token": "<MY_AUTH_TOKEN>",
"can_create_players": true,
"can_edit_players": true,
"can_edit_player_style_and_restrictions": true,
"can_view_billing": true,
"can_invite_users": true,
"can_access_analytics": true,
"can_create_roles": true,
"can_push_to_youtube": true,
"can_invite_child_account_users": true,
"can_create_child_accounts": true
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
Get the role associated with the current auth token
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST
Accept: application/json
RESPONSE
200 (OK)
{
"id": 2,
"name": "Admin",
"auth_token": "<MY_AUTH_TOKEN>",
"can_create_players": true,
"can_edit_players": true,
"can_edit_player_style_and_restrictions": true,
"can_view_billing": true,
"can_invite_users": true,
"can_access_analytics": true,
"can_create_roles": true,
"can_push_to_youtube": true,
"can_invite_child_account_users": true,
"can_create_child_accounts": true
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|