---
title: "Get permissions for a role"
method: GET
path: "/api/roles/{id}/perms"
tags: ["Roles"]
---

# Get permissions for a role

`GET /api/roles/{id}/perms`

## Request

- Base URL: `https://app.cotool.ai`
- URL: `https://app.cotool.ai/api/roles/{id}/perms`
- Auth: HTTP bearer

Get the permissions for a specific role

## Path parameters

- `id` string, required

## Response `200`

Successful response

- object
  - `perms` union[], required
    - union
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'agent.create', required
      - object
        - `resource` union, required
          - object
            - `type` 'all', required
          - object
            - `type` 'specific', required
            - `id` string, required
          - object
            - `type` 'allExcept', required
            - `ids` string[], required
        - `action` 'agent.read', required
      - object
        - `resource` union, required
          - object
            - `type` 'all', required
          - object
            - `type` 'specific', required
            - `id` string, required
          - object
            - `type` 'allExcept', required
            - `ids` string[], required
        - `action` 'agent.execute', required
      - object
        - `resource` union, required
          - object
            - `type` 'all', required
          - object
            - `type` 'specific', required
            - `id` string, required
          - object
            - `type` 'allExcept', required
            - `ids` string[], required
        - `action` 'agent.edit', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'detection.create', required
      - object
        - `resource` union, required
          - object
            - `type` 'all', required
          - object
            - `type` 'specific', required
            - `id` string, required
          - object
            - `type` 'allExcept', required
            - `ids` string[], required
        - `action` 'detection.read', required
      - object
        - `resource` union, required
          - object
            - `type` 'all', required
          - object
            - `type` 'specific', required
            - `id` string, required
          - object
            - `type` 'allExcept', required
            - `ids` string[], required
        - `action` 'detection.execute', required
      - object
        - `resource` union, required
          - object
            - `type` 'all', required
          - object
            - `type` 'specific', required
            - `id` string, required
          - object
            - `type` 'allExcept', required
            - `ids` string[], required
        - `action` 'detection.edit', required
      - object
        - `resource` union, required
          - object
            - `type` 'all', required
          - object
            - `type` 'specific', required
            - `id` string, required
          - object
            - `type` 'allExcept', required
            - `ids` string[], required
        - `action` 'tool.use', required
      - object
        - `resource` union, required
          - object
            - `type` 'all', required
          - object
            - `type` 'specific', required
            - `id` string, required
          - object
            - `type` 'allExcept', required
            - `ids` string[], required
        - `action` 'tool.read', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'tool.manage', required
      - object
        - `resource` union, required
          - object
            - `type` 'all', required
          - object
            - `type` 'specific', required
            - `id` string, required
          - object
            - `type` 'allExcept', required
            - `ids` string[], required
        - `action` 'cli.read', required
      - object
        - `resource` union, required
          - object
            - `type` 'all', required
          - object
            - `type` 'specific', required
            - `id` string, required
          - object
            - `type` 'allExcept', required
            - `ids` string[], required
        - `action` 'cli.use', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'cli.manage', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'chat.manage', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'alert.triage', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'alert.manage', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'billing.read', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'setting.perms.manage', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'setting.users.update', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'setting.users.invite', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'setting.users.delete', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'setting.apiKey.manage', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'setting.auditLog.read', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'setting.customModel.manage', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'setting.auth.manage', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'setting.tags.manage', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'setting.sandbox.manage', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'setting.suggestions.manage', required
      - object
        - `resource` object, required
          - `type` 'all', required
        - `action` 'setting.agents.manage', required

## Other responses

- `400`: Bad request — input validation failed or the request was malformed
- `401`: Unauthorized — missing or invalid API key / session
- `403`: Forbidden — the authenticated user lacks the required permissions
- `500`: Internal server error

---

[API](https://skmtc.dev/cotool/apis/cotool-api.md) - [All operations](https://skmtc.dev/cotool/apis/cotool-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cotool/apis/cotool-api/revisions/f5abe0add203?raw)