/v2/ldap/settings | Qumulo Documentation

Endpoint

/v2/ldap/settings

GET

Get settings for LDAP interaction

Parameters

This resource has no parameters.

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_lone_ldap_config_v2",
  "type": "object",
  "properties": {
    "use_ldap": {
      "description": "Top-level LDAP enablement switch, indicating whether Qumulo Core should use LDAP or not.",
      "type": "boolean"
    },
    "bind_uri": {
      "description": "LDAP URI used to bind. Example: ldap://ldap-server.example.com",
      "type": "string"
    },
    "user": {
      "description": "Binding user's distinguished name. Default is empty, for anonymous authentication.",
      "type": "string"
    },
    "password": {
      "description": "Binding password for simple auth. Default is the password that is currently configured.",
      "type": "string",
      "format": "password"
    },
    "base_distinguished_names": {
      "description": "Distinguished name(s) which will be used as the search base for queries. Multiple DNs may be specified, separated by semi-colons. Example: dc=users,dc=example,dc=com; dc=robots,dc=example,dc=com",
      "type": "string"
    },
    "ldap_schema": {
      "type": "string",
      "enum": [
        "RFC2307",
        "CUSTOM"
      ],
      "description": "LDAP server schema to use. Default is RFC2307:\n * `CUSTOM` - CUSTOM,\n * `RFC2307` - RFC2307"
    },
    "ldap_schema_description": {
      "description": "An expanded description of the LDAP server schema. Only set this field if setting ldap_schema to CUSTOM.",
      "type": "object",
      "properties": {
        "group_member_attribute": {
          "description": "group_member_attribute",
          "type": "string"
        },
        "user_group_identifier_attribute": {
          "description": "user_group_identifier_attribute",
          "type": "string"
        },
        "login_name_attribute": {
          "description": "login_name_attribute",
          "type": "string"
        },
        "group_name_attribute": {
          "description": "group_name_attribute",
          "type": "string"
        },
        "user_object_class": {
          "description": "user_object_class",
          "type": "string"
        },
        "group_object_class": {
          "description": "group_object_class",
          "type": "string"
        },
        "uid_number_attribute": {
          "description": "uid_number_attribute",
          "type": "string"
        },
        "gid_number_attribute": {
          "description": "gid_number_attribute",
          "type": "string"
        }
      }
    },
    "encrypt_connection": {
      "description": "If true, require to have encrypted connection with LDAP. Default is True.",
      "type": "boolean"
    }
  }
}

PUT

Set settings for LDAP interaction

Parameters

