Domain verification lets you prove ownership of an email domain so you can create users directly within your tenant — without sending invitation emails. Once a domain is verified, any user with a matching email address can be created via the Create user endpoint.
- Register your domain in Aritma IAM — you receive a DNS TXT verification token
- Publish the token as a DNS TXT record at your domain registrar
- Aritma checks for the record and marks the domain as
Confirmed - You can now create users directly for email addresses on that domain
- Mock serverhttps://developer.aritma.com/_mock/apis/platform/iam/openapi/iam-openapi/v1/domains
- IAM APIhttps://api.dev.aritma.io/core/iam/v1/domains
curl -i -X GET \
'https://developer.aritma.com/_mock/apis/platform/iam/openapi/iam-openapi/v1/domains?filter=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'- Mock serverhttps://developer.aritma.com/_mock/apis/platform/iam/openapi/iam-openapi/v1/domains
- IAM APIhttps://api.dev.aritma.io/core/iam/v1/domains
curl -i -X POST \
'https://developer.aritma.com/_mock/apis/platform/iam/openapi/iam-openapi/v1/domains?domain=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'The response includes a verificationToken — a DNS TXT record value you must publish at your domain registrar:
{
"domain": "example.com",
"status": "Pending",
"verificationToken": "aritma-verify-00000000-0000-0000-0000-000000000000"
}Add a TXT record to your DNS with the value of verificationToken. The record name is typically @ (root) or a subdomain specified by your registrar.
DNS changes can take up to 48 hours to propagate. The verification token is removed from the response once the domain is confirmed.
Poll this endpoint to check whether verification has completed:
- Mock serverhttps://developer.aritma.com/_mock/apis/platform/iam/openapi/iam-openapi/v1/domains/status
- IAM APIhttps://api.dev.aritma.io/core/iam/v1/domains/status
curl -i -X GET \
'https://developer.aritma.com/_mock/apis/platform/iam/openapi/iam-openapi/v1/domains/status?domain=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'| Status | Description |
|---|---|
Pending | The domain is registered but the DNS TXT record has not been verified yet |
Confirmed | The domain is verified — you can now create users directly |
NotRegistered | The domain is not registered on this tenant |
- Mock serverhttps://developer.aritma.com/_mock/apis/platform/iam/openapi/iam-openapi/v1/domains
- IAM APIhttps://api.dev.aritma.io/core/iam/v1/domains
curl -i -X DELETE \
'https://developer.aritma.com/_mock/apis/platform/iam/openapi/iam-openapi/v1/domains?domain=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Unregistering a domain does not affect existing users. However, you will no longer be able to create new users directly for email addresses on that domain until you re-register and re-verify it.