DocsAPI ReferenceRelease Notes
API Reference
BigPanda AppRequest DemoBigPanda UniversityBigPanda Community

Create a Role

post https://api.bigpanda.io/resources/v2.1/roles

Creates a new role

⚠

️

The resource_id field within the permissions array is only necessary when the role grants access to a specific environment. For all other permission types, this field should be omitted.

To find the resource_id, run a Retrieve all Roles call.

📘

The resource_type field is the name of the permission, without the access level. For example, roles rather than roles_read.

For a list of available permission types, see the Roles Management documentation.

For information about finding the resource_type at the environment level, see the Granular Environment Permissions documentation.

📘

System fields (id, created_by, created_at, and updated_at) will be set automatically. If included in the Create payload, these fields will be discarded.

Sample Call

curl --request POST \
     --url https://api.bigpanda.io/resources/v2.1/roles \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer <User API Key>' \
     --header 'Content-Type: application/json' \
     --data '
{
    "name": "Test Role",
    "users": [
    "60c5238222fa63633d935555"
    ],
    "permissions": [
          {
               "resource_type": "environments",
               "resource_id": "624e114fb4d7581100179111",
               "actions": "read"
          },
          {
               "resource_type": "users",
               "actions": "read"
          }
     ]
}
'

curl --request POST \
     --url https://eu-api.bigpanda.io/resources/v2.1/roles \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer <User API Key>' \
     --header 'Content-Type: application/json' \
     --data '
{
    "name": "Test Role",
    "users": [
    "60c5238222fa63633d935555"
    ],
    "permissions": [
          {
               "resource_type": "environments",
               "resource_id": "624e114fb4d7581100179111",
               "actions": "read"
          },
          {
               "resource_type": "users",
               "actions": "read"
          }
     ]
}
'
Language