HEhexclave
Permissions

List team permissions

Changed on

List team permissions of the current user. user_id=me must be set for client requests. Note that this might contain the permissions with the same permission ID across different teams. (team_id, user_id, permission_id) together uniquely identify a permission.

get/team-permissions

Request

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

Query parameters

team_idstring

Filter with the team ID. If set, only the permissions of the members in a specific team will be returned.

Example:cce084a3-28b7-418e-913e-c8ee6d802ea4
user_idstring

Filter with the user ID. If set, only the permissions this user has will be returned. Client request must set user_id=me

Example:me
permission_idstring

Filter with the permission ID. If set, only the permissions with this specific ID will be returned

Example:16399452-c4f3-4554-8e44-c2d67bb60360
recursive'true' | 'false'

Whether to list permissions recursively. If set to false, only the permission the users directly have will be listed. If set to true all the direct and indirect permissions will be listed.

Example:true

Response

Successful response

Example response

{
  "items": [
    {
      "id": "read_secret_info",
      "user_id": "3241a285-8329-4d69-8f3d-316e08cf140c",
      "team_id": "ad962777-8244-496a-b6a2-e0c6a449c79e"
    }
  ],
  "pagination": {
    "next_cursor": "b3d396b8-c574-4c80-97b3-50031675ceb2"
  }
}

Changes

  • fc669d833a13Revision 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

  • f135fd8ca8b4Revision changes
    • breaking

      the query request parameter recursive was restricted to a list of enum values

    • info

      added the new enum value false to the query request parameter recursive

    • info

      added the new enum value true to the query request parameter recursive