Sign in

v21

OpenAPI 3.1.0raw.githubusercontent.com2026-08-011060456.0 KB
Permissions

Update a team permission definition

Update a permission definition (the equivalent of updating a permission on the Hexclave dashboard)

patch/team-permission-definitions/{permission_id}

Path parameters

permission_idstring required

The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, :, and _ characters, or one of the system permissions: $update_team, $delete_team, $read_members, $remove_members, $invite_members, $manage_api_keys

Example:read_secret_info

The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, :, and _ characters, or one of the system permissions: $update_team, $delete_team, $read_members, $remove_members, $invite_members, $manage_api_keys

Request body

idstring

The permission ID used to uniquely identify a permission. Can only contain lowercase letters, numbers, ":", and "_" characters

descriptionstring

A human-readable description of the permission

contained_permission_idsstring[]

The IDs of the permissions that are contained in this permission

Example request

{
  "id": "read_secret_info",
  "description": "Read secret information",
  "contained_permission_ids": [
    "read_public_info"
  ]
}

Response

Successful response

idstring required

The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, :, and _ characters, or one of the system permissions: $update_team, $delete_team, $read_members, $remove_members, $invite_members, $manage_api_keys

descriptionstring

A human-readable description of the permission

contained_permission_idsstring[] required

The IDs of the permissions that are contained in this permission

Example response

{
  "id": "read_secret_info",
  "description": "Read secret information",
  "contained_permission_ids": [
    "read_public_info"
  ]
}