post https://{application_vanity_domain}/api/v1/custom-domains//activate
Activates the specified custom domain. When a custom domain is active, it will be used in the following places:
- For redirects to Wristband-hosted pages
- For action links in emails
- For the issuer URL inside access and ID tokens
- For the default OAuth 2 and SIWA IdP redirect URLs
- For the default SAML 2 SP URLs.
- For the endpoint URLs returned from the
/.well-known/openid-configurationAPI.
Note, a custom domain can only be activated if it has a state of VERIFIED or VERIFIED_WITH_ERRORS. Also, only one custom domain can be active for a single owner at a time. If the activate API is called and another custom domain is active for the same owner, the other custom domain will be deactivated during this API call.
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 |
|---|---|---|
| custom-domain:manage-activation | Application | The subject can activate custom domains under the application to which the subject belongs. |
| Tenant | The subject can activate custom domains associated with the tenant to which it belongs. | |
| Tenant Inclusion List | The subject can activate custom domains associated with tenants specified in the tenant inclusion list. | |
| Tenant Exclusion List | The subject can activate custom domains associated with tenants in the subject's application that are not on the tenant exclusion list. |