Roles

REST API operations for roles

Overview

The /roles REST API operations are in open beta starting with Panther version 1.112, and are available to all customers. Please share any bug reports and feature requests with your Panther support team.

Use these API operations to interact with user roles in Panther.

To call the API, see the How to use the Panther REST API instructions—including directions for how to invoke it directly from this documentation page.

Required permissions

• For GET operations, your API token must have the Read User Info permission.

• For POST and DELETE operations, your API token must have the Manage Users permission.

Operations

Create a role

post

Authorizations

Body

logTypeAccessstring[]optional

The log types that the role can or cannot access, according to the logTypeAccessKind field. This field should be omitted if logTypeAccessKind has a value of ALLOW_ALL or DENY_ALL

logTypeAccessKindstring · enumoptional

Defines the role's access to log types. This field is required and has effect only if the datalake RBAC feature is enabled.

Options: ALLOW, ALLOW_ALL, DENY, DENY_ALL

namestringrequired

The name of the role

permissionsstring · enum[]required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-api-host/roles' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "logTypeAccess": [
      "text"
    ],
    "logTypeAccessKind": "ALLOW",
    "name": "text",
    "permissions": [
      "AlertModify"
    ]
  }'

200

400

200

{
  "createdAt": "text",
  "id": "text",
  "logTypeAccess": [
    "text"
  ],
  "logTypeAccessKind": "ALLOW",
  "name": "text",
  "permissions": [
    "AlertModify"
  ],
  "updatedAt": "text"
}

OK response.

Get a role

get

Authorizations

Path parameters

idstringrequired

ID of the role

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-api-host/roles/{id}' \
  --header 'X-API-Key: YOUR_API_KEY'

200

400

404

200

{
  "createdAt": "text",
  "id": "text",
  "logTypeAccess": [
    "text"
  ],
  "logTypeAccessKind": "ALLOW",
  "name": "text",
  "permissions": [
    "AlertModify"
  ],
  "updatedAt": "text"
}

OK response.

Update a role

post

Authorizations

Path parameters

idstringrequired

ID of the role

Body

logTypeAccessstring[]optional

The log types that the role can or cannot access, according to the logTypeAccessKind field. This field should be omitted if logTypeAccessKind has a value of ALLOW_ALL or DENY_ALL

logTypeAccessKindstring · enumoptional

Defines the role's access to log types. This field is required and has effect only if the datalake RBAC feature is enabled.

Options: ALLOW, ALLOW_ALL, DENY, DENY_ALL

namestringrequired

The name of the role

permissionsstring · enum[]required

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-api-host/roles/{id}' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "logTypeAccess": [
      "text"
    ],
    "logTypeAccessKind": "ALLOW",
    "name": "text",
    "permissions": [
      "AlertModify"
    ]
  }'

200

400

404

200

{
  "createdAt": "text",
  "id": "text",
  "logTypeAccess": [
    "text"
  ],
  "logTypeAccessKind": "ALLOW",
  "name": "text",
  "permissions": [
    "AlertModify"
  ],
  "updatedAt": "text"
}

OK response.

Delete a role

delete

Authorizations

Path parameters

idstringrequired

ID of the role

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://your-api-host/roles/{id}' \
  --header 'X-API-Key: YOUR_API_KEY'

200

400

404

200

No body

OK response.

List roles

get

Authorizations

Query parameters

name-containsstringoptional

A string to search for in the Role name

namestringoptional

An exact match of a role's name to return. If provided all other parameters are ignored

idstring[]optional

Set of IDS to return

idsstringoptional

A comma delimited list of IDs

sort-dirstring · enum · default: "asc"optional

The sort direction of the results

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-api-host/roles' \
  --header 'X-API-Key: YOUR_API_KEY'

200

200

{
  "next": "text",
  "results": [
    {
      "createdAt": "text",
      "id": "text",
      "logTypeAccess": [
        "text"
      ],
      "logTypeAccessKind": "ALLOW",
      "name": "text",
      "permissions": [
        "AlertModify"
      ],
      "updatedAt": "text"
    }
  ]
}

OK response.