{ "opencollection": "1.0.0", "info": { "name": "Permit.io Access Requests (EAP) Access Requests (EAP) Resources API", "version": "2.0.0" }, "items": [ { "info": { "name": "Resources", "type": "folder" }, "items": [ { "info": { "name": "List Resources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/schema/:proj_id/:env_id/resources", "params": [ { "name": "proj_id", "value": "my_project", "type": "path", "description": "Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\")." }, { "name": "env_id", "value": "my_environment", "type": "path", "description": "Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\")." }, { "name": "include_built_in", "value": "", "type": "query", "description": "Whether to include or exclude built-in resources, default is False" }, { "name": "include_total_count", "value": "", "type": "query", "description": "Include total count in response" }, { "name": "page", "value": "", "type": "query", "description": "Page number of the results to fetch, starting at 1." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100)." }, { "name": "search", "value": "", "type": "query", "description": "Text search for the object name or key" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Lists all the resources defined in your schema." }, { "info": { "name": "Create Resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/schema/:proj_id/:env_id/resources", "params": [ { "name": "proj_id", "value": "my_project", "type": "path", "description": "Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\")." }, { "name": "env_id", "value": "my_environment", "type": "path", "description": "Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\")." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new resource (a type of object you may protect with permissions)." }, { "info": { "name": "Get Resource", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/schema/:proj_id/:env_id/resources/:resource_id", "params": [ { "name": "resource_id", "value": "my_resource", "type": "path", "description": "Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\")." }, { "name": "proj_id", "value": "my_project", "type": "path", "description": "Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\")." }, { "name": "env_id", "value": "my_environment", "type": "path", "description": "Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\")." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Gets a single resource, if such resource exists." }, { "info": { "name": "Replace Resource", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/schema/:proj_id/:env_id/resources/:resource_id", "params": [ { "name": "resource_id", "value": "my_resource", "type": "path", "description": "Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\")." }, { "name": "proj_id", "value": "my_project", "type": "path", "description": "Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\")." }, { "name": "env_id", "value": "my_environment", "type": "path", "description": "Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\")." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replaces the resource definition, or creates it if it doesn't exist.\n\n- If some actions are removed or renamed from the resource definition,\nrole and permissions assignments for these actions will be revoked." }, { "info": { "name": "Update Resource", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/schema/:proj_id/:env_id/resources/:resource_id", "params": [ { "name": "resource_id", "value": "my_resource", "type": "path", "description": "Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\")." }, { "name": "proj_id", "value": "my_project", "type": "path", "description": "Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\")." }, { "name": "env_id", "value": "my_environment", "type": "path", "description": "Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\")." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially updates the resource definition.\nFields that will be provided will be completely overwritten." }, { "info": { "name": "Delete Resource", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/schema/:proj_id/:env_id/resources/:resource_id", "params": [ { "name": "resource_id", "value": "my_resource", "type": "path", "description": "Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\")." }, { "name": "proj_id", "value": "my_project", "type": "path", "description": "Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\")." }, { "name": "env_id", "value": "my_environment", "type": "path", "description": "Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\")." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deletes the resource and all its related data." } ] } ], "bundled": true }