Name	Description	Required
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_lone_ldap_config_v2",
  "type": "object",
  "properties": {
    "use_ldap": {
      "description": "Top-level LDAP enablement switch, indicating whether Qumulo Core should use LDAP or not.",
      "type": "boolean"
    },
    "bind_uri": {
      "description": "LDAP URI used to bind. Example: ldap://ldap-server.example.com",
      "type": "string"
    },
    "user": {
      "description": "Binding user's distinguished name. Default is empty, for anonymous authentication.",
      "type": "string"
    },
    "password": {
      "description": "Binding password for simple auth. Default is the password that is currently configured.",
      "type": "string",
      "format": "password"
    },
    "base_distinguished_names": {
      "description": "Distinguished name(s) which will be used as the search base for queries. Multiple DNs may be specified, separated by semi-colons. Example: dc=users,dc=example,dc=com; dc=robots,dc=example,dc=com",
      "type": "string"
    },
    "ldap_schema": {
      "type": "string",
      "enum": [
        "RFC2307",
        "CUSTOM"
      ],
      "description": "LDAP server schema to use. Default is RFC2307:\n * `CUSTOM` - CUSTOM,\n * `RFC2307` - RFC2307"
    },
    "ldap_schema_description": {
      "description": "An expanded description of the LDAP server schema. Only set this field if setting ldap_schema to CUSTOM.",
      "type": "object",
      "properties": {
        "group_member_attribute": {
          "description": "group_member_attribute",
          "type": "string"
        },
        "user_group_identifier_attribute": {
          "description": "user_group_identifier_attribute",
          "type": "string"
        },
        "login_name_attribute": {
          "description": "login_name_attribute",
          "type": "string"
        },
        "group_name_attribute": {
          "description": "group_name_attribute",
          "type": "string"
        },
        "user_object_class": {
          "description": "user_object_class",
          "type": "string"
        },
        "group_object_class": {
          "description": "group_object_class",
          "type": "string"
        },
        "uid_number_attribute": {
          "description": "uid_number_attribute",
          "type": "string"
        },
        "gid_number_attribute": {
          "description": "gid_number_attribute",
          "type": "string"
        }
      }
    },
    "encrypt_connection": {
      "description": "If true, require to have encrypted connection with LDAP. Default is True.",
      "type": "boolean"
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_lone_ldap_config_v2",
  "type": "object",
  "properties": {
    "use_ldap": {
      "description": "Top-level LDAP enablement switch, indicating whether Qumulo Core should use LDAP or not.",
      "type": "boolean"
    },
    "bind_uri": {
      "description": "LDAP URI used to bind. Example: ldap://ldap-server.example.com",
      "type": "string"
    },
    "user": {
      "description": "Binding user's distinguished name. Default is empty, for anonymous authentication.",
      "type": "string"
    },
    "password": {
      "description": "Binding password for simple auth. Default is the password that is currently configured.",
      "type": "string",
      "format": "password"
    },
    "base_distinguished_names": {
      "description": "Distinguished name(s) which will be used as the search base for queries. Multiple DNs may be specified, separated by semi-colons. Example: dc=users,dc=example,dc=com; dc=robots,dc=example,dc=com",
      "type": "string"
    },
    "ldap_schema": {
      "type": "string",
      "enum": [
        "RFC2307",
        "CUSTOM"
      ],
      "description": "LDAP server schema to use. Default is RFC2307:\n * `CUSTOM` - CUSTOM,\n * `RFC2307` - RFC2307"
    },
    "ldap_schema_description": {
      "description": "An expanded description of the LDAP server schema. Only set this field if setting ldap_schema to CUSTOM.",
      "type": "object",
      "properties": {
        "group_member_attribute": {
          "description": "group_member_attribute",
          "type": "string"
        },
        "user_group_identifier_attribute": {
          "description": "user_group_identifier_attribute",
          "type": "string"
        },
        "login_name_attribute": {
          "description": "login_name_attribute",
          "type": "string"
        },
        "group_name_attribute": {
          "description": "group_name_attribute",
          "type": "string"
        },
        "user_object_class": {
          "description": "user_object_class",
          "type": "string"
        },
        "group_object_class": {
          "description": "group_object_class",
          "type": "string"
        },
        "uid_number_attribute": {
          "description": "uid_number_attribute",
          "type": "string"
        },
        "gid_number_attribute": {
          "description": "gid_number_attribute",
          "type": "string"
        }
      }
    },
    "encrypt_connection": {
      "description": "If true, require to have encrypted connection with LDAP. Default is True.",
      "type": "boolean"
    }
  }
}

PATCH

Partially Set LDAP interaction settings

Parameters

Name	Description	Required
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_lone_ldap_config_v2",
  "type": "object",
  "properties": {
    "use_ldap": {
      "description": "Top-level LDAP enablement switch, indicating whether Qumulo Core should use LDAP or not.",
      "type": "boolean"
    },
    "bind_uri": {
      "description": "LDAP URI used to bind. Example: ldap://ldap-server.example.com",
      "type": "string"
    },
    "user": {
      "description": "Binding user's distinguished name. Default is empty, for anonymous authentication.",
      "type": "string"
    },
    "password": {
      "description": "Binding password for simple auth. Default is the password that is currently configured.",
      "type": "string",
      "format": "password"
    },
    "base_distinguished_names": {
      "description": "Distinguished name(s) which will be used as the search base for queries. Multiple DNs may be specified, separated by semi-colons. Example: dc=users,dc=example,dc=com; dc=robots,dc=example,dc=com",
      "type": "string"
    },
    "ldap_schema": {
      "type": "string",
      "enum": [
        "RFC2307",
        "CUSTOM"
      ],
      "description": "LDAP server schema to use. Default is RFC2307:\n * `CUSTOM` - CUSTOM,\n * `RFC2307` - RFC2307"
    },
    "ldap_schema_description": {
      "description": "An expanded description of the LDAP server schema. Only set this field if setting ldap_schema to CUSTOM.",
      "type": "object",
      "properties": {
        "group_member_attribute": {
          "description": "group_member_attribute",
          "type": "string"
        },
        "user_group_identifier_attribute": {
          "description": "user_group_identifier_attribute",
          "type": "string"
        },
        "login_name_attribute": {
          "description": "login_name_attribute",
          "type": "string"
        },
        "group_name_attribute": {
          "description": "group_name_attribute",
          "type": "string"
        },
        "user_object_class": {
          "description": "user_object_class",
          "type": "string"
        },
        "group_object_class": {
          "description": "group_object_class",
          "type": "string"
        },
        "uid_number_attribute": {
          "description": "uid_number_attribute",
          "type": "string"
        },
        "gid_number_attribute": {
          "description": "gid_number_attribute",
          "type": "string"
        }
      }
    },
    "encrypt_connection": {
      "description": "If true, require to have encrypted connection with LDAP. Default is True.",
      "type": "boolean"
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_lone_ldap_config_v2",
  "type": "object",
  "properties": {
    "use_ldap": {
      "description": "Top-level LDAP enablement switch, indicating whether Qumulo Core should use LDAP or not.",
      "type": "boolean"
    },
    "bind_uri": {
      "description": "LDAP URI used to bind. Example: ldap://ldap-server.example.com",
      "type": "string"
    },
    "user": {
      "description": "Binding user's distinguished name. Default is empty, for anonymous authentication.",
      "type": "string"
    },
    "password": {
      "description": "Binding password for simple auth. Default is the password that is currently configured.",
      "type": "string",
      "format": "password"
    },
    "base_distinguished_names": {
      "description": "Distinguished name(s) which will be used as the search base for queries. Multiple DNs may be specified, separated by semi-colons. Example: dc=users,dc=example,dc=com; dc=robots,dc=example,dc=com",
      "type": "string"
    },
    "ldap_schema": {
      "type": "string",
      "enum": [
        "RFC2307",
        "CUSTOM"
      ],
      "description": "LDAP server schema to use. Default is RFC2307:\n * `CUSTOM` - CUSTOM,\n * `RFC2307` - RFC2307"
    },
    "ldap_schema_description": {
      "description": "An expanded description of the LDAP server schema. Only set this field if setting ldap_schema to CUSTOM.",
      "type": "object",
      "properties": {
        "group_member_attribute": {
          "description": "group_member_attribute",
          "type": "string"
        },
        "user_group_identifier_attribute": {
          "description": "user_group_identifier_attribute",
          "type": "string"
        },
        "login_name_attribute": {
          "description": "login_name_attribute",
          "type": "string"
        },
        "group_name_attribute": {
          "description": "group_name_attribute",
          "type": "string"
        },
        "user_object_class": {
          "description": "user_object_class",
          "type": "string"
        },
        "group_object_class": {
          "description": "group_object_class",
          "type": "string"
        },
        "uid_number_attribute": {
          "description": "uid_number_attribute",
          "type": "string"
        },
        "gid_number_attribute": {
          "description": "gid_number_attribute",
          "type": "string"
        }
      }
    },
    "encrypt_connection": {
      "description": "If true, require to have encrypted connection with LDAP. Default is True.",
      "type": "boolean"
    }
  }
}