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": [
    {
      "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"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "file": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Specifies the properties for an authentication file provider", 
            "properties": {
              "group_domain": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the domain for this provider through which domains are qualified.", 
                "maxLength": 255
              }, 
              "password_file": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the location of the file containing information about users.", 
                "maxLength": 4096
              }, 
              "normalize_users": {
                "type": "boolean", 
                "description": "Normalizes user names to lowercase before look up."
              }, 
              "unmodifiable_groups": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies a group that cannot be modified by the provider.", 
                "maxItems": 4294967295
              }, 
              "restrict_modifiable": {
                "type": "boolean", 
                "description": "If true, checks the provider for filtered lists of modifiable and unmodifiable users and groups."
              }, 
              "id": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the file provider ID.", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "provider_domain": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the domain for the provider.", 
                "maxLength": 255
              }, 
              "enumerate_groups": {
                "type": "boolean", 
                "description": "Enables the provider to enumerate groups."
              }, 
              "listable_groups": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies the groups that can be viewed in the provider.", 
                "maxItems": 4294967295
              }, 
              "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": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies a user that cannot be modified by the provider.", 
                "maxItems": 4294967295
              }, 
              "restrict_findable": {
                "type": "boolean", 
                "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups."
              }, 
              "group_file": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the location of the file that contains information about the group.", 
                "maxLength": 255
              }, 
              "status": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the status of the provider.", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "login_shell": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the login shell path.", 
                "maxLength": 4096
              }, 
              "home_directory_template": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the path to the home directory template.", 
                "maxLength": 4096
              }, 
              "findable_users": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies the list of users that can be resolved.", 
                "maxItems": 4294967295
              }, 
              "modifiable_users": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies the users that can be modified in the provider.", 
                "maxItems": 4294967295
              }, 
              "unfindable_groups": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies groups that cannot be resolved by the provider.", 
                "maxItems": 4294967295
              }, 
              "enumerate_users": {
                "type": "boolean", 
                "description": "Enables the provider to enumerate users."
              }, 
              "unlistable_users": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies a user that cannot be listed by the provider.", 
                "maxItems": 4294967295
              }, 
              "modifiable_groups": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies the groups that can be modified in the provider.", 
                "maxItems": 4294967295
              }, 
              "user_domain": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the domain for this provider through which users are qualified.", 
                "maxLength": 255
              }, 
              "name": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the name of the file provider.", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "listable_users": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies the users that can be viewed in the provider.", 
                "maxItems": 4294967295
              }, 
              "unlistable_groups": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies a group that cannot be listed by the provider.", 
                "maxItems": 4294967295
              }, 
              "enabled": {
                "type": "boolean", 
                "description": "Enables the file provider."
              }, 
              "unfindable_users": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies users that cannot be resolved by the provider.", 
                "maxItems": 4294967295
              }, 
              "findable_groups": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies the list of groups that can be resolved.", 
                "maxItems": 4294967295
              }, 
              "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": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the path to a netgroups replacement file.", 
                "maxLength": 4096
              }, 
              "create_home_directory": {
                "type": "boolean", 
                "description": "Automatically creates a home directory on the first login."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}

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

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": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the domain for this provider through which domains are qualified.", 
      "maxLength": 255
    }, 
    "password_file": {
      "minLength": 0, 
      "required": true, 
      "type": "string", 
      "description": "Specifies the location of the file containing information about users.", 
      "maxLength": 4096
    }, 
    "normalize_users": {
      "type": "boolean", 
      "description": "Normalizes user names to lowercase before look up."
    }, 
    "unmodifiable_groups": {
      "minItems": 0, 
      "items": {
        "minLength": 1, 
        "type": "string", 
        "maxLength": 255
      }, 
      "type": "array", 
      "description": "Specifies a group that cannot be modified by the provider.", 
      "maxItems": 4294967295
    }, 
    "restrict_modifiable": {
      "type": "boolean", 
      "description": "If true, checks the provider for filtered lists of modifiable and unmodifiable users and groups."
    }, 
    "provider_domain": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the domain for the provider.", 
      "maxLength": 255
    }, 
    "enumerate_groups": {
      "type": "boolean", 
      "description": "Enables the provider to enumerate groups."
    }, 
    "listable_groups": {
      "minItems": 0, 
      "items": {
        "minLength": 1, 
        "type": "string", 
        "maxLength": 255
      }, 
      "type": "array", 
      "description": "Specifies the groups that can be viewed in the provider.", 
      "maxItems": 4294967295
    }, 
    "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": {
      "minItems": 0, 
      "items": {
        "minLength": 1, 
        "type": "string", 
        "maxLength": 255
      }, 
      "type": "array", 
      "description": "Specifies a user that cannot be modified by the provider.", 
      "maxItems": 4294967295
    }, 
    "restrict_findable": {
      "type": "boolean", 
      "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups."
    }, 
    "group_file": {
      "minLength": 0, 
      "required": true, 
      "type": "string", 
      "description": "Specifies the location of the file that contains information about the group.", 
      "maxLength": 255
    }, 
    "login_shell": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the login shell path.", 
      "maxLength": 4096
    }, 
    "home_directory_template": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the path to the home directory template.", 
      "maxLength": 4096
    }, 
    "findable_users": {
      "minItems": 0, 
      "items": {
        "minLength": 1, 
        "type": "string", 
        "maxLength": 255
      }, 
      "type": "array", 
      "description": "Specifies the list of users that can be resolved.", 
      "maxItems": 4294967295
    }, 
    "modifiable_users": {
      "minItems": 0, 
      "items": {
        "minLength": 1, 
        "type": "string", 
        "maxLength": 255
      }, 
      "type": "array", 
      "description": "Specifies the users that can be modified in the provider.", 
      "maxItems": 4294967295
    }, 
    "unfindable_groups": {
      "minItems": 0, 
      "items": {
        "minLength": 1, 
        "type": "string", 
        "maxLength": 255
      }, 
      "type": "array", 
      "description": "Specifies groups that cannot be resolved by the provider.", 
      "maxItems": 4294967295
    }, 
    "enumerate_users": {
      "type": "boolean", 
      "description": "Enables the provider to enumerate users."
    }, 
    "unlistable_users": {
      "minItems": 0, 
      "items": {
        "minLength": 1, 
        "type": "string", 
        "maxLength": 255
      }, 
      "type": "array", 
      "description": "Specifies a user that cannot be listed by the provider.", 
      "maxItems": 4294967295
    }, 
    "modifiable_groups": {
      "minItems": 0, 
      "items": {
        "minLength": 1, 
        "type": "string", 
        "maxLength": 255
      }, 
      "type": "array", 
      "description": "Specifies the groups that can be modified in the provider.", 
      "maxItems": 4294967295
    }, 
    "user_domain": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the domain for this provider through which users are qualified.", 
      "maxLength": 255
    }, 
    "name": {
      "minLength": 0, 
      "required": true, 
      "type": "string", 
      "description": "Specifies the name of the file provider.", 
      "maxLength": 255
    }, 
    "listable_users": {
      "minItems": 0, 
      "items": {
        "minLength": 1, 
        "type": "string", 
        "maxLength": 255
      }, 
      "type": "array", 
      "description": "Specifies the users that can be viewed in the provider.", 
      "maxItems": 4294967295
    }, 
    "unlistable_groups": {
      "minItems": 0, 
      "items": {
        "minLength": 1, 
        "type": "string", 
        "maxLength": 255
      }, 
      "type": "array", 
      "description": "Specifies a group that cannot be listed by the provider.", 
      "maxItems": 4294967295
    }, 
    "enabled": {
      "type": "boolean", 
      "description": "Enables the file provider."
    }, 
    "unfindable_users": {
      "minItems": 0, 
      "items": {
        "minLength": 1, 
        "type": "string", 
        "maxLength": 255
      }, 
      "type": "array", 
      "description": "Specifies users that cannot be resolved by the provider.", 
      "maxItems": 4294967295
    }, 
    "findable_groups": {
      "minItems": 0, 
      "items": {
        "minLength": 1, 
        "type": "string", 
        "maxLength": 255
      }, 
      "type": "array", 
      "description": "Specifies the list of groups that can be resolved.", 
      "maxItems": 4294967295
    }, 
    "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": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the path to a netgroups replacement file.", 
      "maxLength": 4096
    }, 
    "create_home_directory": {
      "type": "boolean", 
      "description": "Automatically creates a home directory on the first login."
    }
  }
}

POST 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": {
        "id": {
          "minLength": 0, 
          "required": true, 
          "type": "string", 
          "description": "ID of created item that can be used to refer to item in the collection-item resource path.", 
          "maxLength": 255
        }
      }
    }
  ]
}
