permissions

Get Principal Datasets

List the datasets a principal holds a permission on.

A principal is a user, a role or a tenant. What the caller may ask about depends on which: themselves or any user if they can manage users; a role of this tenant they belong to, or any of its roles if they can manage users; and only the tenant they are currently in. Results are always narrowed to the caller’s current tenant.

Path Parameters

principal_id (UUID): The principal UUID — a user, role or tenant.

Request Parameters

permission_name (str): Permission to list. Defaults to “read”.

Response

Returns a JSON list of dataset objects the principal has that permission on.

Error Codes

403 Forbidden: Caller may not ask about this principal
404 Not Found: Principal does not exist in the caller’s tenant

GET

api

permissions

principals

{principal_id}

datasets

Get Principal Datasets

curl --request GET \
  --url https://api.cognee.ai/api/v1/permissions/principals/{principal_id}/datasets \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cognee.ai/api/v1/permissions/principals/{principal_id}/datasets"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

principal_id

string<uuid>

required

Query Parameters

permission_name

string

default:read

Permission to read back. One of 'read', 'write', 'delete', 'share'.

Example:

"read"

Response

Successful Response

⌘I

Get Principal Datasets

curl --request GET \
  --url https://api.cognee.ai/api/v1/permissions/principals/{principal_id}/datasets \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cognee.ai/api/v1/permissions/principals/{principal_id}/datasets"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}