This API performs DNS lookups to verify whether the DNS records associated
to the custom domain are valid. The status of the custom domain and its
corresponding DNS records will be updated accordingly. In order for the
custom domain status to transition to VERIFIED all of the DNS records associated to
the custom domain must have a status of VERIFIED. If the custom domain is VERIFIED
but some of the DNS records become invalid then the custom domain status will transition to
VERIFIED_WITH_ERRORS. In this state the custom domain can still be used but may encounter
issues in the future due to the invalid DNS records.
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:verify | Application | The subject can verify custom domains under the application that the subject belongs to. |
| Tenant | The subject can verify custom domains associated to the tenant that the subject belongs to. | |
| Tenant Inclusion List | The subject can verify custom domains associated to tenants specified in the tenant inclusion list. | |
| Tenant Exclusion List | The subject can verify custom domains associated to tenants that belong to the subject's application but are not included in the tenant exclusion list. |