GET /api/auth_source_ldaps
すべての LDAP 認証ソースを一覧表示

GET /api/locations/:location_id/auth_source_ldaps
場所ごとの LDAP 認証ソースを一覧表示します

GET /api/organizations/:organization_id/auth_source_ldaps
組織ごとの LDAP 認証ソースを一覧表示します

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.

検索フィールド

フィールド名 タイプ 設定可能な値
location
location_id
name
organization
organization_id

GET /api/auth_source_ldaps/:id
LDAP 認証ソースの表示

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/auth_source_ldaps
LDAP 認証ソースの作成

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

auth_source_ldap
必須

Validations:

  • Must be a Hash

auth_source_ldap[name]
必須

Validations:

  • Must be a String

auth_source_ldap[host]
必須

Validations:

  • Must be a String

auth_source_ldap[port]
任意 , nil可

デフォルト設定: 389

Validations:

  • Must be a number.

auth_source_ldap[account]
任意 , nil可

Validations:

  • Must be a String

auth_source_ldap[base_dn]
任意 , nil可

Validations:

  • Must be a String

auth_source_ldap[account_password]
任意 , nil可

onthefly_register が true の場合に必須です。

Validations:

  • Must be a String

auth_source_ldap[attr_login]
任意 , nil可

onthefly_register が true の場合に必須です。

Validations:

  • Must be a String

auth_source_ldap[attr_firstname]
任意 , nil可

onthefly_register が true の場合に必須です。

Validations:

  • Must be a String

auth_source_ldap[attr_lastname]
任意 , nil可

onthefly_register が true の場合に必須です。

Validations:

  • Must be a String

auth_source_ldap[attr_mail]
任意 , nil可

onthefly_register が true の場合に必須です。

Validations:

  • Must be a String

auth_source_ldap[attr_photo]
任意 , nil可

Validations:

  • Must be a String

auth_source_ldap[onthefly_register]
任意 , nil可

Validations:

  • Must be one of: true, false, 1, 0.

auth_source_ldap[usergroup_sync]
任意 , nil可

ログイン時に外部ユーザーグループを同期

Validations:

  • Must be one of: true, false, 1, 0.

auth_source_ldap[tls]
任意 , nil可

Validations:

  • Must be one of: true, false, 1, 0.

auth_source_ldap[groups_base]
任意 , nil可

グループベース DN

Validations:

  • Must be a String

auth_source_ldap[use_netgroups]
任意 , nil可

POSIX グループの代わりに NIS ネットグループを使用します。server_type が posix または free_ipa の場合のみ該当します。

Validations:

  • Must be one of: true, false, 1, 0.

auth_source_ldap[server_type]
任意 , nil可

LDAP サーバーのタイプ

Validations:

  • Must be one of: free_ipa, active_directory, posix.

auth_source_ldap[ldap_filter]
任意 , nil可

LDAP フィルター

Validations:

  • Must be a String

auth_source_ldap[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

auth_source_ldap[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


PUT /api/auth_source_ldaps/:id
LDAP 認証ソースの更新

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be a String

auth_source_ldap
必須

Validations:

  • Must be a Hash

auth_source_ldap[name]
任意

Validations:

  • Must be a String

auth_source_ldap[host]
任意

Validations:

  • Must be a String

auth_source_ldap[port]
任意 , nil可

デフォルト設定: 389

Validations:

  • Must be a number.

auth_source_ldap[account]
任意 , nil可

Validations:

  • Must be a String

auth_source_ldap[base_dn]
任意 , nil可

Validations:

  • Must be a String

auth_source_ldap[account_password]
任意 , nil可

onthefly_register が true の場合に必須です。

Validations:

  • Must be a String

auth_source_ldap[attr_login]
任意 , nil可

onthefly_register が true の場合に必須です。

Validations:

  • Must be a String

auth_source_ldap[attr_firstname]
任意 , nil可

onthefly_register が true の場合に必須です。

Validations:

  • Must be a String

auth_source_ldap[attr_lastname]
任意 , nil可

onthefly_register が true の場合に必須です。

Validations:

  • Must be a String

auth_source_ldap[attr_mail]
任意 , nil可

onthefly_register が true の場合に必須です。

Validations:

  • Must be a String

auth_source_ldap[attr_photo]
任意 , nil可

Validations:

  • Must be a String

auth_source_ldap[onthefly_register]
任意 , nil可

Validations:

  • Must be one of: true, false, 1, 0.

auth_source_ldap[usergroup_sync]
任意 , nil可

ログイン時に外部ユーザーグループを同期

Validations:

  • Must be one of: true, false, 1, 0.

auth_source_ldap[tls]
任意 , nil可

Validations:

  • Must be one of: true, false, 1, 0.

auth_source_ldap[groups_base]
任意 , nil可

グループベース DN

Validations:

  • Must be a String

auth_source_ldap[use_netgroups]
任意 , nil可

POSIX グループの代わりに NIS ネットグループを使用します。server_type が posix または free_ipa の場合のみ該当します。

Validations:

  • Must be one of: true, false, 1, 0.

auth_source_ldap[server_type]
任意 , nil可

LDAP サーバーのタイプ

Validations:

  • Must be one of: free_ipa, active_directory, posix.

auth_source_ldap[ldap_filter]
任意 , nil可

LDAP フィルター

Validations:

  • Must be a String

auth_source_ldap[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

auth_source_ldap[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


PUT /api/auth_source_ldaps/:id/test
LDAP 接続のテスト

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be a String


DELETE /api/auth_source_ldaps/:id
LDAP 認証ソースの削除

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be a String