Skip to main content

ReBAC API Calls

Everything can can be done in the UI, can also be managed directly via the API. Here is a reference to all the ReBAC API calls current available.

Creating resource roles​

The Resource Roles API endpoint lets you manage and query roles associated with specific resources in your application or system.

Base URL​

https://api.permit.io/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles

Example​

curl https://api.permit.io/v2/schema/$permit_project/$permit_env/resources/repo/roles \
  -X POST \
  -H "Authorization: Bearer $permit_sdk_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "maintainer",
    "name": "Maintainer",
    "permissions": ["read", "write"]
  }'

Creating resource relations​

Base URL​

https://api.permit.io/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/relations

Example​

curl https://api.permit.io/v2/schema/$permit_project/$permit_env/resources/file/relations \
  -X POST \
  -H "Authorization: Bearer $permit_sdk_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "parent",
    "name": "Parent",
    "subject_resource": "folder"
  }'

Creating resource instances​

Base URL​

https://api.permit.io/v2/facts/{proj_id}/{env_id}/resource_instances

Example​

curl https://api.permit.io/v2/facts/$permit_project/$permit_env/resource_instances \
  -X POST \
  -H "Authorization: Bearer $permit_sdk_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "resource": "file",
  "key": "2023_report",
  "tenant": "default"
  }'

Assigning roles to users​

Base URL​

Example​

curl https://api.permit.io/v2/facts/$permit_project/$permit_env/role_assignments \
  -X POST \
  -H "Authorization: Bearer $permit_sdk_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "user": "john@acme.com",
    "role": "viewer",
    "resource_instance": "file:2023_report"
  }'

Creating relationship tuples​

Base URL​

https://api.permit.io/v2/facts/{proj_id}/{env_id}/relationship_tuples

Example​

curl https://api.permit.io/v2/facts/$permit_project/$permit_env/relationship_tuples \
  -X POST \
  -H "Authorization: Bearer $permit_sdk_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "subject": "folder:finance",
  "relation": "parent",
  "object": "file:2023_report"
}'

Creating role derivation​

Base URL​

https://api.permit.io/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles/{role_id}/implicit_grants

Example​

curl https://api.permit.io/v2/schema/$permit_project/$permit_env/resources/file/roles/editor \
  -X PATCH \
  -H "Authorization: Bearer $permit_sdk_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "granted_to": {
        "users_with_role": [
            {
                "linked_by_relation": "parent",
                "on_resource": "folder",
                "role": "editor"
            }
        ]
	}
  }'

Contents