{ "opencollection": "1.0.0", "info": { "name": "Guardian OIDC Scope Management API", "version": "1.0.0" }, "items": [ { "info": { "name": "OIDC Scope Management", "type": "folder" }, "items": [ { "info": { "name": "List scopes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/scopes", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter scopes by name (partial match, case-insensitive)" }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination" }, { "name": "page_size", "value": "", "type": "query", "description": "Number of items per page" } ] }, "docs": "Retrieve a paginated list of scopes for a tenant. \nOptionally filter by scope name using partial matching.\n\n**Query Parameters:**\n- `name`: Filter scopes by name (case-insensitive partial match)\n- `page`: Page number for pagination (starts from 1)\n- `page_size`: Number of items per page (1-100, default: 10)\n" }, { "info": { "name": "Create a new scope", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/scopes", "headers": [ { "name": "tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new scope for a tenant. Scopes define permissions and claims \nthat can be granted to users and applications.\n\n**Predefined OIDC Scope Validation:**\n- `openid`: Must contain only the 'sub' claim\n- `phone`: Must contain 'phone_number' and/or 'phone_number_verified' claims (maximum 2 claims)\n- `email`: Must contain 'email' and/or 'email_verified' claims (maximum 2 claims)\n- `address`: Must contain only the 'address' claim\n\nCustom scopes can have any combination of claims.\n" }, { "info": { "name": "Update an existing scope", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/scopes/:name", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the scope to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing scope by name. All fields except the scope name can be updated.\nPartial updates are supported - only provided fields will be updated.\n\n**Predefined OIDC Scope Validation:**\n- `openid`: Must contain only the 'sub' claim\n- `phone`: Must contain 'phone_number' and 'phone_number_verified' claims (exactly 2 claims)\n- `email`: Must contain 'email' and 'email_verified' claims (exactly 2 claims)\n- `address`: Must contain only the 'address' claim\n\n**Note:** The scope name cannot be cha" }, { "info": { "name": "Delete a scope", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/scopes/:name", "headers": [ { "name": "tenant-id", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the scope to delete" } ] }, "docs": "Delete a specific scope by name. This operation is irreversible and will \nremove all associations with this scope.\n\n**Important:** Deleting a scope that is currently in use by applications \nor users may cause authentication and authorization issues.\n" } ] } ], "bundled": true }