permitio-api

name	permitio-api
description	Permit.io API skill. Use when working with Permit.io for members, api-key, orgs. Covers 258 endpoints.
version	1.0.0
generator	lapsh

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

Method	Path	Description
GET	/v2/members/me	Get the authenticated account member
GET	/v2/members	List Organization Members
POST	/v2/members	Invite new members
DELETE	/v2/members	Remove permission
GET	/v2/members/{member_id}	Get Organization Member
DELETE	/v2/members/{member_id}	Remove member
PATCH	/v2/members/{member_id}	Edit members

api-key

Method	Path	Description
GET	/v2/api-key/{proj_id}/{env_id}	Get Environment Api Key
GET	/v2/api-key/scope	Get Api Key Scope
GET	/v2/api-key	List Api Keys
POST	/v2/api-key	Create Api Key
GET	/v2/api-key/{api_key_id}	Get Api Key
DELETE	/v2/api-key/{api_key_id}	Delete Api Key
POST	/v2/api-key/{api_key_id}/rotate-secret	Rotate API Key

orgs

Method	Path	Description
GET	/v2/orgs	List Organizations
POST	/v2/orgs	Create Organization
GET	/v2/orgs/{org_id}	Get Organization
DELETE	/v2/orgs/{org_id}	Delete Organization
PATCH	/v2/orgs/{org_id}	Update Organization
GET	/v2/orgs/active/org	Get Active Organization
GET	/v2/orgs/{org_id}/stats	Stats Organization
GET	/v2/orgs/{org_id}/invites	List Organization Invites
POST	/v2/orgs/{org_id}/invites	Invite Members To Organization
DELETE	/v2/orgs/{org_id}/invites/{invite_id}	Cancel Invite

projects

Method	Path	Description
GET	/v2/projects	List Projects
POST	/v2/projects	Create Project
GET	/v2/projects/{proj_id}	Get Project
DELETE	/v2/projects/{proj_id}	Delete Project
PATCH	/v2/projects/{proj_id}	Update Project
GET	/v2/projects/{proj_id}/envs/{env_id}/stats	Stats Environments
GET	/v2/projects/{proj_id}/envs	List Environments
POST	/v2/projects/{proj_id}/envs	Create Environment
GET	/v2/projects/{proj_id}/envs/{env_id}	Get Environment
DELETE	/v2/projects/{proj_id}/envs/{env_id}	Delete Environment
PATCH	/v2/projects/{proj_id}/envs/{env_id}	Update Environment
POST	/v2/projects/{proj_id}/envs/{env_id}/copy	Copy Environment
POST	/v2/projects/{proj_id}/envs/{env_id}/copy/async	Copy Environment Async
GET	/v2/projects/{proj_id}/envs/{env_id}/copy/async/{task_id}/result	Get Copy Environment Task Result
POST	/v2/projects/{proj_id}/envs/{env_id}/test_jwks	Test Jwks By Url
GET	/v2/projects/{proj_id}/repos	List Policy Repos
POST	/v2/projects/{proj_id}/repos	Create Policy Repo
GET	/v2/projects/{proj_id}/repos/active	Get Active Policy Repo
PUT	/v2/projects/{proj_id}/repos/disable	Disable Active Policy Repo
PUT	/v2/projects/{proj_id}/repos/{repo_id}/activate	Activate Policy Repo
GET	/v2/projects/{proj_id}/repos/{repo_id}	Get Policy Repo
DELETE	/v2/projects/{proj_id}/repos/{repo_id}	Delete Policy Repo
GET	/v2/projects/{proj_id}/{env_id}/opal_scope	Get Scope Config

schema

