Resource URL: /platform/<<version=1>>/auth/providers/local

    Overview: This resource applies the standard collection pattern to local
              providers.

     Methods: GET, POST

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

Method GET: List all local providers.

       URL: GET /platform/<<version=1>>/auth/providers/local

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.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "local": {
      "items": {
        "type": "object", 
        "description": "Specifies the properties for a local authentication provider.", 
        "properties": {
          "max_password_age": {
            "type": "integer", 
            "description": "Specifies the maximum password age in seconds."
          }, 
          "min_password_age": {
            "type": "integer", 
            "description": "Specifies the minimum password age in seconds."
          }, 
          "login_shell": {
            "type": "string", 
            "description": "Specifies the login shell path."
          }, 
          "lockout_window": {
            "type": "integer", 
            "description": "Specifies the duration of time in seconds in which the number of failed attempts set in the 'lockout_threshold' parameter must be made before an account is locked."
          }, 
          "home_directory_template": {
            "type": "string", 
            "description": "Specifies the path to the home directory template."
          }, 
          "password_history_length": {
            "type": "integer", 
            "description": "Specifies the number of previous passwords to store."
          }, 
          "system": {
            "type": [
              {
                "type": "boolean", 
                "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "lockout_threshold": {
            "type": "integer", 
            "description": "Specifies the number of failed login attempts necessary before an account is locked."
          }, 
          "name": {
            "type": [
              {
                "type": "string", 
                "description": "Specifies the local provider name."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "password_prompt_time": {
            "type": "integer", 
            "description": "Specifies the time in seconds remaining before a user will be prompted for a password change."
          }, 
          "authentication": {
            "type": "boolean", 
            "description": "If true, enables authentication and identity management through the authentication provider."
          }, 
          "machine_name": {
            "type": "string", 
            "description": "Specifies the domain for this provider through which users and groups are qualified."
          }, 
          "status": {
            "type": [
              {
                "type": "string", 
                "description": "Specifies the status of the provider."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "min_password_length": {
            "type": "integer", 
            "description": "Specifies the minimum password length."
          }, 
          "lockout_duration": {
            "type": "integer", 
            "description": "Specifies the length of time in seconds that an account will be inaccessible after multiple failed login attempts."
          }, 
          "password_complexity": {
            "items": {
              "enum": [
                "lowercase", 
                "uppercase", 
                "numeric", 
                "symbol"
              ], 
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies the conditions required for a password."
          }, 
          "id": {
            "type": [
              {
                "type": "string", 
                "description": "Specifies the local provider ID."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "create_home_directory": {
            "type": "boolean", 
            "description": "Automatically creates the home directory on the first login."
          }
        }
      }, 
      "type": "array"
    }
  }
}

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

Method POST: 

        URL: POST /platform/<<version=1>>/auth/providers/local

There are no query arguments for this method.

Required POST request body fields:
name

POST request body schema:
{
  "type": "object", 
  "description": "Specifies the properties for a local authentication provider.", 
  "properties": {
    "min_password_age": {
      "type": "integer", 
      "description": "Specifies the minimum password age in seconds."
    }, 
    "min_password_length": {
      "type": "integer", 
      "description": "Specifies the minimum password length."
    }, 
    "login_shell": {
      "type": "string", 
      "description": "Specifies the login shell path."
    }, 
    "lockout_window": {
      "type": "integer", 
      "description": "Specifies the duration of time in seconds in which the number of failed attempts set in the 'lockout_threshold' parameter must be made before an account is locked."
    }, 
    "home_directory_template": {
      "type": "string", 
      "description": "Specifies the path to the home directory template."
    }, 
    "password_history_length": {
      "type": "integer", 
      "description": "Specifies the number of previous passwords to store."
    }, 
    "lockout_threshold": {
      "type": "integer", 
      "description": "Specifies the number of failed login attempts necessary before an account is locked."
    }, 
    "name": {
      "required": true, 
      "type": "string", 
      "description": "Specifies the local provider name."
    }, 
    "password_prompt_time": {
      "type": "integer", 
      "description": "Specifies the time in seconds remaining before a user will be prompted for a password change."
    }, 
    "authentication": {
      "type": "boolean", 
      "description": "If true, enables authentication and identity management through the authentication provider."
    }, 
    "machine_name": {
      "type": "string", 
      "description": "Specifies the domain for this provider through which users and groups are qualified."
    }, 
    "lockout_duration": {
      "type": "integer", 
      "description": "Specifies the length of time in seconds that an account will be inaccessible after multiple failed login attempts."
    }, 
    "password_complexity": {
      "items": {
        "enum": [
          "lowercase", 
          "uppercase", 
          "numeric", 
          "symbol"
        ], 
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies the conditions required for a password."
    }, 
    "max_password_age": {
      "type": "integer", 
      "description": "Specifies the maximum password age in seconds."
    }, 
    "create_home_directory": {
      "type": "boolean", 
      "description": "Automatically creates the home directory on the first login."
    }
  }
}

POST response body schema:
{
  "type": "object", 
  "properties": {
    "id": {
      "required": true, 
      "type": "string", 
      "description": "ID of created item that can be used to refer to item in the collection-item resource path."
    }
  }
}
