PEpermit
Condition Set Rules

List Set Permissions

Lists the condition set rules matching the filter.

  • If the user_set filter is present, will only return the permissions set of that user set.
  • If the permission filter is present, will only return the permissions sets that equals to the queried permission.
  • If the resource_set filter is present, will only return the permissions set of that resource set.
get/v2/facts/{proj_id}/{env_id}/set_rules

Request

  • Base URL
    https://api.permit.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Query parameters

user_setstring

optional user set filter, will only return rules where the permission is granted to this user set

permissionstring

optional permission filter, will only return condition set rules granting this permission

resource_setstring

optional resource set filter, will only return rules where the permission is granted on this resource set

pageinteger

Page number of the results to fetch, starting at 1.

per_pageinteger

The number of results per page (max 100).

Response

Successful Response

idstring uuid required

Unique id of the condition set rule

keystring required

A unique id by which Permit will identify this condition set rule.

user_setstring required

the userset that is currently granted permissions, i.e: all the users matching this rule are granted the permission on the resourceset

permissionstring required

a permission that is currently granted to the userset on the resourceset.

resource_setstring required

the resourceset that represents the resources that are currently granted for access, i.e: all the resources matching this rule can be accessed by the userset to perform the granted permission

organization_idstring uuid required

Unique id of the organization that the condition set rule belongs to.

project_idstring uuid required

Unique id of the project that the condition set rule belongs to.

environment_idstring uuid required

Unique id of the environment that the condition set rule belongs to.

created_atstring date-time required

Date and time when the condition set rule was created (ISO_8601 format).

updated_atstring date-time required

Date and time when the condition set rule was last updated/modified (ISO_8601 format).

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "key": "us_based_employees_can_repository_clone_private_repos",
    "user_set": "us_based_employees",
    "permission": "repository:clone",
    "resource_set": "private_repos",
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
    "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:16:22Z"
  }
]

Changes

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