LDAP 認証をテストする

バージョン 3.1.23.2

LDAP 構成の接続認証設定をテストします。

これにより、接続が可能であること、Looker で使用される「サーバー」アカウントが、接続と認証情報が指定された LDAP サーバーに対して認証できることをテストします。

connection_host、connection_port、auth_username は必須です。 connection_tls と auth_password は任意です。

例:

{
  "connection_host": "ldap.example.com",
  "connection_port": "636",
  "connection_tls": true,
  "auth_username": "cn=looker,dc=example,dc=com",
  "auth_password": "secret"
}

Looker から auth_password が返されることはありません。このリクエストで auth_password フィールドを省略すると、アクティブな構成（存在する場合）の auth_password 値がテストに使用されます。

有効な LDAP 設定は変更されません。

リクエスト

PUT /ldap_config/test_auth
Datatype
説明
リクエスト
HTTPRequest
body
HTTPBody
HTTPBody 定義を展開...
body
LDAP 構成
LDAPConfig 定義を展開...
データ プロダクト
オブジェクト
現在のユーザーがこのオブジェクトに対して実行できるオペレーション
alternate_email_login_allowed
ブール値
管理者や「login_special_email」権限を持つ指定されたユーザーに対して、「/login/email」を介して代替メールベース ログインを許可します。このオプションは、後で LDAP 構成の問題が発生した場合、または LDAP ディレクトリにない一部のユーザーをサポートする必要がある場合に、LDAP 設定時のフォールバックとして役立ちます。LDAP が有効な場合、通常のユーザーの Looker のメール/パスワードのログインは常に無効になります。
auth_password
文字列
（書き込みのみ）LDAP サーバーへのアクセスに使用する LDAP アカウントのパスワード
auth_requires_role
ブール値
true に設定されている場合、LDAP でロールが見つからない場合、ユーザーはログインできません。
auth_username
文字列
LDAP サーバーへのアクセスに使用される LDAP アカウントの識別名
connection_host
文字列
LDAP サーバーのホスト名
connection_port
文字列
LDAP ホストポート
connection_tls
ブール値
Transport Layer Security の使用
connection_tls_no_verify
ブール値
TLS を使用する場合はピアを検証しない
default_new_user_group_ids
integer[]
default_new_user_groups
Group[]
default_new_user_role_ids
integer[]
default_new_user_roles
Role[]
有効
ブール値
サーバーの LDAP 認証を有効または無効にする
force_no_page
ブール値
LDAP サーバーがサポートしていると主張している場合でも、LDAP 検索結果のページング（RFC 2696）を試行しないでください。
グループ
groups_base_dn
文字列
LDAP 検索でグループを見つけるためのベース DN
groups_finder_type
文字列
Looker が LDAP サーバーのグループを検索する方法の識別子
groups_member_attribute
文字列
グループのメンバーを表す LDAP グループ属性。最も一般的なもの: 「メンバー」
groups_objectclasses
文字列
グループ検索を行う場合にグループでサポートされている LDAP オブジェクト クラスのカンマ区切りのリスト（省略可）
groups_user_attribute
文字列
グループ内のユーザーを示す LDAP グループ属性。通常は「dn」
groups_with_role_ids
has_auth_password
ブール値
（読み取り専用）LDAP サーバーへのアクセスに使用する LDAP アカウントのパスワードが設定されていますか？
merge_new_users_by_email
ブール値
メールアドレスで初回の LDAP ログインを既存のユーザー アカウントに統合する。ユーザーが LDAP を使って初めてログインすると、このオプションでは、一致するメールアドレスでアカウントを探して、既存のアカウントにこのユーザーを接続します。それ以外の場合は、新しいユーザー アカウントが作成されます。
modified_at
文字列
この構成ファイルの最終更新日
modified_by
文字列
この構成を最後に変更したユーザーのユーザー ID
set_roles_from_groups
ブール値
LDAP のグループに基づいて Looker でユーザーロールを設定する
test_ldap_password
文字列
（書き込みのみ）LDAP ユーザーのパスワードをテストします。LDAP テストの場合のみ。
test_ldap_user
文字列
（書き込みのみ）LDAP ユーザーのログイン ID をテストします。LDAP テストの場合のみ。
user_attribute_map_email
文字列
メールアドレス フィールドを示すために使用されるユーザー レコード属性の名前
user_attribute_map_first_name
文字列
名を示すために使用されるユーザー レコード属性の名前
user_attribute_map_last_name
文字列
姓を示すユーザー レコード属性の名前
user_attribute_map_ldap_id
文字列
一意のレコード ID を示すために使用されるユーザー レコード属性の名前
user_attributes
user_attributes_with_ids
user_bind_base_dn
文字列
ユーザー検索のベースとして使用される LDAP ノードの識別名
user_custom_filter
文字列
（省略可）ログイン時にユーザーを検出するためのカスタム RFC-2254 フィルタ句。「and」を介して生成された他のフィルタ句と結合されます。
user_id_attribute_names
文字列
ユーザー ログイン ID の照合に使用するユーザー レコード属性の名前（カンマ区切りのリスト）
user_objectclass
文字列
（省略可）ログイン ID 内でユーザーを見つけるために使用されるユーザー レコード オブジェクト クラスの名前
allow_normal_group_membership
ブール値
LDAP 認証ユーザーが、反射型ではない Looker グループのメンバーになることを許可します。「false」の場合、ユーザーはログイン時に反射のないグループから削除されます。
allow_roles_from_normal_groups
ブール値
LDAP 認証のユーザーは、反映されていない Looker グループからロールを継承できます。
allow_direct_roles
ブール値
LDAP 認証されたユーザーに直接ロールを割り当てることができます。
URL
文字列
このアイテムを取得するためのリンク

