List Admin Roles

An overview of the List Admin Roles endpoint

Endpoint Description

The List Admin Roles endpoint provides the list of roles and their descriptions that can be assigned to admins. These roles determine the admins permissions within R1 Discover.

HTTP Method

GET /api/v2/admins/roles

Request

Headers:

• Content-Type: application/json - Specifies that the request body format is JSON.

• Accept: application/json - Indicates that the client expects a JSON response.

• Authorization: Bearer {token} - A valid Bearer token must be provided to authenticate the request.

Request Examples

Bash

curl --request GET \
    --get "https://api.r1learning.com/api/v2/admins/roles" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"

JavaScript

const url = new URL(
    "https://api.r1learning.com/api/v2/admins/roles"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer {token}",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

C# - Http

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.r1learning.com/api/v2/admins/roles");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer {token}");
var content = new StringContent(string.Empty);
content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Response

Meta:

Each List endpoint will contain a meta element which will describe the returned package. In this endpoint, the meta will provide the following information:

• total_items (Integer): The number of admin roles returned

• total pages (integer): The number of pages returned in the call to the endpoint. (Total Items / per_page limit)

• current_page (integer): Indicates the current page number of the results

• per_page (integer): Indicates the number of results (topics) that will be listed on a single page. The default is 50, the limit is 100.

Data Dictionary:

• name (string): Name of the admin role.

• description (string): The description of the admin role

Response Examples

200: OK

{
    "meta": {
        "total_items": 4,
        "total_pages": 1,
        "current_page": 1,
        "per_page": 50
    },
    "admin_roles": [
        {
            "name": "Admin",
            "description": "View, Edit, and Create Users at same Program & Location"
        },
        {
            "name": "Admin-Read",
            "description": "View (not Edit) Users at same Program & Location"
        },
        {
            "name": "Lead Admin",
            "description": "View, Edit, and Create Admins and Users at same Program & Location"
        },
        {
            "name": "Lead Admin - Read",
            "description": "View (not Edit) Admins and Users at same Program & Location"
        }
    ]
} 

401: Unauthorized

{
    "error": 1,
    "message": "Unauthenticated",
    "details": "Authentication is required to access this resource."
}

403: Unauthorized

{
    "error": 1,
    "message": "Unauthorized",
    "details": "You do not have the necessary permissions to perform this action."
}

Postman Link

https://www.postman.com/fbomher/r1-discover-api/request/m9pvo1e/list-admin-roleswww.postman.com

Link to the endpoint in Postman

Notes

• Authorization Required: Ensure the provided Bearer token is valid and has sufficient privileges to access the endpoint.