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

    Overview: This resource contains global authentication settings.

     Methods: GET, PUT

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

Method GET: Retrieve the global settings.

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

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> Zone which contains any per-zone 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": {
        "global_settings": {
          "type": "object", 
          "description": "Specifies the properties for global authentication settings.", 
          "properties": {
            "gid_range_next": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the next GID to allocate.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "unknown_uid": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the UID for the unknown (anonymous) user.", 
                  "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"
                }
              ]
            }, 
            "group_uid": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the user iD for a group when requested by the kernel.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "uid_range_enabled": {
              "type": [
                {
                  "type": "boolean", 
                  "description": "If true, allocates UIDs from a fixed range."
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "rpc_max_requests": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the maximum number of outstanding RPC requests.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "alloc_retries": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the number of times to retry an ID allocation before failing.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "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"
                }
              ]
            }, 
            "rpc_block_time": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the minimum amount of time in milliseconds to wait before performing an oprestart.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "null_gid": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies an alternative GID when the kernel is unable to retrieve a GID for a persona.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "min_mapped_rid": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Starts the RID in the local domain to map a UID and a GID.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "on_disk_identity": {
              "type": [
                {
                  "enum": [
                    "native", 
                    "unix", 
                    "sid"
                  ], 
                  "type": "string", 
                  "description": "Specifies the type of identity that is stored on disk."
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "send_ntlmv2": {
              "type": [
                {
                  "type": "boolean", 
                  "description": "If true, sends NTLMv2 responses."
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "system_uid_threshold": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the minimum UID to attempt to look up in the idmap database.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "rpc_timeout": {
              "type": [
                {
                  "minimum": 10, 
                  "type": "integer", 
                  "description": "Specifies the maximum amount of time in seconds to wait for an idmap response.", 
                  "maximum": 3600
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "user_object_cache_size": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the maximum size (in bytes) of the security object cache in the authentication daemon.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "uid_range_next": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the next UID to allocate.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "workgroup": {
              "type": [
                {
                  "minLength": 0, 
                  "type": "string", 
                  "description": "Specifies the NetBIOS workgroup or domain.", 
                  "maxLength": 255
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "unknown_gid": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the GID for the unknown (anonymous) group.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "gid_range_enabled": {
              "type": [
                {
                  "type": "boolean", 
                  "description": "If true, allocates GIDs from a fixed range."
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "space_replacement": {
              "type": [
                {
                  "minLength": 0, 
                  "type": "string", 
                  "description": "Specifies the space replacement character.", 
                  "maxLength": 255
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "system_gid_threshold": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies the minimum GID to attempt to look up in the idmap database.", 
                  "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"
                }
              ]
            }, 
            "null_uid": {
              "type": [
                {
                  "minimum": 0, 
                  "type": "integer", 
                  "description": "Specifies an alternative UID when the kernel is unable to retrieve a UID for a persona.", 
                  "maximum": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "load_providers": {
              "type": [
                {
                  "minItems": 0, 
                  "items": {
                    "enum": [
                      "ActiveDirectory", 
                      "Local", 
                      "Nss", 
                      "File", 
                      "Nis", 
                      "Ldap", 
                      "Krb5"
                    ], 
                    "type": "string"
                  }, 
                  "type": "array", 
                  "description": "Specifies which providers are loaded by the authentication daemon (lsassd).", 
                  "maxItems": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }
          }
        }
      }
    }
  ]
}

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

Method PUT: Modify the global settings.

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

Query arguments:
zone=<string> Zone which contains any per-zone settings.

PUT request body schema:
{
  "type": "object", 
  "description": "Specifies the properties for global authentication settings.", 
  "properties": {
    "gid_range_next": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the next GID to allocate.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "unknown_uid": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the UID for the unknown (anonymous) user.", 
          "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
        }
      ]
    }, 
    "group_uid": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the user iD for a group when requested by the kernel.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "uid_range_enabled": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, allocates UIDs from a fixed range."
        }
      ]
    }, 
    "rpc_max_requests": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the maximum number of outstanding RPC requests.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "alloc_retries": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the number of times to retry an ID allocation before failing.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "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
        }
      ]
    }, 
    "rpc_block_time": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the minimum amount of time in milliseconds to wait before performing an oprestart.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "null_gid": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies an alternative GID when the kernel is unable to retrieve a GID for a persona.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "min_mapped_rid": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Starts the RID in the local domain to map a UID and a GID.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "on_disk_identity": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "native", 
            "unix", 
            "sid"
          ], 
          "type": "string", 
          "description": "Specifies the type of identity that is stored on disk."
        }
      ]
    }, 
    "send_ntlmv2": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, sends NTLMv2 responses."
        }
      ]
    }, 
    "system_uid_threshold": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the minimum UID to attempt to look up in the idmap database.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "rpc_timeout": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 10, 
          "type": "integer", 
          "description": "Specifies the maximum amount of time in seconds to wait for an idmap response.", 
          "maximum": 3600
        }
      ]
    }, 
    "user_object_cache_size": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the maximum size (in bytes) of the security object cache in the authentication daemon.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "uid_range_next": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the next UID to allocate.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "workgroup": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the NetBIOS workgroup or domain.", 
          "maxLength": 255
        }
      ]
    }, 
    "unknown_gid": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the GID for the unknown (anonymous) group.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "gid_range_enabled": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, allocates GIDs from a fixed range."
        }
      ]
    }, 
    "space_replacement": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the space replacement character.", 
          "maxLength": 255
        }
      ]
    }, 
    "system_gid_threshold": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the minimum GID to attempt to look up in the idmap database.", 
          "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
        }
      ]
    }, 
    "null_uid": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies an alternative UID when the kernel is unable to retrieve a UID for a persona.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "load_providers": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minItems": 0, 
          "items": {
            "enum": [
              "ActiveDirectory", 
              "Local", 
              "Nss", 
              "File", 
              "Nis", 
              "Ldap", 
              "Krb5"
            ], 
            "type": "string"
          }, 
          "type": "array", 
          "description": "Specifies which providers are loaded by the authentication daemon (lsassd).", 
          "maxItems": 4294967295
        }
      ]
    }
  }
}

There is no JSON response body for this method.
