Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Condition Set Rules

Assign Set Permissions

Grant permissions to a user set on a resource set.

If the permission is already granted, it is skipped.

post/v2/facts/{proj_id}/{env_id}/set_rules

Path parameters

proj_idstring required

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

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").

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

Request body

user_setstring required

The userset that will be given permission, i.e: all the users matching this rule will be given the specified permission

permissionstring required

The permission that will be granted to the userset on the resourceset. The permission can be either a resource action id, or {resource_key}:{action_key}, i.e: the "permission name".

resource_setstring required

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

is_roleboolean

if True, will set the condition set rule to the role's autogen user-set.

is_resourceboolean

if True, will set the condition set rule to the resource's autogen resource-set.

Example request

{
  "user_set": "us_based_employees",
  "permission": "repository:clone",
  "resource_set": "private_repos"
}

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