Roles

The Roles API enables you to manage user roles within BigPanda.

The Roles API is a tool to help you manage user roles in the BigPanda system, enabling you to bulk manage even large and complex permissions.

Use the Roles API to create, retrieve, update, and delete roles from the BigPanda UI.

📘

Authentication Necessary

All BigPanda APIs require Bearer Token Authorization in the call headers.

This API uses the User API Key type of Authorization token.

Available Object and Actions

The Roles API provides the following object:

ObjectDescriptionSupported MethodsAPI Endpoint
RolesDefines the schema for configuring a Role.POST, GET, PUT, DELETEhttps://api.bigpanda.io/resources/v2.1/roles

Use the Roles API to perform these actions:

Action

Definition

Description

Create a Role

POST
/resources/v2.1/roles/

Creates a new role

Retrieve All Roles

GET
/resources/v2.1/roles/

Retrieves a list of all roles

Update a Role

PUT
/resources/v2.1/roles/{roleId}

Updates a role by role ID

Delete a Role

DELETE
/resources/v2.1/roles/{roleId}

Deletes a role from the system

Retrieve a Role by ID

GET
/resources/v2.1/roles/{roleId}

Retrieves a role by a specific role ID