Resource URL: /platform/<<version=1>>/quota/settings/mappings

    Overview: This resource applies the standard collection pattern to quotas
              email mapping rules.

     Methods: GET, POST, DELETE

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

Method GET: List all rules.

       URL: GET /platform/<<version=1>>/quota/settings/mappings

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": {
        "mappings": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "properties": {
              "domain": {
                "required": true, 
                "type": "string", 
                "description": "The FQDN of the source domain to map."
              }, 
              "type": {
                "enum": [
                  "ad", 
                  "local", 
                  "nis", 
                  "ldap"
                ], 
                "type": "string", 
                "description": "The authentication provider type.", 
                "required": true
              }, 
              "mapping": {
                "required": true, 
                "type": "string", 
                "description": "The FQDN of destination domain to map to."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}

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

Method POST: Create a new rule. The new rule must not conflict with an existing
             rule (e.g. match both the type and domain fields).

        URL: POST /platform/<<version=1>>/quota/settings/mappings

There are no query arguments for this method.

Required POST request body fields:
domain, type, mapping

POST request body schema:
{
  "type": "object", 
  "properties": {
    "domain": {
      "required": true, 
      "type": "string", 
      "description": "The FQDN of the source domain to map."
    }, 
    "type": {
      "enum": [
        "ad", 
        "local", 
        "nis", 
        "ldap"
      ], 
      "type": "string", 
      "description": "The authentication provider type.", 
      "required": true
    }, 
    "mapping": {
      "required": true, 
      "type": "string", 
      "description": "The FQDN of destination domain to map to."
    }
  }
}

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

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

Method DELETE: Delete all rules.

          URL: DELETE /platform/<<version=1>>/quota/settings/mappings

There are no query arguments for this method.

There is no JSON response body for this method.
