{
  "opencollection": "1.0.0",
  "info": {
    "name": "Beyond Identity Secure Access Applications Realms API",
    "version": "1.7.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Realms",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Realms for a Tenant",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "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"
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of items to skip. This is the zero-based index of the first result.\n"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To list all realms for a tenant, send a GET request to\n`/v1/tenants/$TENANT_ID/realms`.\n\nThe response will contain at most 200 items and may contain a page token to\nquery the remaining items. If page size is not specified, the response will\ncontain 20 items. There is no defined ordering of the list of realms in the\nresponse. Note that the maximum and default page sizes are subject to\nchange.\n\nWhen paginating, the page size is maintained by the page token but may be\noverridden on subsequent reque"
        },
        {
          "info": {
            "name": "Create a New Realm",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To create a realm, send a POST request to `/v1/tenants/$TENANT_ID/realms`. Values in the request body for read-only fields will be ignored.\n"
        },
        {
          "info": {
            "name": "Retrieve an Existing Realm",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_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."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To retrieve an existing realm, send a GET request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID`.\n"
        },
        {
          "info": {
            "name": "Patch a Realm",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_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."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To update only specific attributes of an existing realm, send a PATCH request to `/v1/tenants/$TENANT_ID/realms/$REALM_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 a Realm",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_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."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To delete a realm, send a DELETE request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID`. To be deleted, a realm must not have any identities, groups, or roles. All associated resources must first be deleted or you will receive a 409 error.\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
}