HEhexclave
Permissions

Create a new project permission definition

Create a new project permission definition (the equivalent of creating a new permission on the Hexclave dashboard)

post/project-permission-definitions

Request

  • Base URL
    https://api.hexclave.com/api/v1
  • URL
    https://api.hexclave.com/api/v1/project-permission-definitions
  • Auth
    none declared

Request body

idstring required

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"
  ]
}

Changes

No recorded changes to this operation across all 29 revisions of this API.