{ "opencollection": "1.0.0", "info": { "name": "Beyond Identity Secure Access Applications API", "version": "1.7.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Applications", "type": "folder" }, "items": [ { "info": { "name": "List Applications for a Realm", "type": "http" }, "http": { "method": "GET", "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/applications", "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 applications for a realm, send a GET request to\n`/v1/tenants/$TENANT_ID/realms/$REALM_ID/applications`.\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 applications\nin the response. Note that the maximum and default page sizes are subject\nto change.\n\nWhen paginating, the page size is maintained by the page token but m" }, { "info": { "name": "Create a New Application", "type": "http" }, "http": { "method": "POST", "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/applications", "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 an application, send a POST request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/applications`. Values in the request body for read-only fields will be ignored.\nAt present, there are only two supported protocol types for applications, `oauth2` and `oidc`.\n" }, { "info": { "name": "Retrieve an Existing Application", "type": "http" }, "http": { "method": "GET", "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/applications/:application_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": "application_id", "value": "", "type": "path", "description": "A unique identifier for an application." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "To retrieve an existing application, send a GET request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/applications/$APPLICATION_ID`.\n" }, { "info": { "name": "Patch an Application", "type": "http" }, "http": { "method": "PATCH", "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/applications/:application_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": "application_id", "value": "", "type": "path", "description": "A unique identifier for an application." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "To update only specific attributes of an existing application, send a PATCH request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/applications/$APPLICATION_ID`. Values in the request body for immutable or read-only fields will be ignored. Fields that are omitted from the request body will be left unchanged.\n" }, { "info": { "name": "Delete an Application", "type": "http" }, "http": { "method": "DELETE", "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/applications/:application_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": "application_id", "value": "", "type": "path", "description": "A unique identifier for an application." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "To delete an application, send a DELETE request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/applications/$APPLICATION_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 }