SecurityAgent / Client / verify_target_domain

verify_target_domain¶

SecurityAgent.Client.verify_target_domain(**kwargs)¶

Initiates verification of a target domain. This checks whether the domain ownership verification token has been properly configured.

Request Syntax

response = client.verify_target_domain(
    targetDomainId='string'
)

Parameters:

targetDomainId (string) –

[REQUIRED]

The unique identifier of the target domain to verify.

Return type:

dict

Returns:

Response Syntax

{
    'targetDomainId': 'string',
    'domainName': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'verifiedAt': datetime(2015, 1, 1),
    'status': 'PENDING'|'VERIFIED'|'FAILED'|'UNREACHABLE',
    'verificationStatusReason': 'string'
}

Response Structure

(dict) –

Output for verifying ownership for a registered target domain in an agent space.
- targetDomainId (string) –
  
  The unique identifier of the target domain.
- domainName (string) –
  
  The domain name of the target domain.
- createdAt (datetime) –
  
  The date and time the target domain was created, in UTC format.
- updatedAt (datetime) –
  
  The date and time the target domain was last updated, in UTC format.
- verifiedAt (datetime) –
  
  The date and time the target domain was verified, in UTC format.
- status (string) –
  
  The verification status of the target domain.
- verificationStatusReason (string) –
  
  The reason for the current target domain verification status.