List Permissions

Get all available permissions in the system.

GET /api/v1/permissions

Typescript (SDK)

TypeScript

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.permissions.list();

  console.log(result);
}

run();

200

[
  {
    "name": "<string>",
    "description": "<string>",
    "permissions": [
      {
        "name": "<string>",
        "display_name": "<string>",
        "description": "Fetch agent information"
      }
    ]
  }
]

Authorizations

Syllable-API-Key · string · header · required

Response

200 - application/json

Successful Response

name · string · required

Name of the permission group

Example:

"Agents"

description · string · required

Description of the permission group

Example:

"View agents, create and edit agent configurations, and delete agents."

permissions · PermissionResponse · object[] · required

Permissions in the group

Show child attributes