List Permissions

GEThttps://api.confident-ai.com/v2/projects/{projectId}/permissions

Lists every project permission a project policy can grant. Each is named resource:action — dataset:read, golden:create, user:manage — and its id is what you send in a policy's permissionIds.

The list is Confident AI's whole project catalog, not only the permissions this project already uses, and it is returned in no particular order. It is the same catalog for every project in your organization; organization permissions are a separate catalog with its own endpoint.

GET/v2/projects/{projectId}/permissions

curl -X GET "https://api.confident-ai.com/v2/projects/{projectId}/permissions" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>"

200

{
  "success": true,
  "data": {
    "permissions": [
      {
        "id": "<PERMISSION-ID>",
        "name": "user:read",
        "description": null
      }
    ]
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Path parameters

projectIdstringRequired
The id of the project, which must belong to the organization your API key is scoped to.

Response

List Permissions succeeded.

successboolean
Indicates if the request was successful.
dataobject
The complete set of permissions a policy in this scope can grant, taken from Confident AI's own catalog rather than from what your organization happens to use already.
Show 1 propertyHide 1 property
- permissionslist of objects
  Every permission in the catalog for this scope, in no particular order.
  Show 3 propertiesHide 3 properties
  - idstring
    The id of the permission, generated by Confident AI. This is what a policy references in its permissionIds.
  - namestring
    The permission, written as resource:action — the resource it applies to, then what it allows on it. read grants viewing, manage grants creating and updating, and create, update and delete appear where a resource distinguishes them.
  - descriptionstring | null
    What the permission allows, in prose, or null when it has none. Confident AI creates these permissions from its own catalog and does not describe them, so this is null unless someone has filled it in.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI