Resource URL: /platform/<<version=3>>/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=3>>/zones

There are no query arguments for this method.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "zones": {
      "items": {
        "type": "object", 
        "description": "Specifies properties for access zones.", 
        "properties": {
          "map_untrusted": {
            "type": "string", 
            "description": "Maps untrusted domains to this NetBIOS domain during authentication."
          }, 
          "name": {
            "type": "string", 
            "description": "Specifies the access zone name."
          }, 
          "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": {
                  "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'."
                }, 
                "name": {
                  "type": "string", 
                  "description": "Specifies the persona name, which must be combined with a type."
                }
              }
            }, 
            "type": "array", 
            "description": "Specifies a list of users and groups that have read and write access to /ifs."
          }, 
          "alternate_system_provider": {
            "type": "string", 
            "description": "Specifies an alternate system provider."
          }, 
          "system": {
            "type": "boolean", 
            "description": "True if the access zone is built-in."
          }, 
          "netbios_name": {
            "type": "string", 
            "description": "Specifies the NetBIOS name."
          }, 
          "auth_providers": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies the list of authentication providers available on this access zone."
          }, 
          "home_directory_umask": {
            "type": "integer", 
            "description": "Specifies the permissions set on automatically created user home directories."
          }, 
          "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."
          }, 
          "path": {
            "type": "string", 
            "description": "Specifies the access zone base directory path."
          }, 
          "user_mapping_rules": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies the current ID mapping rules."
          }, 
          "cache_entry_expiry": {
            "type": "integer", 
            "description": "Specifies amount of time in seconds to cache a user/group."
          }, 
          "groupnet": {
            "type": "string", 
            "description": "Groupnet identitier"
          }, 
          "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"
          }, 
          "zone_id": {
            "type": "integer", 
            "description": "Specifies the access zone ID on the system."
          }
        }
      }, 
      "type": "array"
    }
  }
}

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

Method POST: Create a new access zone.

        URL: POST /platform/<<version=3>>/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": {
    "force_overlap": {
      "type": "boolean", 
      "description": "Allow for overlapping base path."
    }, 
    "map_untrusted": {
      "type": "string", 
      "description": "Maps untrusted domains to this NetBIOS domain during authentication."
    }, 
    "name": {
      "required": true, 
      "type": "string", 
      "description": "Specifies the access zone name."
    }, 
    "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": {
            "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'."
          }, 
          "name": {
            "type": "string", 
            "description": "Specifies the persona name, which must be combined with a type."
          }
        }
      }, 
      "type": "array", 
      "description": "Specifies a list of users and groups that have read and write access to /ifs."
    }, 
    "alternate_system_provider": {
      "type": "string", 
      "description": "Specifies an alternate system provider."
    }, 
    "netbios_name": {
      "type": "string", 
      "description": "Specifies the NetBIOS name."
    }, 
    "auth_providers": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies the list of authentication providers available on this access zone."
    }, 
    "home_directory_umask": {
      "type": "integer", 
      "description": "Specifies the permissions set on automatically created user home directories."
    }, 
    "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."
    }, 
    "path": {
      "type": "string", 
      "description": "Specifies the access zone base directory path."
    }, 
    "user_mapping_rules": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies the current ID mapping rules."
    }, 
    "cache_entry_expiry": {
      "type": "integer", 
      "description": "Specifies amount of time in seconds to cache a user/group."
    }, 
    "groupnet": {
      "type": "string", 
      "description": "Groupnet identitier"
    }, 
    "skeleton_directory": {
      "type": "string", 
      "description": "Specifies the skeleton directory that is used for user home directories."
    }
  }
}

POST response body schema:
{
  "type": "object", 
  "properties": {
    "id": {
      "required": true, 
      "type": "string", 
      "description": "ID of created item that can be used to refer to item in the collection-item resource path."
    }
  }
}
