コンテンツにスキップ
Authrim

Start organization domain verification.

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

Starts DNS TXT verification for a domain mapping after validating mapping id, domain format, verification method, and that the supplied domain hashes to the stored mapping domain.

Authorizations

Section titled “Authorizations ”

Request Body required

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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Organization domain mapping DNS verification challenge response.

Media type application/json
object
mapping_id
required
string
record_name
required
string
record_value
required
string
expires_at
required
integer format: int64
expires_in_seconds
required
integer
instructions
required
string
key
additional properties
Example 
{
  "mapping_id": "mapping_123",
  "record_name": "_authrim.example.com",
  "record_value": "authrim-domain-verification=abc123",
  "expires_at": 1770003600,
  "expires_in_seconds": 3600,
  "instructions": "Add a TXT record to your DNS configuration."
}

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"
}