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

    Overview: This resource contains identity mapping settings.

     Methods: GET, PUT

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

Method GET: Retrieve the mapping settings.

       URL: GET /platform/<<version=1>>/auth/settings/mapping

Query arguments:
 scope=<enum> Where <enum> is one of user, default, effective.  If specified as
              "effective" or not specified, all fields are returned.  If
              specified as "user", only fields with non-default values are
              shown.  If specified as "default", the original values are
              returned.
zone=<string> Access zone which contains mapping settings.

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"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "mapping_settings": {
          "type": "object", 
          "description": "Specifies the properties for global authentication setting.", 
          "properties": {
            "gid_range_max": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the ending number for a fixed range from which GIDs are allocated.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "uid_range_next": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the next UID to allocate.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "gid_range_next": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the next GID to allocate.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "uid_range_min": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the starting number for a fixed range from which UIDs are allocated.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "gid_range_min": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the starting number for a fixed range from which GIDs are allocated.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "uid_range_max": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the ending number for a fixed range from which UIDs are allocated.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "uid_range_enabled": {
              "type": [
                {
                  "type": "boolean", 
                  "description": "If true, allocates UIDs from a fixed range."
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "cache_entry_expiry": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the cache expiry in seconds of the idmapper.", 
                  "maximum": 15552000
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "gid_range_enabled": {
              "type": [
                {
                  "type": "boolean", 
                  "description": "If true, allocates GIDs from a fixed range."
                }, 
                {
                  "type": "null"
                }
              ]
            }
          }
        }
      }
    }
  ]
}

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

Method PUT: Modify the mapping settings.

       URL: PUT /platform/<<version=1>>/auth/settings/mapping

Query arguments:
zone=<string> Access zone which contains mapping settings.

PUT request body schema:
{
  "type": "object", 
  "description": "Specifies the properties for global authentication setting.", 
  "properties": {
    "gid_range_max": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the ending number for a fixed range from which GIDs are allocated.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "uid_range_next": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the next UID to allocate.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "gid_range_next": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the next GID to allocate.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "uid_range_min": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the starting number for a fixed range from which UIDs are allocated.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "gid_range_min": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the starting number for a fixed range from which GIDs are allocated.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "uid_range_max": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the ending number for a fixed range from which UIDs are allocated.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "uid_range_enabled": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, allocates UIDs from a fixed range."
        }
      ]
    }, 
    "cache_entry_expiry": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the cache expiry in seconds of the idmapper.", 
          "maximum": 15552000
        }
      ]
    }, 
    "gid_range_enabled": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, allocates GIDs from a fixed range."
        }
      ]
    }
  }
}

There is no JSON response body for this method.
