List the authenticated domain associated with the given user.

v1.0.0

This endpoint allows you to retrieve all of the authenticated domains that have been assigned to a specific subuser.

Authenticated domains can be associated with (i.e. assigned to) subusers from a parent account. This functionality allows subusers to send mail using their parent's domain authentication. To associate an authenticated domain with a subuser, the parent account must first authenticate and validate the domain. The parent may then associate the authenticated domain via the subuser management tools.

Input

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    }
  },
  "required": [
    "username"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "automatic_security",
    "custom_spf",
    "default",
    "dns",
    "domain",
    "id",
    "ips",
    "legacy",
    "user_id",
    "username",
    "valid"
  ],
  "properties": {
    "automatic_security": {
      "type": "boolean",
      "description": "Indicates if this authenticated domain uses automated security."
    },
    "custom_spf": {
      "type": "boolean",
      "description": "Indicates if this authenticated domain uses custom SPF."
    },
    "default": {
      "type": "boolean",
      "description": "Indicates if this is the default domain."
    },
    "dns": {
      "type": "object",
      "description": "The DNS records for this authenticated domain.",
      "required": [
        "dkim",
        "domain_spf",
        "mail_server",
        "subdomain_spf"
      ],
      "properties": {
        "dkim": {
          "type": "object",
          "description": "The DKIM record for messages sent using this authenticated domain.",
          "required": [
            "data",
            "host",
            "type",
            "valid"
          ],
          "properties": {
            "data": {
              "type": "string",
              "description": "The DKIM record."
            },
            "host": {
              "type": "string",
              "description": "The DNS labels for the DKIM signature."
            },
            "type": {
              "type": "string",
              "description": "The type of data in the DKIM record."
            },
            "valid": {
              "type": "boolean",
              "description": "Indicates if the DKIM record is valid."
            }
          }
        },
        "domain_spf": {
          "type": "object",
          "description": "The SPF record for the root domain.",
          "required": [
            "data",
            "host",
            "type",
            "valid"
          ],
          "properties": {
            "data": {
              "type": "string",
              "description": "The SPF record."
            },
            "host": {
              "type": "string",
              "description": "The root domain that this SPF record will be used to authenticate."
            },
            "type": {
              "type": "string",
              "description": "The type of data in the SPF record."
            },
            "valid": {
              "type": "boolean",
              "description": "Indicates if the SPF record is valid."
            }
          }
        },
        "mail_server": {
          "type": "object",
          "description": "Designates which mail server is responsible for accepting messages from a domain.",
          "required": [
            "data",
            "host",
            "type",
            "valid"
          ],
          "properties": {
            "data": {
              "type": "string",
              "description": "The mail server responsible for accepting messages from the sending domain."
            },
            "host": {
              "type": "string",
              "description": "The domain sending the messages."
            },
            "type": {
              "type": "string",
              "description": "They type of DNS record."
            },
            "valid": {
              "type": "boolean",
              "description": "Indicates if this is a valid DNS record."
            }
          }
        },
        "subdomain_spf": {
          "type": "object",
          "description": "The SPF record for the subdomain used to create this authenticated domain.",
          "required": [
            "data",
            "host",
            "type",
            "valid"
          ],
          "properties": {
            "data": {
              "type": "string",
              "description": "The SPF record."
            },
            "host": {
              "type": "string",
              "description": "The domain that this SPF record will be used to authenticate."
            },
            "type": {
              "type": "string",
              "description": "The type of data in the SPF record."
            },
            "valid": {
              "type": "boolean",
              "description": "Indicates if this is a valid SPF record."
            }
          }
        }
      }
    },
    "domain": {
      "type": "string",
      "description": "The domain authenticated."
    },
    "id": {
      "type": "integer",
      "description": "The ID of the authenticated domain."
    },
    "ips": {
      "type": "array",
      "description": "The IP addresses that are included in the SPF record for this authenticated domain.",
      "items": {
        "type": "object"
      }
    },
    "legacy": {
      "type": "boolean",
      "description": "Indicates if this authenticated domain was created using the legacy whitelabel tool. If it is a legacy whitelabel, it will still function, but you'll need to create a new authenticated domain if you need to update it."
    },
    "subdomain": {
      "type": "string",
      "description": "The subdomain that was used to create this authenticated domain."
    },
    "user_id": {
      "type": "integer",
      "description": "The user_id of the account that this authenticated domain is associated with."
    },
    "username": {
      "type": "string",
      "description": "The username of the account that this authenticated domain is associated with."
    },
    "valid": {
      "type": "boolean",
      "description": "Indicates if this is a valid authenticated domain ."
    }
  }
}