コンテンツにスキップ
Authrim

Start tenant domain mapping DNS verification.

POST
/api/admin/platform/tenant-domain-mappings/verify
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/platform/tenant-domain-mappings/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "mapping_123", "domain": "example.com" }'

Generate and store a DNS TXT verification token for a tenant domain mapping, returning the TXT record name, value, type, and expiration timestamp that must be published before confirmation.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
id
required
string
domain
required
string
<= 253 characters
key
additional properties
Example 
{
  "id": "mapping_123",
  "domain": "example.com"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Tenant domain mapping DNS verification challenge response.

Media type application/json
object
id
required
string
dns_record_name
required
string
dns_record_value
required
string
dns_record_type
required
string
Allowed values: TXT
expires_at
required
integer format: int64
key
additional properties
Example 
{
  "id": "mapping_123",
  "dns_record_name": "_authrim.example.com",
  "dns_record_value": "authrim-domain-verification=abc123",
  "dns_record_type": "TXT",
  "expires_at": 1770003600
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}