レスポンス

200: 結果情報。

Datatype
説明
（オブジェクト）
詳細
文字列
エラーケースの詳細
LDAPConfigTestIssue の定義を展開...
重要度
文字列
問題の重大度。エラーまたは警告
クリックします。
文字列
問題を説明するメッセージ
データ プロダクト
オブジェクト
現在のユーザーがこのオブジェクトに対して実行できるオペレーション
クリックします。
文字列
結果に関する人が読める形式の短いテスト
設定されます。
文字列
テスト ステータス コード: 常に「success」または「error」
trace
文字列
認証テスト中の増分結果のより詳細なトレース
ユーザー
認証テスト用の LDAP サーバーからのユーザーの詳細
LDAPUser 定義を展開...
all_emails
string[]
attributes
オブジェクト
ユーザー属性（名前/値）のディクショナリ
メール
文字列
メインのメールアドレス
first_name
文字列
名
グループ
string[]
last_name
文字列
姓
ldap_dn
文字列
ユーザー レコードの LDAP 識別名
ldap_id
文字列
ユーザーの LDAP の一意の ID
ロール
string[]
データ プロダクト
オブジェクト
現在のユーザーがこのオブジェクトに対して実行できるオペレーション
URL
文字列
LDAP 構成へのリンク
URL
文字列
LDAP 構成へのリンク

400: Bad Request

Datatype
説明
（オブジェクト）
クリックします。
文字列
エラーの詳細
documentation_url
文字列
ドキュメント リンク

403: アクセスが拒否されました

Datatype
説明
（オブジェクト）
クリックします。
文字列
エラーの詳細
documentation_url
文字列
ドキュメント リンク

404: 見つかりません

Datatype
説明
（オブジェクト）
クリックします。
文字列
エラーの詳細
documentation_url
文字列
ドキュメント リンク

422: 検証エラー

Datatype
説明
（オブジェクト）
クリックします。
文字列
エラーの詳細
エラー
ValidationErrorDetail 定義を展開...
フィールド
文字列
エラーのあるフィールド
コード
文字列
Error code（エラーコード）
クリックします。
文字列
エラー情報メッセージ
documentation_url
文字列
ドキュメント リンク
documentation_url
文字列
ドキュメント リンク