---
updatedAt: 2026-06-04T19:58:43.000Z
agentTools:
  projectIndex: https://docs.wristband.dev/llms.txt
---

# Get Application

Retrieves the specified application.

### Required Permissions

Below is the list of required permissions needed to interact with this API.  For each permission, the allowed permission boundaries are also specified.

| Permission           | Boundary    | Description                                                      |
| -------------------- | ----------- | ---------------------------------------------------------------- |
| **application:read** | Application | The subject can read the application that it is associated with. |
|                      | Self        | The subject can read the application that it is associated with. |

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Resource Management APIs",
    "version": "1.0.0",
    "description": "Resource Management APIs",
    "license": {
      "name": "Private",
      "url": "https://wristband.dev/terms/"
    },
    "termsOfService": "https://wristband.dev/terms/",
    "contact": {
      "name": "Wristband Support",
      "email": "support@wristband.dev",
      "url": "https://wristband.dev/contact/"
    }
  },
  "servers": [
    {
      "url": "https://{application_vanity_domain}",
      "description": "Wristband application scoped URL.",
      "variables": {
        "application_vanity_domain": {
          "default": "yourapp-yourorg.us.wristband.dev",
          "description": "Wristband vanity domain scoped to a specific application."
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Applications",
      "description": "Applications",
      "x-displayName": "Applications"
    }
  ],
  "paths": {
    "/api/v1/applications/{applicationId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Resource_Management_APIs_ApplicationId"
        }
      ],
      "get": {
        "summary": "Get Application",
        "operationId": "getApplicationV1",
        "tags": [
          "Applications"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Resource_Management_APIs_Fields"
          },
          {
            "$ref": "#/components/parameters/Resource_Management_APIs_If-None-Match"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/Resource_Management_APIs_ETag"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Resource_Management_APIs_Application"
                },
                "examples": {
                  "Example 1": {
                    "$ref": "#/components/examples/Resource_Management_APIs_Application"
                  }
                }
              }
            }
          },
          "304": {
            "$ref": "#/components/responses/Resource_Management_APIs_304"
          },
          "400": {
            "$ref": "#/components/responses/Resource_Management_APIs_400-default"
          },
          "401": {
            "$ref": "#/components/responses/Resource_Management_APIs_401"
          },
          "403": {
            "$ref": "#/components/responses/Resource_Management_APIs_403"
          },
          "404": {
            "$ref": "#/components/responses/Resource_Management_APIs_404-application-not-found"
          },
          "405": {
            "$ref": "#/components/responses/Resource_Management_APIs_405"
          },
          "406": {
            "$ref": "#/components/responses/Resource_Management_APIs_406"
          },
          "500": {
            "$ref": "#/components/responses/Resource_Management_APIs_500"
          },
          "503": {
            "$ref": "#/components/responses/Resource_Management_APIs_503"
          }
        },
        "security": [
          {
            "Resource_Management_APIs_BearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "Resource_Management_APIs_BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "parameters": {
      "Resource_Management_APIs_ApplicationId": {
        "name": "applicationId",
        "description": "The ID of the application that the resource or action is scoped to.",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string",
          "minLength": 1,
          "maxLength": 26,
          "example": "jkuik2gzzvbsbfdepwyqpreryh"
        }
      },
      "Resource_Management_APIs_Fields": {
        "name": "fields",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "default": "*",
          "example": "field1,field2",
          "minLength": 0
        },
        "description": "List of resource fields that should be returned in a response.  The wildcard value of `*` can be used to return all fields for the resource.",
        "style": "form"
      },
      "Resource_Management_APIs_If-None-Match": {
        "name": "If-None-Match",
        "description": "Used to perform a conditional get of the resource",
        "in": "header",
        "required": false,
        "schema": {
          "type": "string",
          "example": "\"0\",\"2\"",
          "minLength": 0
        }
      }
    },
    "schemas": {
      "Resource_Management_APIs_Application": {
        "title": "Application",
        "description": "An application is a parent of a tenant.",
        "type": "object",
        "x-tags": [
          "Models"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/Resource_Management_APIs_id"
          },
          "workspaceId": {
            "description": "[Required on Create] The ID of the workspace that this application belongs to.",
            "type": "string",
            "readOnly": true,
            "minLength": 1,
            "maxLength": 26,
            "example": "pl4a4aa4jzydksmrf3jnu5yfcw"
          },
          "vanityDomain": {
            "description": "Vanity domain that uniquely identifies this application.",
            "type": "string",
            "format": "hostname",
            "readOnly": true,
            "example": "yourapp-yourorg.us.wristband.dev"
          },
          "resolvedVanityDomain": {
            "description": "If an application has an active custom domain defined then this value will be the custom domain; otherwise \nit will be the application's default vanity domain.",
            "type": "string",
            "format": "hostname",
            "readOnly": true,
            "example": "auth.yourapp.com"
          },
          "domainName": {
            "description": "**Deprecation Notice**: This field has been replaced by the `name` field and should no longer be used. In the future, this field may be removed.\n\nName of the application. The name must be unique (case-insensitive) within a workspace.",
            "type": "string",
            "pattern": "^[a-zA-Z0-9]+$",
            "minLength": 3,
            "maxLength": 20,
            "example": "yourapp",
            "deprecated": true
          },
          "name": {
            "description": "[Required on Create] Name of the application. The name must be unique (case-insensitive) within a workspace.",
            "type": "string",
            "pattern": "^[a-zA-Z0-9]+$",
            "minLength": 3,
            "maxLength": 20,
            "example": "yourapp"
          },
          "displayName": {
            "description": "[Required on Create] A friendly name given to an application for display purposes.",
            "type": "string",
            "minLength": 1,
            "maxLength": 60,
            "example": "Your Application"
          },
          "isMultiTenant": {
            "description": "[Required on Create] Boolean indicating whether this application allows support for multiple tenants.",
            "type": "boolean",
            "example": true
          },
          "tenantClassifier": {
            "description": "The default classifier that will be applied to the application's tenants.",
            "type": "string",
            "enum": [
              "ACCOUNT",
              "COMPANY",
              "ORGANIZATION",
              "TEAM",
              "TENANT",
              "WORKSPACE"
            ],
            "minLength": 1,
            "maxLength": 45,
            "default": "TENANT",
            "example": "ORGANIZATION"
          },
          "environmentType": {
            "description": "[Required on Create] The application's environment type.",
            "type": "string",
            "enum": [
              "DEVELOPMENT",
              "PRODUCTION"
            ],
            "minLength": 1,
            "maxLength": 45,
            "example": "DEVELOPMENT"
          },
          "loginUrl": {
            "description": "[Required on Create] The application's login URL that can be called to initiate an authorization flow.  The `{tenant_name}` placeholder can be used as the left most domain label.  The `{tenant_name}` placeholder will be substituted with the current tenant's name when the login URL is redirected to.",
            "type": "string",
            "format": "uri",
            "minLength": 1,
            "maxLength": 2000,
            "example": "https://yourapp.com/auth/login"
          },
          "loginUrlContainsTenantDomainToken": {
            "description": "**Deprecation Notice**: This field has been replaced by the `loginUrlContainsTenantSubdomainPlaceholder` field and should no longer be used. In the future, this field may be removed.\n\nBoolean indicating if the login URL contains a tenant subdomain placeholder.",
            "type": "boolean",
            "readOnly": true,
            "example": true,
            "deprecated": true
          },
          "loginUrlContainsTenantSubdomainPlaceholder": {
            "description": "Boolean indicating if the login URL contains a tenant subdomain placeholder.",
            "type": "boolean",
            "readOnly": true,
            "example": true
          },
          "loginUrlTenantDomainSuffix": {
            "description": "Tenant domain name suffix of a login URL.  This value will only be present if `loginUrlContainsTenantSubdomainPlaceholder` is `true`.",
            "type": "string",
            "readOnly": true,
            "example": "yourapp.com"
          },
          "fallbackLoginUrl": {
            "description": "Read-only version of the login URL with all tenant name placeholders removed. This version of the login URL can be used in cases where a tenant is not known. Note, this value will only be present when the login URL contains a tenant name placeholder.",
            "type": "string",
            "format": "uri",
            "readOnly": true,
            "example": "https://yourapp.com/auth/login"
          },
          "logoutUrls": {
            "description": "List of optional logout URLs that, if specified, can be redirected to after successful logout of a user's session from the Wristband platform.  The `{tenant_name}` placeholder can be used as the left most domain label.  The `{tenant_name}` placeholder will be substituted with the current tenant's name when the logout URL is redirected to.",
            "type": "array",
            "maxItems": 10,
            "uniqueItems": true,
            "items": {
              "description": "[Supports Tenant Domains] Logout URL",
              "type": "string",
              "format": "uri",
              "minLength": 1,
              "maxLength": 2000,
              "example": "https://yourapp.com/auth/logout"
            },
            "example": [
              "https://yourapp.com/auth/logout"
            ]
          },
          "allowedOrigins": {
            "description": "List of optional allowed origins. If specified, these origins will determine whether any cross-origin API calls to this application will be allowed.  The wildcard value `*` can be used as the left most domain label to allow requests to be made from any subdomain.",
            "type": "array",
            "maxItems": 5,
            "uniqueItems": true,
            "items": {
              "description": "[Supports Wildcard Domains][No Paths Allowed] Allowed Origin URL",
              "type": "string",
              "format": "uri",
              "minLength": 1,
              "maxLength": 2000,
              "example": "https://*.yourapp.com"
            },
            "example": [
              "https://*.yourapp.com"
            ]
          },
          "signupEnabled": {
            "description": "Boolean indicating whether signup is enabled for an application.",
            "type": "boolean",
            "default": true,
            "example": true
          },
          "authorizationRequestsEnabled": {
            "description": "Boolean indicating whether authorization requests can be initiated at the application level for this application.",
            "type": "boolean",
            "default": false,
            "example": true
          },
          "customApplicationSignupPageUrl": {
            "description": "Custom application-level signup page URL for self-hosted signup UI.",
            "type": "string",
            "format": "uri",
            "minLength": 1,
            "maxLength": 2000,
            "example": "https://yourapp.com/app-signup"
          },
          "customTenantSignupPageUrl": {
            "description": "Custom tenant-level signup page URL for self-hosted signup UI.  The `{tenant_name}` placeholder can be used as the left most domain label. The `{tenant_name}` placeholder will be substituted with the current tenant's name when the URL is redirected to.",
            "type": "string",
            "format": "uri",
            "minLength": 1,
            "maxLength": 2000,
            "example": "https://yourapp.com/tenant-signup"
          },
          "customApplicationLoginPageUrl": {
            "description": "Custom application-level login page URL for self-hosted signup UI.",
            "type": "string",
            "format": "uri",
            "minLength": 1,
            "maxLength": 2000,
            "example": "https://yourapp.com/app-login"
          },
          "customTenantLoginPageUrl": {
            "description": "Custom tenant-level login page URL for self-hosted login UI.  The `{tenant_name}` placeholder can be used as the left most domain label.  The `{tenant_name}` placeholder will be substituted with the current tenant's name when the URL is redirected to.",
            "type": "string",
            "format": "uri",
            "minLength": 1,
            "maxLength": 2000,
            "example": "https://yourapp.com/tenant-login"
          },
          "customApplicationErrorPageUrl": {
            "description": "Custom application level error page URL for self-hosted error page UI.",
            "type": "string",
            "format": "uri",
            "minLength": 1,
            "maxLength": 2000,
            "example": "https://yourapp.com/app-error"
          },
          "customTenantErrorPageUrl": {
            "description": "Custom tenant-level error page URL for self-hosted error page UI.  The `{tenant_name}` placeholder can be used as the left most domain label.  The `{tenant_name}` placeholder will be substituted with the current tenant's name when the URL is redirected to.",
            "type": "string",
            "format": "uri",
            "minLength": 1,
            "maxLength": 2000,
            "example": "https://yourapp.com/tenant-error"
          },
          "customExternalIdpApplicationSignupPageUrl": {
            "description": "Custom application-level external IdP signup page URL for self-hosted external IdP signup UI.",
            "type": "string",
            "format": "uri",
            "minLength": 1,
            "maxLength": 2000,
            "example": "https://yourapp.com/app-external-idp-application-signup"
          },
          "customExternalIdpTenantSignupPageUrl": {
            "description": "Custom tenant-level external IdP signup page URL for self-hosted external IdP signup UI. The `{tenant_name}` placeholder can be used as the left most domain label.  The `{tenant_name}` placeholder will be substituted with the current tenant's name when the URL is redirected to.",
            "type": "string",
            "format": "uri",
            "minLength": 1,
            "maxLength": 2000,
            "example": "https://yourapp.com/external-idp-tenant-signup"
          },
          "customExternalIdpLoginPageUrl": {
            "description": "Custom external IdP login page URL for self-hosted external IdP login UI. The `{tenant_name}` placeholder can be used as the left most domain label.  The `{tenant_name}` placeholder will be substituted with the current tenant's name when the URL is redirected to.",
            "type": "string",
            "format": "uri",
            "minLength": 1,
            "maxLength": 2000,
            "example": "https://yourapp.com/external-idp-login"
          },
          "customExternalIdpInvitePageUrl": {
            "description": "Custom external IdP invite page URL for self-hosted external IdP invite UI. The `{tenant_name}` placeholder can be used as the left most domain label.  The `{tenant_name}` placeholder will be substituted with the current tenant's name when the URL is redirected to.",
            "type": "string",
            "format": "uri",
            "minLength": 1,
            "maxLength": 2000,
            "example": "https://yourapp.com/external-idp-invite"
          },
          "customExternalIdpChangeEmailPageUrl": {
            "description": "Custom external IdP change email page URL for self-hosted external IdP change email UI.  The `{tenant_name}` placeholder can be used as the left most domain label.  The `{tenant_name}` placeholder will be substituted with the current tenant's name when the URL is redirected to.",
            "type": "string",
            "format": "uri",
            "minLength": 1,
            "maxLength": 2000,
            "example": "https://yourapp.com/external-idp-change-email"
          },
          "status": {
            "description": "The status of the application",
            "type": "string",
            "enum": [
              "ACTIVE",
              "INACTIVE",
              "DELETE_IN_PROGRESS"
            ],
            "default": "ACTIVE",
            "example": "ACTIVE",
            "minLength": 1,
            "maxLength": 45
          },
          "metadata": {
            "$ref": "#/components/schemas/Resource_Management_APIs_activation-metadata"
          }
        },
        "example": {
          "id": "a4jzydksmrf3jnu5yfcwpl4a4a",
          "workspaceId": "4a4aa4jzydksmrf3jnu5yfcwpl",
          "vanityDomain": "yourapp-yourorg.us.wristband.dev",
          "resolvedVanityDomain": "auth.app.com",
          "domainName": "yourapp",
          "name": "yourapp",
          "displayName": "Your Application",
          "isMultiTenant": true,
          "tenantClassifier": "ORGANIZATION",
          "environmentType": "DEVELOPMENT",
          "loginUrl": "https://{tenant_name}.yourapp.com/auth/login",
          "loginUrlContainsTenantDomainToken": true,
          "loginUrlContainsTenantSubdomainPlaceholder": true,
          "loginUrlTenantDomainSuffix": "yourapp.com",
          "fallbackLoginUrl": "https://yourapp.com/auth/login",
          "logoutUrls": [
            "https://yourapp.com/auth/logout"
          ],
          "allowedOrigins": [
            "https://*.yourapp.com"
          ],
          "signupEnabled": true,
          "authorizationRequestsEnabled": true,
          "customApplicationSignupPageUrl": "https://yourapp.com/app-signup",
          "customTenantSignupPageUrl": "https://yourapp.com/tenant-signup",
          "customApplicationLoginPageUrl": "https://yourapp.com/app-login",
          "customTenantLoginPageUrl": "https://yourapp.com/tenant-login",
          "customApplicationErrorPageUrl": "https://yourapp.com/app-error",
          "customTenantErrorPageUrl": "https://yourapp.com/tenant-error",
          "customExternalIdpApplicationSignupPageUrl": "https://yourapp.com/external-idp-app-signup",
          "customExternalIdpTenantSignupPageUrl": "https://yourapp.com/external-idp-tenant-signup",
          "customExternalIdpLoginPageUrl": "https://yourapp.com/external-idp-login",
          "customExternalIdpInvitePageUrl": "https://yourapp.com/external-idp-invite",
          "customExternalIdpChangeEmailPageUrl": "https://yourapp.com/external-idp-change-email",
          "status": "ACTIVE",
          "metadata": {
            "version": "0.0",
            "lastModifiedTime": "2021-06-13T19:49:31.686Z",
            "creationTime": "2021-06-13T19:49:31.686Z",
            "activationTime": "2021-06-13T19:49:31.686Z",
            "deactivationTime": "2021-06-13T19:49:31.686Z"
          }
        }
      },
      "Resource_Management_APIs_id": {
        "type": "string",
        "minLength": 1,
        "maxLength": 26,
        "example": "pl4a4aa4jzydksmrf3jnu5yfcw",
        "description": "Globally unique Id of the resource.",
        "readOnly": true
      },
      "Resource_Management_APIs_activation-metadata": {
        "title": "ActivationMetadata",
        "type": "object",
        "description": "Activation metadata associated to a resource.",
        "properties": {
          "version": {
            "type": "string",
            "example": "1.0",
            "description": "The version of the resource",
            "readOnly": true
          },
          "lastModifiedTime": {
            "type": "string",
            "format": "date-time",
            "example": "2016-06-13T19:49:31.686Z",
            "description": "The time at which the resource was last modified",
            "readOnly": true
          },
          "creationTime": {
            "type": "string",
            "format": "date-time",
            "example": "2016-06-13T19:49:31.686Z",
            "description": "The time at which the resource was created",
            "readOnly": true
          },
          "activationTime": {
            "type": "string",
            "format": "date-time",
            "example": "2016-06-13T19:49:31.686Z",
            "description": "The time at which the resource was activated.  This vaue will only be present if the entity has an active status.",
            "readOnly": true
          },
          "deactivationTime": {
            "type": "string",
            "format": "date-time",
            "example": "2016-06-13T19:49:31.686Z",
            "description": "The time at which the resource was deactivated.  This vaue will only be present if the entity has an inactive status.",
            "readOnly": true
          }
        }
      },
      "Resource_Management_APIs_api-error": {
        "title": "ApiError",
        "type": "object",
        "description": "API error object",
        "x-examples": {
          "Example 1": {
            "code": "invalid_request",
            "message": "The request was invalid",
            "ticket": "11t7n71hi5e6t"
          }
        },
        "properties": {
          "type": {
            "type": "string",
            "example": "base_error",
            "minLength": 1,
            "description": "The type of the API error.",
            "readOnly": true
          },
          "code": {
            "type": "string",
            "example": "invalid_request",
            "minLength": 1,
            "description": "A code identifying the error that occurred.",
            "readOnly": true
          },
          "message": {
            "type": "string",
            "example": "The request was invalid",
            "description": "A free text message describing the error.  This error message is only meant to help developers understand the cause of the error.  It should not be used for programmatic purposes.",
            "readOnly": true
          },
          "ticket": {
            "type": "string",
            "example": "11t7n71hi5e6t",
            "description": "Ticket that can help correlate the error to the backend",
            "readOnly": true
          },
          "details": {
            "type": "object",
            "description": "A map of details about the error. The keys are defined by the API.",
            "additionalProperties": {},
            "example": {
              "attemptsRemaining": 4
            }
          }
        },
        "required": [
          "type",
          "code"
        ]
      },
      "Resource_Management_APIs_constraint-violations-api-error": {
        "title": "ConstraintViolationsApiError",
        "description": "An API error that occurred due to a constraint violation",
        "allOf": [
          {
            "$ref": "#/components/schemas/Resource_Management_APIs_api-error"
          },
          {
            "type": "object",
            "readOnly": true,
            "required": [
              "violations"
            ],
            "properties": {
              "violations": {
                "type": "object",
                "readOnly": true,
                "required": [
                  "code"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "A code identifying the constraint violation.",
                    "minLength": 1,
                    "example": "too_long"
                  },
                  "constraintAttributes": {
                    "type": "object",
                    "description": "A map of constraint attribute values.",
                    "additionalProperties": {
                      "type": "string"
                    },
                    "example": {
                      "maxLength": "10"
                    }
                  }
                }
              }
            }
          }
        ],
        "x-examples": {
          "Example 1": {
            "type": "constraint_violations_error",
            "code": "message_body_constraint_violations",
            "message": "The request contained invalid fields",
            "ticket": "11t7n71hi5e6t",
            "violations": {
              "field1": {
                "code": "too_long",
                "constraintAttributes": {
                  "maxLength": "10"
                }
              },
              "field2": {
                "code": "not_null"
              }
            }
          }
        }
      }
    },
    "examples": {
      "Resource_Management_APIs_Application": {
        "description": "Basic example of an application JSON object with all fields present.",
        "value": {
          "id": "a4jzydksmrf3jnu5yfcwpl4a4a",
          "workspaceId": "4a4aa4jzydksmrf3jnu5yfcwpl",
          "vanityDomain": "yourapp-yourorg.us.wristband.dev",
          "resolvedVanityDomain": "auth.yourapp.com",
          "domainName": "yourapp",
          "name": "yourapp",
          "displayName": "Your Application",
          "isMultiTenant": true,
          "tenantClassifier": "ORGANIZATION",
          "environmentType": "DEVELOPMENT",
          "loginUrl": "https://{tenant_name}.yourapp.com/auth/login",
          "loginUrlContainsTenantDomainToken": true,
          "loginUrlContainsTenantSubdomainPlaceholder": true,
          "loginUrlTenantDomainSuffix": "yourapp.com",
          "fallbackLoginUrl": "https://yourapp.com/auth/login",
          "logoutUrls": [
            "https://yourapp.com/auth/logout"
          ],
          "allowedOrigins": [
            "https://*.yourapp.com"
          ],
          "signupEnabled": true,
          "authorizationRequestsEnabled": true,
          "customApplicationSignupPageUrl": "https://yourapp.com/app-signup",
          "customTenantSignupPageUrl": "https://yourapp.com/tenant-signup",
          "customApplicationLoginPageUrl": "https://yourapp.com/app-login",
          "customTenantLoginPageUrl": "https://yourapp.com/tenant-login",
          "customApplicationErrorPageUrl": "https://yourapp.com/app-error",
          "customTenantErrorPageUrl": "https://yourapp.com/tenant-error",
          "customExternalIdpApplicationSignupPageUrl": "https://yourapp.com/external-idp-app-signup",
          "customExternalIdpTenantSignupPageUrl": "https://yourapp.com/external-idp-tenant-signup",
          "customExternalIdpLoginPageUrl": "https://yourapp.com/external-idp-login",
          "customExternalIdpInvitePageUrl": "https://yourapp.com/external-idp-invite",
          "customExternalIdpChangeEmailPageUrl": "https://yourapp.com/external-idp-change-email",
          "status": "ACTIVE",
          "metadata": {
            "version": "0.0",
            "lastModifiedTime": "2021-06-13T19:49:31.686Z",
            "creationTime": "2021-06-13T19:49:31.686Z",
            "activationTime": "2021-06-13T19:49:31.686Z",
            "deactivationTime": "2021-06-13T19:49:31.686Z"
          }
        }
      }
    },
    "headers": {
      "Resource_Management_APIs_ETag": {
        "schema": {
          "type": "string",
          "example": "1.0",
          "minLength": 1
        },
        "description": "The version of the resource"
      }
    },
    "responses": {
      "Resource_Management_APIs_304": {
        "description": "Not Modified",
        "headers": {
          "ETag": {
            "$ref": "#/components/headers/Resource_Management_APIs_ETag"
          }
        }
      },
      "Resource_Management_APIs_401": {
        "description": "Unauthorized",
        "headers": {
          "WWW-Authenticate": {
            "description": "Includes details on the failed authentication condition. This header is set in accordance with the [OAuth2 specification](https://datatracker.ietf.org/doc/html/rfc6750#section-3).",
            "schema": {
              "type": "string",
              "example": "Bearer error=\"invalid_token\", error_description=\"The provided access token was invalid\""
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Resource_Management_APIs_api-error"
            },
            "examples": {
              "code - unauthenticated": {
                "value": {
                  "type": "base_error",
                  "code": "invalid_access_token",
                  "message": "The provided access token was invalid",
                  "ticket": "1u0d0edhwbjsd"
                }
              }
            }
          }
        }
      },
      "Resource_Management_APIs_403": {
        "description": "Forbidden",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Resource_Management_APIs_api-error"
            },
            "examples": {
              "code - unauthorized": {
                "value": {
                  "type": "base_error",
                  "code": "unauthorized",
                  "message": "The request failed authorization",
                  "ticket": "11t7n71hi5e6t"
                }
              }
            }
          }
        }
      },
      "Resource_Management_APIs_405": {
        "description": "Method Not Allowed",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Resource_Management_APIs_api-error"
            },
            "examples": {
              "code - method_not_supported": {
                "value": {
                  "type": "base_error",
                  "code": "method_not_supported",
                  "message": "The specified HTTP method is not supported",
                  "ticket": "11t7n71hi5e6t"
                }
              }
            }
          }
        }
      },
      "Resource_Management_APIs_406": {
        "description": "Not Acceptable",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Resource_Management_APIs_api-error"
            },
            "examples": {
              "code - not_acceptable": {
                "value": {
                  "type": "base_error",
                  "code": "not_acceptable",
                  "message": "The Accept header was invalid",
                  "ticket": "11t7n71hi5e6t"
                }
              }
            }
          }
        }
      },
      "Resource_Management_APIs_500": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Resource_Management_APIs_api-error"
            },
            "examples": {
              "code - internal_server_failure ": {
                "value": {
                  "type": "base_error",
                  "code": "internal_server_failure",
                  "message": "An unexpected error occurred while processing the request",
                  "ticket": "11t7n71hi5e6t"
                }
              }
            }
          }
        }
      },
      "Resource_Management_APIs_503": {
        "description": "Service Unavailable",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Resource_Management_APIs_api-error"
            },
            "examples": {
              "code - service_unavailable": {
                "value": {
                  "type": "base_error",
                  "code": "service_unavailable",
                  "message": "The service is currently unavailable",
                  "ticket": "11t7n71hi5e6t"
                }
              }
            }
          }
        }
      },
      "Resource_Management_APIs_400-default": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/Resource_Management_APIs_api-error"
                },
                {
                  "$ref": "#/components/schemas/Resource_Management_APIs_constraint-violations-api-error"
                }
              ]
            },
            "examples": {
              "code - invalid_request": {
                "value": {
                  "type": "base_error",
                  "code": "invalid_request",
                  "message": "The request was invalid",
                  "ticket": "11t7n71hi5e6t"
                }
              },
              "code - request_constraint_violations": {
                "value": {
                  "type": "constraint_violations_error",
                  "code": "message_body_constraint_violations",
                  "message": "The message body contained invalid fields",
                  "ticket": "11t7n71hi5e6t",
                  "violations": {
                    "field1": {
                      "code": "too_long",
                      "constraintAttributes": {
                        "maxLength": 10
                      }
                    },
                    "field2": {
                      "code": "not_null"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "Resource_Management_APIs_404-application-not-found": {
        "description": "Not Found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Resource_Management_APIs_api-error"
            },
            "examples": {
              "code - application_not_found": {
                "value": {
                  "type": "base_error",
                  "code": "application_not_found",
                  "message": "Application could not be found",
                  "ticket": "11t7n71hi5e6t"
                }
              }
            }
          }
        }
      }
    }
  },
  "x-tagGroups": [
    {
      "name": "Resource Management APIs",
      "tags": [
        "Applications",
        "Auth Factors",
        "Auth Sessions",
        "Auth Session Policies",
        "Bot Detection Policies",
        "Custom Claims",
        "Custom Domains",
        "Email Brandings",
        "Email Domains",
        "Email Policies",
        "External IdP Profiles",
        "External IdP Tokens",
        "Identity Providers",
        "IdP Attribute Mappings",
        "IdP Role Mappings",
        "MFA Policies",
        "OAuth2 Clients",
        "Page Brandings",
        "Password Policies",
        "Permissions",
        "Permission Boundaries",
        "Permission Groups",
        "Refresh Tokens",
        "Remembered Tenants",
        "Roles",
        "Role Assignment Policies",
        "Signing Keys",
        "Tenants",
        "Users",
        "User Schemas",
        "Vanity Domains",
        "Webhook Policies",
        "Workflow Policies"
      ]
    }
  ]
}
```