permissions

Create Role

Create a new role.

This endpoint creates a new role with the specified name. Roles are used to group permissions and can be assigned to users to manage access control more efficiently. The authenticated user becomes the owner of the created role.

Request Parameters

role_name (str): The name of the role to create

Response

Returns a success message indicating the role was created.

Error Codes

400 Bad Request: Invalid role name or role already exists
500 Internal Server Error: Error creating the role

POST

api

permissions

roles

Create Role

curl --request POST \
  --url https://api.cognee.ai/api/v1/permissions/roles \
  --header 'Authorization: Bearer <token>'

{
  "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.

Query Parameters

role_name

string

required

Name of the role to create. Must be unique within the caller's tenant.

Example:

"engineering"

Response

Successful Response

⌘I

Create Role

curl --request POST \
  --url https://api.cognee.ai/api/v1/permissions/roles \
  --header 'Authorization: Bearer <token>'

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

Getting Started

auth

add

cognify

memify

search

permissions

datasets

ontologies

settings

visualize

schema

skills

configuration

delete

update

responses

llm

sync

users

checks

health

agent management

agent connections

activity

sessions

remember

recall

improve

forget

slack

integrations

Create Role

Request Parameters

Response

Error Codes

Authorizations

Query Parameters

Response