{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book API - Domain Management API", "version": "1.0.0" }, "items": [ { "info": { "name": "API - Domain Management", "type": "folder" }, "items": [ { "info": { "name": "Get Domain Verification Token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/identity/organizations/:orgId/actions/getDomainVerificationToken", "params": [ { "name": "orgId", "value": "bf732c85-68ca-4867-94e4-937286ad2fd4", "type": "path", "description": "The Webex Identity-assigned organization identifier for a user's organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint helps generate a token for a given domain within the specified organization. The user needs to add this token as a 'TXT' record to the DNS server.\n\n**Possible Error:**\n\n- 409: The request encountered a resource conflict. This error occurs if the domain is either claimed by another organization or by the same organization.\n\n**Authorization:**\n\nAn 'OAuth' token issued by the 'Identity Broker' is required to access this endpoint. The token must include one of the following scopes:\n\n- " }, { "info": { "name": "Verify Domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/identity/organizations/:orgId/actions/verifyDomain", "params": [ { "name": "orgId", "value": "bf732c85-68ca-4867-94e4-937286ad2fd4", "type": "path", "description": "The Webex Identity-assigned organization identifier for a user's organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\nOnce 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.\n\nIf you want to verify and claim the domain, just set the 'claimDomain' parameter to true. By default, it's set to false, which will on" }, { "info": { "name": "Claim Domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/identity/organizations/:orgId/actions/claimDomain", "params": [ { "name": "orgId", "value": "bf732c85-68ca-4867-94e4-937286ad2fd4", "type": "path", "description": "The Webex Identity-assigned organization identifier for a user's organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint helps claim the given domain within the specified organization. The domain needs to be verified before it can be claimed.\n\n**Note**\n\n\nThere'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.\nCustomers can still create users within the organization who don't use the verified domains as their email. However, if " }, { "info": { "name": "Unverify Domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/identity/organizations/:orgId/actions/unverifyDomain", "params": [ { "name": "orgId", "value": "bf732c85-68ca-4867-94e4-937286ad2fd4", "type": "path", "description": "The Webex Identity-assigned organization identifier for a user's organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "After you unclaim the domain, it will still be verified. Domain enforcement will still apply to the organization. The unverify endpoint helps to remove the domain ownership verification for the organization.\n\n**Possible Error:**\n\n- 400: The request was a Bad Request. The domain cannot be unverified. This error occurs if the domain is still claimed.\n\n- 404: The request was Not Found. This error occurs if the domain is not associated with the organization.\n\n**Authorization:**\n\nAn 'OAuth' token iss" }, { "info": { "name": "Unclaim Domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/identity/organizations/:orgId/actions/unclaimDomain", "params": [ { "name": "orgId", "value": "bf732c85-68ca-4867-94e4-937286ad2fd4", "type": "path", "description": "The Webex Identity-assigned organization identifier for a user's organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API is used to unclaim a domain for the organization. The domain will remain verified, and domain enforcement will still apply to the given organization.\n\n**Possible Error:**\n\n- 400: The request was a Bad Request. The domain cannot be unclaimed. This error occurs if the requested parameter is invalid.\n\n**Authorization:**\n\nAn 'OAuth' token issued by the 'Identity Broker' is required to access this endpoint. The token must include one of the following scopes:\n\n- `Identity:Organization`\n\n- `id" } ] } ], "bundled": true }