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

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

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

Params

Param Name Description
location_id
Optional

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

Validations:

  • Must be Integer

organization_id
Optional

組織別のスコープ

Validations:

  • Must be Integer

search
Optional

結果のフィルター

Validations:

  • Must be String

order
Optional

結果のソート

Validations:

  • Must be String

page
Optional

結果のページネーション

Validations:

  • Must be String

per_page
Optional

要求ごとのエントリー数

Validations:

  • Must be String


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

Params

Param Name Description
id
Required

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 認証ソースの作成

Params

Param Name Description
auth_source_ldap
Required

Validations:

  • Must be a Hash

auth_source_ldap[name]
Required

Validations:

  • Must be String

auth_source_ldap[host]
Required

Validations:

  • Must be String

auth_source_ldap[port]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

デフォルト設定: 389

Validations:

  • Must be a number.

auth_source_ldap[account]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

auth_source_ldap[base_dn]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

auth_source_ldap[account_password]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

auth_source_ldap[attr_login]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

auth_source_ldap[attr_firstname]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

auth_source_ldap[attr_lastname]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

auth_source_ldap[attr_mail]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

auth_source_ldap[attr_photo]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

auth_source_ldap[onthefly_register]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be 'true' or 'false' or '1' or '0'

auth_source_ldap[usergroup_sync]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

auth_source_ldap[tls]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be 'true' or 'false' or '1' or '0'

auth_source_ldap[groups_base]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

グループベース DN

Validations:

  • Must be String

auth_source_ldap[server_type]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

LDAP サーバーのタイプ

Validations:

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

auth_source_ldap[ldap_filter]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

LDAP フィルター

Validations:

  • Must be String

auth_source_ldap[location_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type

auth_source_ldap[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type


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

Params

Param Name Description
id
Required

Validations:

  • Must be String

auth_source_ldap
Required

Validations:

  • Must be a Hash

auth_source_ldap[name]
Optional

Validations:

  • Must be String

auth_source_ldap[host]
Optional

Validations:

  • Must be String

auth_source_ldap[port]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

デフォルト設定: 389

Validations:

  • Must be a number.

auth_source_ldap[account]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

auth_source_ldap[base_dn]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

auth_source_ldap[account_password]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

auth_source_ldap[attr_login]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

auth_source_ldap[attr_firstname]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

auth_source_ldap[attr_lastname]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

auth_source_ldap[attr_mail]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

auth_source_ldap[attr_photo]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

auth_source_ldap[onthefly_register]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be 'true' or 'false' or '1' or '0'

auth_source_ldap[usergroup_sync]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

auth_source_ldap[tls]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be 'true' or 'false' or '1' or '0'

auth_source_ldap[groups_base]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

グループベース DN

Validations:

  • Must be String

auth_source_ldap[server_type]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

LDAP サーバーのタイプ

Validations:

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

auth_source_ldap[ldap_filter]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

LDAP フィルター

Validations:

  • Must be String

auth_source_ldap[location_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type

auth_source_ldap[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type


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

Params

Param Name Description
id
Required

Validations:

  • Must be String


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

Params

Param Name Description
id
Required

Validations:

  • Must be String