Verify Domain
This endpoint helps verify a given domain within the specified organization. This API verifies domain ownership by looking up and validating the TXT record for the domain. Once verified, domain enforcement will be applied to the organization. Any users in the organization whose email domain doesn't match one of the verified domains will be marked as transient.
If you want to verify and claim the domain, just set the claimDomain parameter to true. By default, it's set to false, which will only verify the domain.
Possible Errors:
400: The request was a bad one. The domain can't be verified. This error happens if the user didn't request a token before trying to verify the domain.
409: The request resulted in a resource conflict. This error occurs if the domain has already been claimed by another organization.
Authorization:
An OAuth token issued by the Identity Broker is required to access this endpoint. The token must include one of the following scopes:
identity:organizations_rw
Administrator Roles:
The following administrators can use this API:
id_full_admin
URI Parameters
The Webex Identity-assigned organization identifier for a user's organization.
Body Parameters
The domain name to be verified.
A boolean to specify whether the domain needs to be claimed. The default value is false. If false, the domain will be verified but not claimed.
For FedRAMP only: If true, add the domain to the FedRAMP reserved domain list. The default value is false.
Response Properties
A list of verified domains for a given organization.
A list of claimed domains for a given organization.
Use this URL for verifying domain ownership and managing the domain lifecycle within the organization.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Body
- The domain name to be verified.
- A boolean to specify whether the domain needs to be claimed. The default value is false. If false, the domain will be verified but not claimed.
- For FedRAMP only: If true, add the domain to the FedRAMP reserved domain list. The default value is false.
{
"domain": "cisco.com",
"claimDomain": false,
"reserveDomain": false
}{
"verifiedDomains": [
"cisco.com",
"webex.com"
],
"claimedDomains": [
"cisco.com",
"webex.com"
],
"url": "https://identity.webex.com/organization/bf732c85-68ca-4867-94e4-937286ad2fd4/v1/actions/DomainVerification/Verify/invoke"
}