Resource URL: /platform/<<version=1>>/zones

    Overview: This resource applies the standard collection pattern to access
              zones.

     Methods: GET, POST

********************************************************************************

Method GET: List all access zones.

       URL: GET /platform/<<version=1>>/zones

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "zones": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Specifies properties for access zones.", 
            "properties": {
              "syslog_forwarding_enabled": {
                "type": "boolean", 
                "description": "Determines if access zone events are forwarded to the syslog."
              }, 
              "alternate_system_provider": {
                "type": "string", 
                "description": "Specifies an alternate system provider."
              }, 
              "ifs_restricted": {
                "items": {
                  "type": "object", 
                  "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                  "properties": {
                    "type": {
                      "enum": [
                        "user", 
                        "group", 
                        "wellknown"
                      ], 
                      "type": "string", 
                      "description": "Specifies the type of persona, which must be combined with a name."
                    }, 
                    "id": {
                      "minLength": 0, 
                      "type": "string", 
                      "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                      "maxLength": 261
                    }, 
                    "name": {
                      "minLength": 0, 
                      "type": "string", 
                      "description": "Specifies the persona name, which must be combined with a type.", 
                      "maxLength": 255
                    }
                  }
                }, 
                "type": "array", 
                "description": "Specifies a list of users and groups that have read and write access to /ifs."
              }, 
              "syslog_audit_events": {
                "items": {
                  "type": "string"
                }, 
                "type": "array", 
                "description": "Specifies a list of audit operations to forward to the syslog."
              }, 
              "hdfs_keytab": {
                "type": "string", 
                "description": "Specifies the Kerberos keytab for HDFS authentication."
              }, 
              "skeleton_directory": {
                "type": "string", 
                "description": "Specifies the skeleton directory that is used for user home directories."
              }, 
              "id": {
                "type": "string", 
                "description": "Specifies the system-assigned ID for the access zone. This value is returned when an access zone is created through the POST method"
              }, 
              "system": {
                "type": "boolean", 
                "description": "True if the access zone is built-in."
              }, 
              "hdfs_ambari_namenode": {
                "type": "string", 
                "description": "Specifies the SmartConnect name of the cluster that will be used for the HDFS service."
              }, 
              "home_directory_umask": {
                "type": "integer", 
                "description": "Specifies the permissions set on automatically created user home directories."
              }, 
              "user_mapping_rules": {
                "items": {
                  "type": "string"
                }, 
                "type": "array", 
                "description": "Specifies the current ID mapping rules."
              }, 
              "map_untrusted": {
                "type": "string", 
                "description": "Maps untrusted domains to this NetBIOS domain during authentication."
              }, 
              "netbios_name": {
                "type": "string", 
                "description": "Specifies the NetBIOS name."
              }, 
              "webhdfs_enabled": {
                "type": "boolean", 
                "description": "True if WebHDFS is enabled on this access zone."
              }, 
              "path": {
                "type": "string", 
                "description": "Specifies the access zone base directory path."
              }, 
              "zone_id": {
                "type": "integer", 
                "description": "Specifies the access zone ID on the system."
              }, 
              "name": {
                "type": "string", 
                "description": "Specifies the access zone name."
              }, 
              "all_auth_providers": {
                "type": "boolean", 
                "description": "Enables all available authentication providers."
              }, 
              "hdfs_ambari_server": {
                "type": "string", 
                "description": "Specifies the valid hostname, FQDN, IPv4, or IPv6 string of the Ambari server."
              }, 
              "audit_failure": {
                "items": {
                  "type": "string"
                }, 
                "type": "array", 
                "description": "Specifies a list of failed operations to audit."
              }, 
              "auth_providers": {
                "items": {
                  "type": "string"
                }, 
                "type": "array", 
                "description": "Specifies the list of authentication providers available on this access zone."
              }, 
              "system_provider": {
                "type": "string", 
                "description": "Specifies the system provider for the access zone."
              }, 
              "create_path": {
                "type": "boolean", 
                "description": "Determines if a path is created when a path does not exist."
              }, 
              "protocol_audit_enabled": {
                "type": "boolean", 
                "description": "Determines if I/O auditing is enabled on this access zone."
              }, 
              "hdfs_root_directory": {
                "type": "string", 
                "description": "Specifies the root directory for the HDFS protocol."
              }, 
              "audit_success": {
                "items": {
                  "type": "string"
                }, 
                "type": "array", 
                "description": "Specifies a list of successful operations to audit."
              }, 
              "hdfs_authentication": {
                "enum": [
                  "all", 
                  "simple_only", 
                  "kerberos_only"
                ], 
                "type": "string", 
                "description": "Specifies the authentication type for HDFS protocol."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}

