Permitio API

Permit.io API

API version: 2.0.0

Auth

Bearer bearer

Base URL

Not specified.

Setup

1. Set Authorization header with your Bearer token
2. GET /v2/members/me -- verify access
3. POST /v2/members -- create first members

Endpoints

258 endpoints across 14 groups. See references/api-spec.lap for full details.

members

api-key

orgs

projects

schema

facts

pdps

elements

deprecated

history

activity

policy_guards

audit-log-replay

internal

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all me?" -> GET /v2/members/me
• "List all members?" -> GET /v2/members
• "Create a member?" -> POST /v2/members
• "Get member details?" -> GET /v2/members/{member_id}
• "Delete a member?" -> DELETE /v2/members/{member_id}
• "Partially update a member?" -> PATCH /v2/members/{member_id}
• "Get api-key details?" -> GET /v2/api-key/{proj_id}/{env_id}
• "List all scope?" -> GET /v2/api-key/scope
• "List all api-key?" -> GET /v2/api-key
• "Create a api-key?" -> POST /v2/api-key
• "Get api-key details?" -> GET /v2/api-key/{api_key_id}
• "Delete a api-key?" -> DELETE /v2/api-key/{api_key_id}
• "Create a rotate-secret?" -> POST /v2/api-key/{api_key_id}/rotate-secret
• "Search orgs?" -> GET /v2/orgs
• "Create a org?" -> POST /v2/orgs
• "Get org details?" -> GET /v2/orgs/{org_id}
• "Delete a org?" -> DELETE /v2/orgs/{org_id}
• "Partially update a org?" -> PATCH /v2/orgs/{org_id}
• "List all org?" -> GET /v2/orgs/active/org
• "List all stats?" -> GET /v2/orgs/{org_id}/stats
• "List all invites?" -> GET /v2/orgs/{org_id}/invites
• "Create a invite?" -> POST /v2/orgs/{org_id}/invites
• "Delete a invite?" -> DELETE /v2/orgs/{org_id}/invites/{invite_id}
• "List all projects?" -> GET /v2/projects
• "Create a project?" -> POST /v2/projects
• "Get project details?" -> GET /v2/projects/{proj_id}
• "Delete a project?" -> DELETE /v2/projects/{proj_id}
• "Partially update a project?" -> PATCH /v2/projects/{proj_id}
• "List all stats?" -> GET /v2/projects/{proj_id}/envs/{env_id}/stats
• "List all envs?" -> GET /v2/projects/{proj_id}/envs
• "Create a env?" -> POST /v2/projects/{proj_id}/envs
• "Get env details?" -> GET /v2/projects/{proj_id}/envs/{env_id}
• "Delete a env?" -> DELETE /v2/projects/{proj_id}/envs/{env_id}
• "Partially update a env?" -> PATCH /v2/projects/{proj_id}/envs/{env_id}
• "Create a copy?" -> POST /v2/projects/{proj_id}/envs/{env_id}/copy
• "Create a async?" -> POST /v2/projects/{proj_id}/envs/{env_id}/copy/async
• "List all result?" -> GET /v2/projects/{proj_id}/envs/{env_id}/copy/async/{task_id}/result
• "Create a test_jwk?" -> POST /v2/projects/{proj_id}/envs/{env_id}/test_jwks
• "Search condition_sets?" -> GET /v2/schema/{proj_id}/{env_id}/condition_sets
• "Create a condition_set?" -> POST /v2/schema/{proj_id}/{env_id}/condition_sets
• "Get condition_set details?" -> GET /v2/schema/{proj_id}/{env_id}/condition_sets/{condition_set_id}
• "Delete a condition_set?" -> DELETE /v2/schema/{proj_id}/{env_id}/condition_sets/{condition_set_id}
• "Partially update a condition_set?" -> PATCH /v2/schema/{proj_id}/{env_id}/condition_sets/{condition_set_id}
• "List all ancestors?" -> GET /v2/schema/{proj_id}/{env_id}/condition_sets/{condition_set_id}/ancestors
• "List all descendants?" -> GET /v2/schema/{proj_id}/{env_id}/condition_sets/{condition_set_id}/descendants
• "Create a implicit_grant?" -> POST /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles/{role_id}/implicit_grants
• "List all action_groups?" -> GET /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/action_groups
• "Create a action_group?" -> POST /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/action_groups
• "Get action_group details?" -> GET /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/action_groups/{action_group_id}
• "Delete a action_group?" -> DELETE /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/action_groups/{action_group_id}
• "Partially update a action_group?" -> PATCH /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/action_groups/{action_group_id}
• "List all actions?" -> GET /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/actions
• "Create a action?" -> POST /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/actions
• "Get action details?" -> GET /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/actions/{action_id}
• "Delete a action?" -> DELETE /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/actions/{action_id}
• "Partially update a action?" -> PATCH /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/actions/{action_id}
• "List all attributes?" -> GET /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/attributes
• "Create a attribute?" -> POST /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/attributes
• "Get attribute details?" -> GET /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/attributes/{attribute_id}
• "Delete a attribute?" -> DELETE /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/attributes/{attribute_id}
• "Partially update a attribute?" -> PATCH /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/attributes/{attribute_id}
• "List all relations?" -> GET /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/relations
• "Create a relation?" -> POST /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/relations
• "Get relation details?" -> GET /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/relations/{relation_id}
• "Delete a relation?" -> DELETE /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/relations/{relation_id}
• "List all roles?" -> GET /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles
• "Create a role?" -> POST /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles
• "Get role details?" -> GET /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles/{role_id}
• "Delete a role?" -> DELETE /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles/{role_id}
• "Partially update a role?" -> PATCH /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles/{role_id}
• "Create a permission?" -> POST /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles/{role_id}/permissions
• "List all ancestors?" -> GET /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles/{role_id}/ancestors
• "List all descendants?" -> GET /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles/{role_id}/descendants
• "Search resources?" -> GET /v2/schema/{proj_id}/{env_id}/resources
• "Create a resource?" -> POST /v2/schema/{proj_id}/{env_id}/resources
• "Get resource details?" -> GET /v2/schema/{proj_id}/{env_id}/resources/{resource_id}
• "Update a resource?" -> PUT /v2/schema/{proj_id}/{env_id}/resources/{resource_id}
• "Delete a resource?" -> DELETE /v2/schema/{proj_id}/{env_id}/resources/{resource_id}
• "Partially update a resource?" -> PATCH /v2/schema/{proj_id}/{env_id}/resources/{resource_id}
• "Search roles?" -> GET /v2/schema/{proj_id}/{env_id}/roles
• "Create a role?" -> POST /v2/schema/{proj_id}/{env_id}/roles
• "Get role details?" -> GET /v2/schema/{proj_id}/{env_id}/roles/{role_id}
• "Delete a role?" -> DELETE /v2/schema/{proj_id}/{env_id}/roles/{role_id}
• "Partially update a role?" -> PATCH /v2/schema/{proj_id}/{env_id}/roles/{role_id}
• "Create a permission?" -> POST /v2/schema/{proj_id}/{env_id}/roles/{role_id}/permissions
• "List all ancestors?" -> GET /v2/schema/{proj_id}/{env_id}/roles/{role_id}/ancestors
• "List all descendants?" -> GET /v2/schema/{proj_id}/{env_id}/roles/{role_id}/descendants
• "List all attributes?" -> GET /v2/schema/{proj_id}/{env_id}/users/attributes
• "Create a attribute?" -> POST /v2/schema/{proj_id}/{env_id}/users/attributes
• "Get attribute details?" -> GET /v2/schema/{proj_id}/{env_id}/users/attributes/{attribute_id}
• "Delete a attribute?" -> DELETE /v2/schema/{proj_id}/{env_id}/users/attributes/{attribute_id}
• "Partially update a attribute?" -> PATCH /v2/schema/{proj_id}/{env_id}/users/attributes/{attribute_id}
• "Search direct?" -> GET /v2/schema/{proj_id}/{env_id}/groups/direct
• "Get direct details?" -> GET /v2/schema/{proj_id}/{env_id}/groups/direct/{group_instance_key}
• "List all children?" -> GET /v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/children
• "List all parents?" -> GET /v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/parents
• "List all users?" -> GET /v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/users
• "List all roles?" -> GET /v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/roles
• "Create a role?" -> POST /v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/roles
• "Get group details?" -> GET /v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}
• "Delete a group?" -> DELETE /v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}
• "Search groups?" -> GET /v2/schema/{proj_id}/{env_id}/groups
• "Create a group?" -> POST /v2/schema/{proj_id}/{env_id}/groups
• "Update a user?" -> PUT /v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/users/{user_id}
• "Delete a user?" -> DELETE /v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/users/{user_id}
• "Search users?" -> GET /v2/facts/{proj_id}/{env_id}/users
• "Create a user?" -> POST /v2/facts/{proj_id}/{env_id}/users
• "Get user details?" -> GET /v2/facts/{proj_id}/{env_id}/users/{user_id}
• "Update a user?" -> PUT /v2/facts/{proj_id}/{env_id}/users/{user_id}
• "Delete a user?" -> DELETE /v2/facts/{proj_id}/{env_id}/users/{user_id}
• "Partially update a user?" -> PATCH /v2/facts/{proj_id}/{env_id}/users/{user_id}
• "Create a role?" -> POST /v2/facts/{proj_id}/{env_id}/users/{user_id}/roles
• "Search users?" -> GET /v2/facts/{proj_id}/{env_id}/tenants/{tenant_id}/users
• "Create a user?" -> POST /v2/facts/{proj_id}/{env_id}/tenants/{tenant_id}/users
• "Search tenants?" -> GET /v2/facts/{proj_id}/{env_id}/tenants
• "Create a tenant?" -> POST /v2/facts/{proj_id}/{env_id}/tenants
• "Get tenant details?" -> GET /v2/facts/{proj_id}/{env_id}/tenants/{tenant_id}
• "Delete a tenant?" -> DELETE /v2/facts/{proj_id}/{env_id}/tenants/{tenant_id}
• "Partially update a tenant?" -> PATCH /v2/facts/{proj_id}/{env_id}/tenants/{tenant_id}
• "Delete a user?" -> DELETE /v2/facts/{proj_id}/{env_id}/tenants/{tenant_id}/users/{user_id}
• "List all detailed?" -> GET /v2/facts/{proj_id}/{env_id}/role_assignments/detailed
• "List all role_assignments?" -> GET /v2/facts/{proj_id}/{env_id}/role_assignments
• "Create a role_assignment?" -> POST /v2/facts/{proj_id}/{env_id}/role_assignments
• "Create a bulk?" -> POST /v2/facts/{proj_id}/{env_id}/role_assignments/bulk
• "List all set_rules?" -> GET /v2/facts/{proj_id}/{env_id}/set_rules
• "Create a set_rule?" -> POST /v2/facts/{proj_id}/{env_id}/set_rules
• "Search detailed?" -> GET /v2/facts/{proj_id}/{env_id}/resource_instances/detailed
• "Search resource_instances?" -> GET /v2/facts/{proj_id}/{env_id}/resource_instances
• "Create a resource_instance?" -> POST /v2/facts/{proj_id}/{env_id}/resource_instances
• "Get resource_instance details?" -> GET /v2/facts/{proj_id}/{env_id}/resource_instances/{instance_id}
• "Delete a resource_instance?" -> DELETE /v2/facts/{proj_id}/{env_id}/resource_instances/{instance_id}
• "Partially update a resource_instance?" -> PATCH /v2/facts/{proj_id}/{env_id}/resource_instances/{instance_id}
• "List all proxy_configs?" -> GET /v2/facts/{proj_id}/{env_id}/proxy_configs
• "Create a proxy_config?" -> POST /v2/facts/{proj_id}/{env_id}/proxy_configs
• "Get proxy_config details?" -> GET /v2/facts/{proj_id}/{env_id}/proxy_configs/{proxy_config_id}
• "Delete a proxy_config?" -> DELETE /v2/facts/{proj_id}/{env_id}/proxy_configs/{proxy_config_id}
• "Partially update a proxy_config?" -> PATCH /v2/facts/{proj_id}/{env_id}/proxy_configs/{proxy_config_id}
• "Create a user?" -> POST /v2/facts/{proj_id}/{env_id}/bulk/users
• "Create a tenant?" -> POST /v2/facts/{proj_id}/{env_id}/bulk/tenants
• "List all email_configurations?" -> GET /v2/facts/{proj_id}/{env_id}/email_configurations
• "Create a email_configuration?" -> POST /v2/facts/{proj_id}/{env_id}/email_configurations
• "Create a send_test_email?" -> POST /v2/facts/{proj_id}/{env_id}/email_configurations/send_test_email
• "List all email_templates?" -> GET /v2/facts/{proj_id}/{env_id}/email_templates/
• "Get email_template details?" -> GET /v2/facts/{proj_id}/{env_id}/email_templates/{template_type}
• "Create a send_test_email?" -> POST /v2/facts/{proj_id}/{env_id}/email_templates/{template_type}/send_test_email
• "List all detailed?" -> GET /v2/facts/{proj_id}/{env_id}/relationship_tuples/detailed
• "List all relationship_tuples?" -> GET /v2/facts/{proj_id}/{env_id}/relationship_tuples
• "Create a relationship_tuple?" -> POST /v2/facts/{proj_id}/{env_id}/relationship_tuples
• "Create a bulk?" -> POST /v2/facts/{proj_id}/{env_id}/relationship_tuples/bulk
• "Search user_invites?" -> GET /v2/facts/{proj_id}/{env_id}/user_invites
• "Create a user_invite?" -> POST /v2/facts/{proj_id}/{env_id}/user_invites
• "Get user_invite details?" -> GET /v2/facts/{proj_id}/{env_id}/user_invites/{user_invite_id}
• "Delete a user_invite?" -> DELETE /v2/facts/{proj_id}/{env_id}/user_invites/{user_invite_id}
• "Partially update a user_invite?" -> PATCH /v2/facts/{proj_id}/{env_id}/user_invites/{user_invite_id}
• "Create a approve?" -> POST /v2/facts/{proj_id}/{env_id}/user_invites/{user_invite_id}/approve
• "Get tenant details?" -> GET /v2/facts/{proj_id}/{env_id}/access_requests/{elements_config_id}/user/{user_id}/tenant/{tenant_id}
• "Get tenant details?" -> GET /v2/facts/{proj_id}/{env_id}/access_requests/{elements_config_id}/user/{user_id}/tenant/{tenant_id}/{access_request_id}
• "List all configs?" -> GET /v2/pdps/{proj_id}/{env_id}/configs
• "List all values?" -> GET /v2/pdps/{proj_id}/{env_id}/configs/{pdp_id}/values
• "Create a rotate-api-key?" -> POST /v2/pdps/{proj_id}/{env_id}/configs/{pdp_id}/rotate-api-key
• "Create a migrate-shard?" -> POST /v2/pdps/{proj_id}/{env_id}/configs/migrate-shards
• "Search audit_logs?" -> GET /v2/pdps/{proj_id}/{env_id}/audit_logs
• "Get audit_log details?" -> GET /v2/pdps/{proj_id}/{env_id}/audit_logs/{log_id}
• "List all repos?" -> GET /v2/projects/{proj_id}/repos
• "Create a repo?" -> POST /v2/projects/{proj_id}/repos
• "List all active?" -> GET /v2/projects/{proj_id}/repos/active
• "Get repo details?" -> GET /v2/projects/{proj_id}/repos/{repo_id}
• "Delete a repo?" -> DELETE /v2/projects/{proj_id}/repos/{repo_id}
• "List all config?" -> GET /v2/elements/{proj_id}/{env_id}/config
• "Create a config?" -> POST /v2/elements/{proj_id}/{env_id}/config
• "Get config details?" -> GET /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}
• "Partially update a config?" -> PATCH /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}
• "List all runtime?" -> GET /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/runtime
• "Delete a element?" -> DELETE /v2/elements/{proj_id}/{env_id}/{elements_config_id}
• "Search users?" -> GET /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users
• "Create a user?" -> POST /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users
• "Delete a user?" -> DELETE /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users/{user_id}
• "Search user-invites?" -> GET /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/user-invites
• "Search roles?" -> GET /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/roles
• "Create a role?" -> POST /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users/{user_id}/roles
• "Create a active?" -> POST /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/active
• "Search audit_logs?" -> GET /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/audit_logs
• "List all access_requests?" -> GET /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/access_requests
• "Create a access_request?" -> POST /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/access_requests
• "Get access_request details?" -> GET /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/access_requests/{access_request_id}
• "List all operation_approval?" -> GET /v2/elements/{proj_id}/{env_id}/c

…(truncated)