GET /api/auth_source_ldaps
LDAP 認証元一覧

Params

Param Name Description
search
Optional

結果をフィルタ


Value: Must be String
order
Optional

結果をソート


Value: Must be String
page
Optional

結果をページ分割


Value: Must be String
per_page
Optional

リクエストあたりのエントリ数


Value: Must be String

GET /api/auth_source_ldaps/:id
LDAP 認証元の表示

Params

Param Name Description
id
Required

Value: 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

Value: Must be a Hash
auth_source_ldap[name]
Required

Value: Must be String
auth_source_ldap[host]
Required

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

デフォルトは 389 です。


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

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

Value: 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 の場合に必要です


Value: 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 の場合に必要です


Value: 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 の場合に必要です


Value: 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 の場合に必要です


Value: 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 の場合に必要です


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

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

Value: Must be 'true' or 'false'
auth_source_ldap[usergroup_sync]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be 'true' or 'false'
auth_source_ldap[tls]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
auth_source_ldap[groups_base]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

グループベース DN


Value: 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


Value: 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 フィルター


Value: Must be String

PUT /api/auth_source_ldaps/:id
LDAP 認証元の更新

Params

Param Name Description
id
Required

Value: Must be String
auth_source_ldap
Required

Value: Must be a Hash
auth_source_ldap[name]
Optional

Value: Must be String
auth_source_ldap[host]
Optional

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

デフォルトは 389 です。


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

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

Value: 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 の場合に必要です


Value: 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 の場合に必要です


Value: 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 の場合に必要です


Value: 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 の場合に必要です


Value: 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 の場合に必要です


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

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

Value: Must be 'true' or 'false'
auth_source_ldap[usergroup_sync]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be 'true' or 'false'
auth_source_ldap[tls]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
auth_source_ldap[groups_base]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

グループベース DN


Value: 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


Value: 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 フィルター


Value: Must be String

DELETE /api/auth_source_ldaps/:id
LDAP 認証元の削除

Params

Param Name Description
id
Required

Value: Must be String