********************************************************************************

Method POST: Create a new access zone.

        URL: POST /platform/<<version=1>>/zones

There are no query arguments for this method.

Required POST request body fields:
name

POST request body schema:
{
  "type": "object", 
  "description": "Specifies properties for access zones.", 
  "properties": {
    "syslog_forwarding_enabled": {
      "type": "boolean", 
      "description": "Determines if access zone events are forwarded to the syslog."
    }, 
    "alternate_system_provider": {
      "type": "string", 
      "description": "Specifies an alternate system provider."
    }, 
    "ifs_restricted": {
      "items": {
        "type": "object", 
        "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
        "properties": {
          "type": {
            "enum": [
              "user", 
              "group", 
              "wellknown"
            ], 
            "type": "string", 
            "description": "Specifies the type of persona, which must be combined with a name."
          }, 
          "id": {
            "minLength": 0, 
            "type": "string", 
            "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
            "maxLength": 261
          }, 
          "name": {
            "minLength": 0, 
            "type": "string", 
            "description": "Specifies the persona name, which must be combined with a type.", 
            "maxLength": 255
          }
        }
      }, 
      "type": "array", 
      "description": "Specifies a list of users and groups that have read and write access to /ifs."
    }, 
    "syslog_audit_events": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies a list of audit operations to forward to the syslog."
    }, 
    "skeleton_directory": {
      "type": "string", 
      "description": "Specifies the skeleton directory that is used for user home directories."
    }, 
    "hdfs_ambari_namenode": {
      "type": "string", 
      "description": "Specifies the SmartConnect name of the cluster that will be used for the HDFS service."
    }, 
    "home_directory_umask": {
      "type": "integer", 
      "description": "Specifies the permissions set on automatically created user home directories."
    }, 
    "user_mapping_rules": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies the current ID mapping rules."
    }, 
    "map_untrusted": {
      "type": "string", 
      "description": "Maps untrusted domains to this NetBIOS domain during authentication."
    }, 
    "netbios_name": {
      "type": "string", 
      "description": "Specifies the NetBIOS name."
    }, 
    "webhdfs_enabled": {
      "type": "boolean", 
      "description": "True if WebHDFS is enabled on this access zone."
    }, 
    "path": {
      "type": "string", 
      "description": "Specifies the access zone base directory path."
    }, 
    "name": {
      "required": true, 
      "type": "string", 
      "description": "Specifies the access zone name."
    }, 
    "all_auth_providers": {
      "type": "boolean", 
      "description": "Enables all available authentication providers."
    }, 
    "hdfs_ambari_server": {
      "type": "string", 
      "description": "Specifies the valid hostname, FQDN, IPv4, or IPv6 string of the Ambari server."
    }, 
    "audit_failure": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies a list of failed operations to audit."
    }, 
    "auth_providers": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies the list of authentication providers available on this access zone."
    }, 
    "system_provider": {
      "type": "string", 
      "description": "Specifies the system provider for the access zone."
    }, 
    "create_path": {
      "type": "boolean", 
      "description": "Determines if a path is created when a path does not exist."
    }, 
    "protocol_audit_enabled": {
      "type": "boolean", 
      "description": "Determines if I/O auditing is enabled on this access zone."
    }, 
    "hdfs_root_directory": {
      "type": "string", 
      "description": "Specifies the root directory for the HDFS protocol."
    }, 
    "audit_success": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies a list of successful operations to audit."
    }, 
    "hdfs_authentication": {
      "enum": [
        "all", 
        "simple_only", 
        "kerberos_only"
      ], 
      "type": "string", 
      "description": "Specifies the authentication type for HDFS protocol."
    }
  }
}

POST response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "id": {
          "minLength": 0, 
          "required": true, 
          "type": "string", 
          "description": "ID of created item that can be used to refer to item in the collection-item resource path.", 
          "maxLength": 255
        }
      }
    }
  ]
}
