TestLdapAuthentication

TestLdapAuthenticationメソッドを使用すると、現在有効なLDAP認証設定を検証できます。設定が正しい場合、API呼び出しはテストしたユーザのグループ メンバーシップを返します。

パラメータ

このメソッドの入力パラメータは次のとおりです。

名前 説明 タイプ デフォルト値 必須
username テストするユーザ名。 文字列 なし 有効
password テストするユーザ名のパスワード。 文字列 なし 有効
ldapConfiguration テストするldapConfigurationオブジェクト。このパラメータを指定した場合、LDAP認証が現在無効であっても、指定した設定がテストされます。 ldapConfiguration なし 無効

戻り値

このメソッドの戻り値は次のとおりです。

名前 説明 タイプ
グループ テストしたユーザが属しているLDAPグループのリスト。 配列
userDN テストしたユーザの完全LDAP識別名。 文字列

要求例

このメソッドの要求例を次に示します。

{
"method": "TestLdapAuthentication",
"params": {"username":"admin1",
           "password":"admin1PASS"
      },
  "id": 1
}

応答例

このメソッドの応答例を次に示します。

{
 "id": 1,
 "result": {
    "groups": [
        "CN=StorageMgmt,OU=PTUsers,DC=prodtest,DC=solidfire,DC=net"
      ],
        "userDN": "CN=Admin1 Jones,OU=PTUsers,DC=prodtest,DC=solidfire,DC=net"
  }
}

新規導入バージョン

9.6