/permissions

Returns all public permissions grouped by category. Useful for discovering which permission IDs to assign when creating an API key.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

List Available Permissions

Use this route to retrieve all available public permissions, organized by category. This is especially useful when creating API keys via POST /api-key, as it lets you discover which permission IDs to include in the permissions array.

How to use

Send a GET request to /permissions. You can optionally set the dadosfera-lang header to control the language of the permission names:

  • pt-br (default): Portuguese
  • en-us: English

Response example

{
  "permissionGroups": [
    {
      "title": "Authentication",
      "permissions": [
        { "id": 46, "name": "Generate Access Token" }
      ]
    },
    {
      "title": "Collect | Pipelines",
      "permissions": [
        { "id": 23, "name": "Create pipelines" },
        { "id": 13, "name": "Get pipelines" },
        { "id": 29, "name": "Update pipeline" },
        { "id": 5, "name": "Delete pipeline" }
      ]
    },
    {
      "title": "Collect | Data Sources",
      "permissions": [
        { "id": 14, "name": "Get connections" },
        { "id": 24, "name": "Create connections" }
      ]
    }
  ]
}

Each group contains a title and an array of permissions. Use the id field when assigning permissions to an API key.

Error scenarios

CodeErrorDescription
401UnauthenticatedInvalid or missing access-token header
500Internal Server ErrorUnknown server error
Headers
string
enum

Response language. Defaults to pt-br.

Allowed:
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json