Site Home
API Reference
LoginTry for Free

Patch Application

patch
https://{application_vanity_domain}/api/v1/applications/
Path Params
string
required
length between 1 and 26

The ID of the application that the resource or action is scoped to.

Body Params

Application patch request adhering to the JSON Merge Patch specification.

string
string
length between 3 and 20
deprecated

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.

Name of the application. The name must be unique (case-insensitive) within a workspace.

string
length between 3 and 20

[Required on Create] Name of the application. The name must be unique (case-insensitive) within a workspace.

string
length between 1 and 60

[Required on Create] A friendly name given to an application for display purposes.

boolean

[Required on Create] Boolean indicating whether this application allows support for multiple tenants.

string
enum
length between 1 and 45
Defaults to TENANT

The default classifier that will be applied to the application's tenants.

Allowed:
string
enum
length between 1 and 45

[Required on Create] The application's environment type.

Allowed:
uri
length between 1 and 2000

[Required on Create] The application's login URL that can be called to initiate an authorization flow. The {tenant_domain} placeholder can be used as the left most domain label. The {tenant_domain} placeholder will be substituted with the current tenant's name when the login URL is redirected to.

logoutUrls
array of uris
length ≤ 10

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_domain} placeholder can be used as the left most domain label. The {tenant_domain} placeholder will be substituted with the current tenant's name when the logout URL is redirected to.

logoutUrls
allowedOrigins
array of uris
length ≤ 5

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.

allowedOrigins
boolean
Defaults to true

Boolean indicating whether signup is enabled for an application.

uri
length between 1 and 2000

Custom application-level signup page URL for self-hosted signup UI.

uri
length between 1 and 2000

Custom tenant-level signup page URL for self-hosted signup UI. The {tenant_domain} placeholder can be used as the left most domain label. The {tenant_domain} placeholder will be substituted with the current tenant's name when the URL is redirected to.

uri
length between 1 and 2000

Custom application-level login page URL for self-hosted signup UI.

uri
length between 1 and 2000

Custom tenant-level login page URL for self-hosted login UI. The {tenant_domain} placeholder can be used as the left most domain label. The {tenant_domain} placeholder will be substituted with the current tenant's name when the URL is redirected to.

uri
length between 1 and 2000

Custom application level error page URL for self-hosted error page UI.

uri
length between 1 and 2000

Custom tenant-level error page URL for self-hosted error page UI. The {tenant_domain} placeholder can be used as the left most domain label. The {tenant_domain} placeholder will be substituted with the current tenant's name when the URL is redirected to.

uri
length between 1 and 2000

Custom application-level external IdP signup page URL for self-hosted external IdP signup UI.

uri
length between 1 and 2000

Custom tenant-level external IdP signup page URL for self-hosted external IdP signup UI. The {tenant_domain} placeholder can be used as the left most domain label. The {tenant_domain} placeholder will be substituted with the current tenant's name when the URL is redirected to.

uri
length between 1 and 2000

Custom external IdP login page URL for self-hosted external IdP login UI. The {tenant_domain} placeholder can be used as the left most domain label. The {tenant_domain} placeholder will be substituted with the current tenant's name when the URL is redirected to.

uri
length between 1 and 2000

Custom external IdP invite page URL for self-hosted external IdP invite UI. The {tenant_domain} placeholder can be used as the left most domain label. The {tenant_domain} placeholder will be substituted with the current tenant's name when the URL is redirected to.

uri
length between 1 and 2000

Custom external IdP change email page URL for self-hosted external IdP change email UI. The {tenant_domain} placeholder can be used as the left most domain label. The {tenant_domain} placeholder will be substituted with the current tenant's name when the URL is redirected to.

string
enum
length between 1 and 45
Defaults to ACTIVE

The status of the application

Allowed:
string
Headers
string
length ≥ 1

Used to perform a conditional update

Responses

Updated 6 months ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago