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

Response

Successful Response

Delete Role EndpointDelete a role and all its associations. Removes all user-role memberships and ACL entries for this role, then deletes the role. The authenticated user must be able to manage users in the tenant. ## Path Parameters - **role_id** (UUID): The UUID of the role to delete

⌘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": {}
    }
  ]
}

Documentation Index

Authorizations

Query Parameters

Response