Resource URL: /platform/<<version=3>>/protocols/ndmp/users

    Overview: Gives a list of NDMP administrators.

     Methods: GET, POST

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

Method GET: List all ndmp administrators.

       URL: GET /platform/<<version=3>>/protocols/ndmp/users

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": {
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }, 
        "users": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "properties": {
              "id": {
                "type": "string", 
                "description": "Unique display ID."
              }, 
              "name": {
                "type": "string", 
                "description": "A unique user name for NDMP administrator."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}

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

Method POST: Created a new user.

        URL: POST /platform/<<version=3>>/protocols/ndmp/users

There are no query arguments for this method.

Required POST request body fields:
password, name

POST request body schema:
{
  "type": "object", 
  "properties": {
    "password": {
      "required": true, 
      "type": "string", 
      "description": "The password for the NDMP administrator."
    }, 
    "name": {
      "required": true, 
      "type": "string", 
      "description": "A unique user name for NDMP administrator."
    }
  }
}

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": [
        "null", 
        "object"
      ], 
      "description": "Null or any empty JSON object.", 
      "properties": {}
    }
  ]
}
