iam_account

APIs.ioEngineeringPlatform

Properties

Name Type Description
created_on string Timestamp for the creation of the account
id object
name string Account name
settings object Account settings
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-iam-account-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/iam_account",
  "title": "iam_account",
  "properties": {
    "created_on": {
      "description": "Timestamp for the creation of the account",
      "example": "2014-03-01T12:21:02.0000Z",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "$ref": "#/components/schemas/iam_common_components-schemas-identifier"
    },
    "name": {
      "description": "Account name",
      "example": "Demo Account",
      "maxLength": 100,
      "type": "string"
    },
    "settings": {
      "description": "Account settings",
      "properties": {
        "abuse_contact_email": {
          "description": "Sets an abuse contact email to notify for abuse reports.",
          "type": "string"
        },
        "default_nameservers": {
          "default": "cloudflare.standard",
          "description": "Specifies the default nameservers to be used for new zones added to this account.\n\n- `cloudflare.standard` for Cloudflare-branded nameservers\n- `custom.account` for account custom nameservers\n- `custom.tenant` for tenant custom nameservers\n\nSee [Custom Nameservers](https://developers.cloudflare.com/dns/additional-options/custom-nameservers/)\nfor more information.",
          "enum": [
            "cloudflare.standard",
            "custom.account",
            "custom.tenant"
          ],
          "type": "string"
        },
        "enforce_twofactor": {
          "default": false,
          "description": "Indicates whether membership in this account requires that\nTwo-Factor Authentication is enabled",
          "type": "boolean"
        },
        "use_account_custom_ns_by_default": {
          "default": false,
          "deprecated": true,
          "description": "Indicates whether new zones should use the account-level custom\nnameservers by default.\n\nDeprecated in favor of `default_nameservers`.",
          "type": "boolean"
        }
      },
      "type": "object"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}