Retrieve details for a single current role.

GET

https://demo.azuracast.com/api/admin/role/{id}

curl -X GET 'https://demo.azuracast.com/api/admin/role/0' \
  -H 'X-API-Key: YOUR_TOKEN'

const response = await fetch('https://demo.azuracast.com/api/admin/role/0', {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.azuracast.com/api/admin/role/0',
    headers={
        'X-API-Key': 'YOUR_TOKEN',
    },
)
print(response.text)

{
  "links": {},
  "id": 0,
  "name": "Super Administrator",
  "permissions": {
    "global": [
      "administer all"
    ],
    "station": [
      {
        "id": 0,
        "permissions": [
          "administer all"
        ]
      }
    ]
  },
  "is_super_admin": true
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

Parameters

idinteger<int64>requiredpath

Role ID

Response

200OKHasLinks & object

Success

Response fields application/json

linksobjectread only

Show child attributes

[key: string]string

idintegerread only

namestringrequired

Example

Super Administrator

permissionsApi_Admin_RolePermissions

Show child attributes

globalArray<GlobalPermissions>administer allview administrationview system logsadminister settingsadminister api keysadminister stationsadminister custom fieldsadminister backupsadminister storage locationsrequired

stationArray<Api_Admin_RoleStationPermission>required

Show child attributes

idintegerrequired

The station ID.

permissionsArray<StationPermissions>administer allview station managementview station reportsview station logsmanage station profilemanage station broadcastingmanage station streamersmanage station mountsmanage station remotesmanage station mediadelete station mediamanage station automationmanage station web hooksmanage station podcastsrequired

is_super_adminbooleanread only

Whether this role is the protected “Super Administrator” role.

403ForbiddenApi_Error

Access denied.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

404Not FoundApi_Error

Record not found.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

500Internal Server ErrorApi_Error

A generic exception has occurred.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

Authorization

ApiKeyapiKey in header

Docs by Sourcey