Method	Path	Description
PUT	/v2/schema/{proj_id}/{env_id}/bulk/roles	Bulk Create Or Replace Roles
GET	/v2/schema/{proj_id}/{env_id}/condition_sets	List Condition Sets
POST	/v2/schema/{proj_id}/{env_id}/condition_sets	Create Condition Set
GET	/v2/schema/{proj_id}/{env_id}/condition_sets/{condition_set_id}	Get Condition Set
DELETE	/v2/schema/{proj_id}/{env_id}/condition_sets/{condition_set_id}	Delete Condition Set
PATCH	/v2/schema/{proj_id}/{env_id}/condition_sets/{condition_set_id}	Update Condition Set
GET	/v2/schema/{proj_id}/{env_id}/condition_sets/{condition_set_id}/ancestors	Get Condition Set Ancestors
GET	/v2/schema/{proj_id}/{env_id}/condition_sets/{condition_set_id}/descendants	Get Condition Set Descendants
POST	/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles/{role_id}/implicit_grants	Create Implicit Grant
DELETE	/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles/{role_id}/implicit_grants	Delete Implicit Grant
PUT	/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles/{role_id}/implicit_grants/conditions	Update Implicit Grants Conditions
GET	/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/action_groups	List Resource Action Groups
POST	/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/action_groups	Create Resource Action Group
GET	/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/action_groups/{action_group_id}	Get Resource Action Group
DELETE	/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/action_groups/{action_group_id}	Delete Resource Action Group
PATCH	/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/action_groups/{action_group_id}	Update Resource Action Group
GET	/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/actions	List Resource Actions
POST	/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/actions

facts

Method	Path	Description
GET	/v2/facts/{proj_id}/{env_id}/users	List Users
POST	/v2/facts/{proj_id}/{env_id}/users	Create User
GET	/v2/facts/{proj_id}/{env_id}/users/{user_id}	Get User
PUT	/v2/facts/{proj_id}/{env_id}/users/{user_id}	Replace User
DELETE	/v2/facts/{proj_id}/{env_id}/users/{user_id}	Delete User
PATCH	/v2/facts/{proj_id}/{env_id}/users/{user_id}	Update User
POST	/v2/facts/{proj_id}/{env_id}/users/{user_id}/roles	Assign Role To User
DELETE	/v2/facts/{proj_id}/{env_id}/users/{user_id}/roles	Unassign Role From User
GET	/v2/facts/{proj_id}/{env_id}/tenants/{tenant_id}/users	List Tenant Users
POST	/v2/facts/{proj_id}/{env_id}/tenants/{tenant_id}/users	Add User To Tenant
GET	/v2/facts/{proj_id}/{env_id}/tenants	List Tenants
POST	/v2/facts/{proj_id}/{env_id}/tenants	Create Tenant
GET	/v2/facts/{proj_id}/{env_id}/tenants/{tenant_id}	Get Tenant
DELETE	/v2/facts/{proj_id}/{env_id}/tenants/{tenant_id}	Delete Tenant
PATCH	/v2/facts/{proj_id}/{env_id}/tenants/{tenant_id}	Update Tenant
DELETE	/v2/facts/{proj_id}/{env_id}/tenants/{tenant_id}/users/{user_id}	Delete Tenant User
GET	/v2/facts/{proj_id}/{env_id}/role_assignments/detailed	List Role Assignments Detailed
GET	/v2/facts/{proj_id}/{env_id}/role_assignments	List Role Assignments
POST	/v2/facts/{proj_id}/{env_id}/role_assignments	Assign Role
DELETE	/v2/facts/{proj_id}/{env_id}/role_assignments	Unassign Role
POST	/v2/facts/{proj_id}/{env_id}/role_assignments/bulk	Bulk create role assignments
DELETE

pdps

Method	Path	Description
GET	/v2/pdps/{proj_id}/{env_id}/configs	List PDP configurations
GET	/v2/pdps/{proj_id}/{env_id}/configs/{pdp_id}/values	Get PDP configuration
PUT	/v2/pdps/{proj_id}/{env_id}/configs/{pdp_id}/debug-audit-logs/enable	Enable debug audit logs
PUT	/v2/pdps/{proj_id}/{env_id}/configs/{pdp_id}/debug-audit-logs/disable	Disable debug audit logs
POST	/v2/pdps/{proj_id}/{env_id}/configs/{pdp_id}/rotate-api-key	Rotate PDP API Key
POST	/v2/pdps/{proj_id}/{env_id}/configs/migrate-shards	Migrate PDP Config number of shards
GET	/v2/pdps/{proj_id}/{env_id}/audit_logs	List Audit Logs
GET	/v2/pdps/{proj_id}/{env_id}/audit_logs/{log_id}	Get detailed audit log

