{ "opencollection": "1.0.0", "info": { "name": "Beyond Identity Secure Access Applications Resource Servers API", "version": "1.7.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Resource Servers", "type": "folder" }, "items": [ { "info": { "name": "List Resource Servers For a Realm", "type": "http" }, "http": { "method": "GET", "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/resource-servers", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "A unique identifier for a tenant." }, { "name": "realm_id", "value": "", "type": "path", "description": "A unique identifier for a realm." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of items returned per page. The response will include at most this many results but may include fewer. If this value is omitted, the response will return the default number of results allowed by the method.\n" }, { "name": "page_token", "value": "", "type": "query", "description": "Token to retrieve the subsequent page of the previous request. All other parameters to the list endpoint should match the original request that provided this token unless otherwise specified.\n" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "To list all resource servers for a realm, send a GET request to\n`/v1/tenants/$TENANT_ID/realms/$REALM_ID/resource-servers`.\n\nThe response will contain at most 100 items and may contain a page token to\nquery the remaining items. If page size is not specified, the response will\ncontain 100 items. There is no defined ordering of the list of resource\nservers in the response. Note that the maximum and default page sizes are\nsubject to change.\n\nWhen paginating, the page size is maintained by the page" }, { "info": { "name": "Create a New Resource Server", "type": "http" }, "http": { "method": "POST", "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/resource-servers", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "A unique identifier for a tenant." }, { "name": "realm_id", "value": "", "type": "path", "description": "A unique identifier for a realm." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "To create a resource server, send a POST request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/resource-servers`. Values in the request body for read-only fields will be ignored.\n" }, { "info": { "name": "Retrieve an Existing Resource Server", "type": "http" }, "http": { "method": "GET", "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/resource-servers/:resource_server_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "A unique identifier for a tenant." }, { "name": "realm_id", "value": "", "type": "path", "description": "A unique identifier for a realm." }, { "name": "resource_server_id", "value": "", "type": "path", "description": "A unique identifier for a resource server." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "To retrieve an existing resource server, send a GET request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/resource-servers/$RESOURCE_SERVER_ID`.\n" }, { "info": { "name": "Patch a Resource Server", "type": "http" }, "http": { "method": "PATCH", "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/resource-servers/:resource_server_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "A unique identifier for a tenant." }, { "name": "realm_id", "value": "", "type": "path", "description": "A unique identifier for a realm." }, { "name": "resource_server_id", "value": "", "type": "path", "description": "A unique identifier for a resource server." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "To update only specific attributes of an existing resource server, send a a\nPATCH request to\n`/v1/tenants/$TENANT_ID/realms/$REALM_ID/resource-servers/$RESOURCE_SERVER_ID`.\nValues in the request body for immutable or read-only fields will be\nignored. Fields that are omitted from the request body will be left\nunchanged.\n\nScopes that are removed from a resource server will be asynchronously\nremoved from all roles associated with the resource server.\n" }, { "info": { "name": "Delete a Resource Server", "type": "http" }, "http": { "method": "DELETE", "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/resource-servers/:resource_server_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "A unique identifier for a tenant." }, { "name": "realm_id", "value": "", "type": "path", "description": "A unique identifier for a realm." }, { "name": "resource_server_id", "value": "", "type": "path", "description": "A unique identifier for a resource server." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "To delete a resource server, send a DELETE request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/resource-servers/$RESOURCE_SERVER_ID`.\nA successful request will receive a 200 status code with no body in the response. This indicates that the request was processed successfully.\n" } ] } ], "bundled": true }