list_roles
Retrieve a detailed list of roles from Panther instances, including metadata like permissions and settings. Filter by role name, IDs, or sort results to streamline role management and access control.
Instructions
List all roles from your Panther instance.
Returns list of roles with metadata including permissions and settings.
Permissions:{'all_of': ['Read User Info']}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Exact match for a role's name. If provided, other parameters are ignored | |
| name_contains | No | Case-insensitive substring to search for within the role name | |
| role_ids | No | List of specific role IDs to return | |
| sort_dir | No | Sort direction for the results | asc |
Input Schema (JSON Schema)
{
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Exact match for a role's name. If provided, other parameters are ignored",
"examples": [
"Admin",
"PantherReadOnly",
"SecurityAnalyst"
],
"title": "Name"
},
"name_contains": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Case-insensitive substring to search for within the role name",
"examples": [
"Admin",
"Analyst",
"Read"
],
"title": "Name Contains"
},
"role_ids": {
"default": [],
"description": "List of specific role IDs to return",
"examples": [
[
"Admin",
"PantherReadOnly"
],
[
"SecurityAnalyst"
]
],
"items": {
"type": "string"
},
"title": "Role Ids",
"type": "array"
},
"sort_dir": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "asc",
"description": "Sort direction for the results",
"examples": [
"asc",
"desc"
],
"title": "Sort Dir"
}
},
"type": "object"
}