HEhexclave
Permissions

List team permission definitions

Changed on

Query and filter the permission with team_id, user_id, and permission_id (the equivalent of listing permissions on the Hexclave dashboard)

get/team-permission-definitions

Request

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

Query parameters

limitinteger

Maximum number of items to return (capped at 200). When set, the response is paginated via cursor.

cursorstring

Cursor (permission id) to start the next page from. Requires limit to also be set.

querystring

Free-text filter applied to permission id and description (case-insensitive).

Response

Successful response

Example response

{
  "items": [
    {
      "id": "read_secret_info",
      "description": "Read secret information",
      "contained_permission_ids": [
        "read_public_info"
      ]
    }
  ],
  "pagination": {
    "next_cursor": "b3d396b8-c574-4c80-97b3-50031675ceb2"
  }
}

Changes

  • ae5572197e85Revision changes
    • breaking

      the response property / became nullable for the status

    • warning

      added the new undefined enum value to the / response property for the response status

  • e0051e78345aRevision changes
    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter query