Resource URL: /platform/<<version=1>>/protocols/hdfs/proxyusers

    Overview: This resource applies the pattern of collections to HDFS
              proxyusers.

     Methods: GET, POST

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

Method GET: List all proxyusers.

       URL: GET /platform/<<version=1>>/protocols/hdfs/proxyusers

Query arguments:
zone=<string> Access zone which contains HDFS proxyusers.

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": {
        "proxyusers": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "This is hdfs impersonation information of a proxyuser", 
            "properties": {
              "id": {
                "required": true, 
                "type": "string", 
                "description": "The ID of the role."
              }, 
              "members": {
                "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
                    }
                  }
                }, 
                "required": true, 
                "type": "array", 
                "description": "Users or groups impersonated by proxyuser."
              }, 
              "name": {
                "required": true, 
                "type": "string", 
                "description": "The name of the proxyuser."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }, 
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }, 
        "resume": {
          "minLength": 0, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
        }
      }
    }
  ]
}

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

Method POST: Create a new HDFS proxyuser.

        URL: POST /platform/<<version=1>>/protocols/hdfs/proxyusers

Query arguments:
zone=<string> Access zone which contains HDFS proxyuser.

Required POST request body fields:
name

POST request body schema:
{
  "type": "object", 
  "description": "This is hdfs impersonation information of a proxyuser", 
  "properties": {
    "id": {
      "type": "string", 
      "description": "The ID of the role."
    }, 
    "members": {
      "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": "Users or groups impersonated by proxyuser."
    }, 
    "name": {
      "required": true, 
      "type": "string", 
      "description": "The name of the proxyuser."
    }
  }
}

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
        }
      }
    }
  ]
}
