Roles Object

Defines the schema for configuring a Role.

API Endpoint<https://api.bigpanda.io/resources/v2.1/roles>
Supported MethodsPOST, GET, PUT, DELETE

Parameters

The Roles object schema includes the following attributes:

Attribute

Description

Type

Example

name

The name of the role as seen in the UI.

String

Admin

id

Unique system identifier for the role.

String

60c5238222fa55553d93d52f

users

An array of user IDs associated with the role.

Array

60c5238222fa55553d93d52f

created_by

The unique ID associated with the user who created the role.

String

60c5238222fa55553d93d52f

created_at

The Unix time when the role was created.

Timestamp

1635260171

updated_at

The Unix time when the role was last updated.

Timestamp

1636285660

permissions

A list of permissions associated with the role.

Each permission grants access to a specific resource_type, which is an area in BigPanda. See Roles and Resource Permissions for more information.

Attributes:

resource_id - (Optional) The id of the permission. This field is only necessary when the role grants access to a specific environment. For all other roles, this field should be left blank. See the Environments Roles documentation for more information.

actions - An array of available actions this permission grants Options include: read, full_access, incident_actions (incident_actions is only available for environment type permissions.)

resource_type - The name of the permission type

Array

"permissions": { "resource":"environments", "resource_id":"60c5238222fa63633d93d52f", "actions":[ "read" ]}, { "resource_id": null, "actions": [ "Read" ],"resource_type": "enrichments-jobs" }