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

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

     Methods: GET, POST

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

Method GET: List all file providers.

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

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": {
    "file": {
      "items": {
        "type": "object", 
        "description": "Specifies the properties for an authentication file provider", 
        "properties": {
          "group_domain": {
            "type": "string", 
            "description": "Specifies the domain for this provider through which domains are qualified."
          }, 
          "password_file": {
            "type": "string", 
            "description": "Specifies the location of the file containing information about users."
          }, 
          "normalize_users": {
            "type": "boolean", 
            "description": "Normalizes user names to lowercase before look up."
          }, 
          "unmodifiable_groups": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies a group that cannot be modified by the provider."
          }, 
          "restrict_modifiable": {
            "type": "boolean", 
            "description": "If true, checks the provider for filtered lists of modifiable and unmodifiable users and groups."
          }, 
          "id": {
            "type": [
              {
                "type": "string", 
                "description": "Specifies the file provider ID."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "provider_domain": {
            "type": "string", 
            "description": "Specifies the domain for the provider."
          }, 
          "enumerate_groups": {
            "type": "boolean", 
            "description": "Enables the provider to enumerate groups."
          }, 
          "listable_groups": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies the groups that can be viewed in the provider."
          }, 
          "normalize_groups": {
            "type": "boolean", 
            "description": "Normalizes group names to lowercase before look up."
          }, 
          "system": {
            "type": [
              {
                "type": "boolean", 
                "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "authentication": {
            "type": "boolean", 
            "description": "Enables authentication and identity mapping through the authentication provider."
          }, 
          "unmodifiable_users": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies a user that cannot be modified by the provider."
          }, 
          "restrict_findable": {
            "type": "boolean", 
            "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups."
          }, 
          "group_file": {
            "type": "string", 
            "description": "Specifies the location of the file that contains information about the group."
          }, 
          "status": {
            "type": [
              {
                "type": "string", 
                "description": "Specifies the status of the provider."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "login_shell": {
            "type": "string", 
            "description": "Specifies the login shell path."
          }, 
          "home_directory_template": {
            "type": "string", 
            "description": "Specifies the path to the home directory template."
          }, 
          "findable_users": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies the list of users that can be resolved."
          }, 
          "modifiable_users": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies the users that can be modified in the provider."
          }, 
          "unfindable_groups": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies groups that cannot be resolved by the provider."
          }, 
          "enumerate_users": {
            "type": "boolean", 
            "description": "Enables the provider to enumerate users."
          }, 
          "unlistable_users": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies a user that cannot be listed by the provider."
          }, 
          "modifiable_groups": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies the groups that can be modified in the provider."
          }, 
          "user_domain": {
            "type": "string", 
            "description": "Specifies the domain for this provider through which users are qualified."
          }, 
          "name": {
            "type": [
              {
                "type": "string", 
                "description": "Specifies the name of the file provider."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "listable_users": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies the users that can be viewed in the provider."
          }, 
          "unlistable_groups": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies a group that cannot be listed by the provider."
          }, 
          "enabled": {
            "type": "boolean", 
            "description": "Enables the file provider."
          }, 
          "unfindable_users": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies users that cannot be resolved by the provider."
          }, 
          "findable_groups": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Specifies the list of groups that can be resolved."
          }, 
          "restrict_listable": {
            "type": "boolean", 
            "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups."
          }, 
          "ntlm_support": {
            "enum": [
              "all", 
              "v2only", 
              "none"
            ], 
            "type": "string", 
            "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials."
          }, 
          "netgroup_file": {
            "type": "string", 
            "description": "Specifies the path to a netgroups replacement file."
          }, 
          "create_home_directory": {
            "type": "boolean", 
            "description": "Automatically creates a home directory on the first login."
          }
        }
      }, 
      "type": "array"
    }
  }
}

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

Method POST: Create a new file provider.

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

There are no query arguments for this method.

Required POST request body fields:
password_file, group_file, name

POST request body schema:
{
  "type": "object", 
  "description": "Specifies the properties for an authentication file provider", 
  "properties": {
    "group_domain": {
      "type": "string", 
      "description": "Specifies the domain for this provider through which domains are qualified."
    }, 
    "password_file": {
      "required": true, 
      "type": "string", 
      "description": "Specifies the location of the file containing information about users."
    }, 
    "normalize_users": {
      "type": "boolean", 
      "description": "Normalizes user names to lowercase before look up."
    }, 
    "unmodifiable_groups": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies a group that cannot be modified by the provider."
    }, 
    "restrict_modifiable": {
      "type": "boolean", 
      "description": "If true, checks the provider for filtered lists of modifiable and unmodifiable users and groups."
    }, 
    "provider_domain": {
      "type": "string", 
      "description": "Specifies the domain for the provider."
    }, 
    "enumerate_groups": {
      "type": "boolean", 
      "description": "Enables the provider to enumerate groups."
    }, 
    "listable_groups": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies the groups that can be viewed in the provider."
    }, 
    "normalize_groups": {
      "type": "boolean", 
      "description": "Normalizes group names to lowercase before look up."
    }, 
    "authentication": {
      "type": "boolean", 
      "description": "Enables authentication and identity mapping through the authentication provider."
    }, 
    "unmodifiable_users": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies a user that cannot be modified by the provider."
    }, 
    "restrict_findable": {
      "type": "boolean", 
      "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups."
    }, 
    "group_file": {
      "required": true, 
      "type": "string", 
      "description": "Specifies the location of the file that contains information about the group."
    }, 
    "login_shell": {
      "type": "string", 
      "description": "Specifies the login shell path."
    }, 
    "home_directory_template": {
      "type": "string", 
      "description": "Specifies the path to the home directory template."
    }, 
    "findable_users": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies the list of users that can be resolved."
    }, 
    "modifiable_users": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies the users that can be modified in the provider."
    }, 
    "unfindable_groups": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies groups that cannot be resolved by the provider."
    }, 
    "enumerate_users": {
      "type": "boolean", 
      "description": "Enables the provider to enumerate users."
    }, 
    "unlistable_users": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies a user that cannot be listed by the provider."
    }, 
    "modifiable_groups": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies the groups that can be modified in the provider."
    }, 
    "user_domain": {
      "type": "string", 
      "description": "Specifies the domain for this provider through which users are qualified."
    }, 
    "name": {
      "required": true, 
      "type": "string", 
      "description": "Specifies the name of the file provider."
    }, 
    "listable_users": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies the users that can be viewed in the provider."
    }, 
    "unlistable_groups": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies a group that cannot be listed by the provider."
    }, 
    "enabled": {
      "type": "boolean", 
      "description": "Enables the file provider."
    }, 
    "unfindable_users": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies users that cannot be resolved by the provider."
    }, 
    "findable_groups": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies the list of groups that can be resolved."
    }, 
    "restrict_listable": {
      "type": "boolean", 
      "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups."
    }, 
    "ntlm_support": {
      "enum": [
        "all", 
        "v2only", 
        "none"
      ], 
      "type": "string", 
      "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials."
    }, 
    "netgroup_file": {
      "type": "string", 
      "description": "Specifies the path to a netgroups replacement file."
    }, 
    "create_home_directory": {
      "type": "boolean", 
      "description": "Automatically creates a 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."
    }
  }
}