elements

Method	Path	Description
GET	/v2/elements/{proj_id}/{env_id}/config	List Elements Configs
POST	/v2/elements/{proj_id}/{env_id}/config	Create Elements Config
GET	/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}	Get Elements Config
PATCH	/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}	Update Elements Config
GET	/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/runtime	Get Elements Config Runtime
DELETE	/v2/elements/{proj_id}/{env_id}/{elements_config_id}	Delete Elements Config
GET	/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users	List users
POST	/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users	Create user
DELETE	/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users/{user_id}	Delete user
GET	/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/user-invites	List all Elements User Invites
GET	/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/roles	List roles
POST	/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users/{user_id}/roles	Assign role to user
DELETE	/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users/{user_id}/roles	Unassign role from user
POST	/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/active	Set Config Active
GET	/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/audit_logs	List audit logs
GET	/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/access_requests	List Access Requests
POST	/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/access_requests	Create Access Request
GET	/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/access_requests/{access_request_id}	Get Access Request

deprecated

Method	Path	Description
GET	/v2/deprecated/history	List Api Events
GET	/v2/deprecated/history/{event_id}	Get Api Event
GET	/v2/deprecated/history/{event_id}/request	Get Request Body
GET	/v2/deprecated/history/{event_id}/response	Get Response Body
GET	/v2/deprecated/activity	List Activity Events
GET	/v2/deprecated/activity/types	List Activity Types

history

Method	Path	Description
GET	/v2/history	List Api Events
GET	/v2/history/{event_id}	Get Api Event
GET	/v2/history/{event_id}/request	Get Request Body
GET	/v2/history/{event_id}/response	Get Response Body

activity

Method	Path	Description
GET	/v2/activity	List Activity Events
GET	/v2/activity/types	List Activity Types

policy_guards

Method	Path	Description
GET	/v2/policy_guards/scopes	List Policy Guard Scopes
POST	/v2/policy_guards/scopes	Create Policy Guard Scope
GET	/v2/policy_guards/scopes/{policy_guard_scope_id}	Get Policy Guard Scope
DELETE	/v2/policy_guards/scopes/{policy_guard_scope_id}	Delete Policy Guard Scope
POST	/v2/policy_guards/scopes/{policy_guard_scope_id}/associate	Associate Policy Guard Scope
DELETE	/v2/policy_guards/scopes/{policy_guard_scope_id}/disassociate	Disassociate Policy Guard Scope
GET	/v2/policy_guards/scopes/{policy_guard_scope_id}/rules	List Policy Guard Rules
POST	/v2/policy_guards/scopes/{policy_guard_scope_id}/rules	Create Policy Guard Rule
DELETE	/v2/policy_guards/scopes/{policy_guard_scope_id}/rules	Delete Policy Guard Rule

audit-log-replay

Method	Path	Description
POST	/v2/audit-log-replay	Run the audit log replay

internal

Method	Path	Description
GET	/v2/internal/opal_data/{org_id}/{proj_id}/{env_id}/optimized	Get All Data Optimized
GET	/v2/internal/opal_data/{org_id}/{proj_id}/{env_id}	Get All Data
GET	/v2/internal/opal_data/{org_id}/{proj_id}/{env_id}/users	Get All Users Data
GET	/v2/internal/opal_data/{org_id}/{proj_id}/{env_id}/role_assignments	Get All Role Assignments Data
GET	/v2/internal/opal_data/{org_id}/{proj_id}/{env_id}/resource_instances	Get All Resource Instances Data
GET	/v2/internal/opal_data/{org_id}/{proj_id}/{env_id}/relationships	Get All Relationships Data

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}

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP