Add Domain

post

https://{region}.api.jamfcloud.com/sso/v1/domains

Claims a domain for the organization resolved from the access token and returns it with the verificationKey to publish. The domain is created in PENDING status and cannot be assigned to a connection until it has been verified.

Publish the returned verificationKey as a TXT record on the domain, then call POST /domains/{domainId}/actions/verify.

Only the domain field is read from the request body — every other field is assigned by Jamf and is ignored if supplied. A domain already claimed by this organization is rejected with 409; a domain already verified by a different organization is rejected on verification, not here.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The claimed domain, including the verificationKey to publish. No Location header is returned; the created domain is in the body.

400Bad Request. A field failed validation (FIELD_VALIDATION, with field naming it), the request was rejected for another reason the caller can correct (BAD_REQUEST), or the body could not be parsed as JSON (MALFORMED_REQUEST_BODY).

401Unauthorized. The access token is missing, invalid, or expired. The API Gateway rejects the request before it reaches the service.

403Forbidden. The token is not an external M2M token, or it does not carry the privilege required to reach this endpoint.

409Conflict. The domain is already claimed by this organization, or it has already been verified by a different organization. A domain can only be verified by one organization at a time.

500Internal Server Error. The organization in the token could not be resolved, or an upstream dependency failed. The description is deliberately generic; quote traceId when reporting the failure.