GET /api/auth_source_ldaps
LDAP 認証元一覧

Params

Param Name Description
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>

type of the LDAP server

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


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>

type of the LDAP server

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


PUT /api/auth_source_ldaps/:id/test
Test LDAP connection

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