Resource URL: /platform/<<version=1>>/auth/mapping/identities

    Overview: This resource provides external interface to the idmap.

     Methods: POST, DELETE

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

Method POST: Manually set or modify a mapping between two personae.

        URL: POST /platform/<<version=1>>/auth/mapping/identities

Query arguments:
   2way=<boolean> Create a bi-directional mapping from source to target and
                  target to source.
    zone=<string> Optional zone.
replace=<boolean> Replace existing mappings.

Required POST request body fields:
source, targets

POST request body schema:
{
  "type": "object", 
  "description": "Specifies the properties for the identity mapping entry.", 
  "properties": {
    "source": {
      "required": true, 
      "type": [
        {
          "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."
            }
          }
        }
      ], 
      "description": "Specifies the source identity."
    }, 
    "targets": {
      "items": {
        "type": "object", 
        "description": "Specifies the target identity mappings.", 
        "properties": {
          "on_disk": {
            "required": false, 
            "type": "boolean", 
            "description": "Identity is preferred on-disk."
          }, 
          "type": {
            "enum": [
              "auto", 
              "external", 
              "manual"
            ], 
            "type": "string", 
            "description": "Origin of identity mapping.", 
            "required": false
          }, 
          "target": {
            "required": true, 
            "type": [
              {
                "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."
                  }
                }
              }
            ], 
            "description": "Specifies the target identity."
          }
        }
      }, 
      "required": true, 
      "type": "array"
    }
  }
}

POST response body schema:
{
  "type": [
    "null", 
    "object"
  ], 
  "description": "Null or any empty JSON object.", 
  "properties": {}
}

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

Method DELETE: Flush the entire idmap cache.

          URL: DELETE /platform/<<version=1>>/auth/mapping/identities

Query arguments:
   filter=<enum> Where <enum> is one of auto, external.  Filter to apply when
                 deleting identity mappings.
remove=<boolean> Delete mapping instead of flush mapping cache.
   zone=<string> Optional zone.

There is no response body for this method.
