Claim Domain
This endpoint helps claim the given domain within the specified organization. The domain needs to be verified before it can be claimed.
Note
There's an organization-level boolean flag called enforceVerifiedDomains. If this flag is set to false, we won't put any user in the organization into a transient state when verifying or claiming a domain. Customers can still create users within the organization who don't use the verified domains as their email. However, if the flag is set to true, all users in the organization must use one of the verified domains as their email. This flag defines whether the organization enforces user email verification within the organization. If set to true, all users inside the organization must use one of the verified domains. This flag is effective only after the admin has verified at least one email domain.
Possible Error:
- 400: The request was a bad one. This error occurs if the domain is not verified.
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
A List of valid domain name that is already verified by the organization.
A valid domain name that is already verified by the organization.
Indicate if the domain should be claimed when there are users outside the organization using the same domain. The default is true.
Indicate to just claim the domain only without searching/marking external users as transient. The default is false.
Response Properties
A list of verified domains for a given organizations.
Use this location URL for the domain resource. The resource component of the URL will be the base64 encoded domain name.
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
- A List of valid domain name that is already verified by the organization.
- Indicate if the domain should be claimed when there are users outside the organization using the same domain. The default is true.
- Indicate to just claim the domain only without searching/marking external users as transient. The default is false.
{
"data": [
{
"domain": "cisco.com"
}
],
"forceDomainClaim": true,
"claimDomainOnly": false
}{
"data": [
{
"domain": "cisco.com",
"url": "https://identity.webex.com/organizations/bf732c85-68ca-4867-94e4-937286ad2fd4/v1/domains/ZXhhbXBsZTMuY29t"
}
]
}