Domains

Confirm authorisation to assess

Records that the acting user confirmed the current scan policy's statement for this verified domain. The record is immutable and names the policy and statement versions. A new policy version requires a new confirmation.

post/v1/domains/{domainId}/authorisation

Request

  • Base URL: https://api.ironfang.com/security
  • URL: https://api.ironfang.com/security/v1/domains/{domainId}/authorisation
  • Auth: HTTP bearer

Request body

confirmtrue required
policy_versionstring required
statement_versionstring required

Response

The domain with its authorisation.

authorisedboolean required
can_scanboolean required
created_atstring date-time required
display_namestring required
idstring uuid required
namestring required

ASCII (punycode) name.

next_scan_atstring date-time

When the cooldown ends.

scan_blocked_reason'verification_required' | 'authorisation_required' | 'policy_outdated' | 'scan_in_progress' | 'scan_cooldown' | 'daily_limit_reached' | 'organisation_suspended' | 'scans_paused' | 'security_disabled'

Why a scan cannot start now.

verification_status'waiting' | 'checking' | 'verified' | 'failed' | 'expired' | 'lapsed' required
discoveriesinteger required

Number of discovered names.

Changes

No recorded changes to this operation across all 1 revision of this API.