{ "opencollection": "1.0.0", "info": { "name": "WorkOS admin-portal permissions API", "version": "1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "permissions", "type": "folder" }, "items": [ { "info": { "name": "List Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://api.workos.com/authorization/permissions", "params": [ { "name": "before", "value": "", "type": "query", "description": "An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `\"obj_123\"`, your subsequent call can include `before=\"obj_123\"` to fetch a new batch of objects before `\"obj_123\"`." }, { "name": "after", "value": "", "type": "query", "description": "An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `\"obj_123\"`, your subsequent call can include `after=\"obj_123\"` to fetch a new batch of objects after `\"obj_123\"`." }, { "name": "limit", "value": "", "type": "query", "description": "Upper limit on the number of objects to return, between `1` and `100`." }, { "name": "order", "value": "", "type": "query", "description": "Order the results by the creation time. Supported values are `\"asc\"` (ascending), `\"desc\"` (descending), and `\"normal\"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). Defaults to descending." } ] }, "docs": "Get a list of all permissions in your WorkOS environment." }, { "info": { "name": "Create a Permission", "type": "http" }, "http": { "method": "POST", "url": "https://api.workos.com/authorization/permissions", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new permission in your WorkOS environment. The permission can then be assigned to environment roles and custom roles." }, { "info": { "name": "Get a Permission", "type": "http" }, "http": { "method": "GET", "url": "https://api.workos.com/authorization/permissions/:slug", "params": [ { "name": "slug", "value": "", "type": "path", "description": "A unique key to reference the permission. Must be lowercase and contain only letters, numbers, hyphens, underscores, colons, periods, and asterisks." } ] }, "docs": "Retrieve a permission by its unique slug." }, { "info": { "name": "Update a Permission", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.workos.com/authorization/permissions/:slug", "params": [ { "name": "slug", "value": "", "type": "path", "description": "A unique key to reference the permission. Must be lowercase and contain only letters, numbers, hyphens, underscores, colons, periods, and asterisks." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing permission. Only the fields provided in the request body will be updated." }, { "info": { "name": "Delete a Permission", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.workos.com/authorization/permissions/:slug", "params": [ { "name": "slug", "value": "", "type": "path", "description": "A unique key to reference the permission. Must be lowercase and contain only letters, numbers, hyphens, underscores, colons, periods, and asterisks." } ] }, "docs": "Delete an existing permission. System permissions cannot be deleted." } ] } ], "bundled": true }