コンテンツにスキップ
「プリザンター入門」発売中！

Authentication.json

注意事項

制限事項

  • グループの同期はLinux環境では利用できません。Windows環境で"DsProvider"に"Novell"を指定した場合も利用できません。

設定値

本パラメータファイルの設定値は下記の通りです。

トップレベルパラメータ

パラメータ名 設定例 説明
Provider null
"LDAP"
"LDAP+Local"
"Windows"
"SAML"		 （LDAP認証の場合は必須）

null
ローカルユーザによる認証を利用。

"LDAP"
ADなどの外部LDAP認証を利用。

"LDAP+Local"
LDAP認証でログインに失敗した場合、ローカルユーザによるログインを試行。

"Windows"
統合Windows認証を利用。

"SAML"
SAML認証を利用。
DsProvider null
（デフォルト値）		 "Novell"
Windows環境において、LDAP認証ライブラリとして明示的にNovell.Directory.Ldapを利用（Linux環境ではNovellのみ指定可能）。
ServiceId null 変更不可。
ExtensionUrl null 変更不可。
RejectUnregisteredUser true true
プリザンターに登録されていないユーザによるログインを拒否。

false
LDAP認証を行っている場合、認証されたユーザを自動的にプリザンターに登録。
PasskeyParameters JSONオブジェクト パスキー認証を参照。
LdapParameters JSON配列 LDAP認証に必要な詳細設定。JSON配列として複数のLDAPサーバを指定可能。ローカル認証の場合は設定不要。以下のLdapParameters配下のパラメータを参照。
SamlParameters JSONオブジェクト SAML認証を参照。
TrustedProxyParameters JSONオブジェクト リバースプロキシが付与するHTTPヘッダーを使ってユーザを自動ログインさせる信頼済みリバースプロキシ認証の設定。本パラメータの設定例については信頼済みリバースプロキシ認証を参照。

LdapParameters配下のパラメータ

パラメータ名 設定例 説明
LdapSearchRoot "LDAP://dc.example.local/dc=example,dc=local" （LDAP認証の場合は必須）

LDAPの検索開始位置を指定。LDAPは大文字で記載。
LdapSearchProperty "sAMAccountName" （LDAP認証の場合は必須）

ログイン名に使用する属性の名称。
LdapSearchPattern (&(account={loginId})(deptcode=12345)) ログイン後のログインユーザ情報取得時の検索パターン。複数部署に所属するユーザから特定部署に絞るなど"SearchProperty=loginId"で取得できない場合に対応できる。
LdapLoginPattern null LDAPサーバへのログインアカウントのパターンを設定します。OpenLDAPでのuid=xx,ou=xx,o=xx,c=xxの形式に対応できます。

null
uid={loginId},ou=people,o=example,c=comの{loginId}に入力アカウントをReplaceします。
LdapAuthenticationType null SASL非対応のサーバに対応します。nullの場合はSimple認証。
NetBiosDomainName "EXAMPLE" （Windows認証でSSOする場合は必須）

ドメインのNetBios名を大文字で記載。
LdapTenantId 1 変更不可。
LdapDeptCode "departmentNumber" 組織コードに使用する属性の名称。
LdapDeptCodePattern null 組織コードの文字の一部を取得する正規表現。 1
LdapDeptName "department" 組織名に使用する属性の名称。
LdapDeptNamePattern null 組織名の文字の一部を取得する正規表現。 1
LdapUserCode "employeeNumber" ユーザコードに使用する属性の名称。
LdapUserCodePattern null ユーザコードの文字の一部を取得する正規表現。 1
LdapFirstName "givenName" ファーストネームに使用する属性の名称。
LdapFirstNamePattern null ファーストネームの文字の一部を取得する正規表現。 1
LdapLastName "sn" ラストネームに使用する属性の名称。
LdapLastNamePattern null ラストネームの文字の一部を取得する正規表現。 1
LdapMailAddress "mail" ユーザのメールアドレスに使用する属性の名称。
LdapMailAddressPattern null ユーザのメールアドレスの文字の一部を取得する正規表現。 1
LdapExtendedAttributes JSON配列 以下の3パラメータ（Name、Pattern、ColumnName）を1レコードとした配列として格納。複数の項目を指定することが可能。以下に記載例を掲載。 2
Name "DisplayName" 追加取得する属性の名称。
Pattern null 追加取得する文字の一部を取得する正規表現。 1
ColumnName "ClassA" 追加取得する値を格納するプリザンターのUsersテーブル項目名。
LdapGroupName "cn" グループ名に使用する属性の名称。
LdapGroupNamePattern null グループ名の文字の一部を取得する正規表現。 1
LdapSyncPageSize 0 LdapSyncの際にPageSizeの変更に対応。

-1
PageSizeを指定できないサーバの場合。

0または項目を省略
既定値1000となる。
LdapSyncPatterns "(&(ObjectCategory=User)(ObjectClass=Person))" ユーザを検索するための検索パターン。 3
LdapSyncGroupPatterns "(&(ObjectCategory=Group))" グループを検索するための検索パターン。 3
LdapGroupExtendedAttributes JSON配列 以下の3パラメータ（Name、Pattern、ColumnName）を1レコードとした配列として格納。複数の項目を指定することが可能。以下に記載例を掲載。 2
Name "DisplayName" 追加取得する属性の名称。
Pattern null 追加取得する文字の一部を取得する正規表現。 1
ColumnName "ClassA" 追加取得する値を格納するプリザンターのGroupsテーブル項目名。
LdapExcludeAccountDisabled true 無効化されたユーザを取り込まないためのフラグ。
AutoDisable true LDAPで認証対象外となったアカウントについて、プリザンターのユーザ情報に無効化を反映するためのフラグ。
AutoEnable true LDAPで認証対象となったアカウントについて、プリザンターのユーザ情報に有効化を反映するためのフラグ。
LdapSyncUser "DomainUserName" LDAPとユーザ同期を行う際に使用するユーザ名。

Linux
ドメインを含むユーザログオン名を指定する。
例：hayato@implem.local

Windows
ドメイン名の指定は不要。
LdapSyncPassword "********" LDAPとユーザ同期を行う際に使用するユーザのパスワード。

LdapExtendedAttributesとLdapGroupExtendedAttributesの記載例

以下は、LdapExtendedAttributesの記載例です。LdapGroupExtendedAttributesも同様に記載できます。

1
2
3
4
5
6
7
            "LdapExtendedAttributes": [
                {
                    "Name": "DisplayName",
                    "Pattern": null,
                    "ColumnName": "DescriptionE"
                }
            ]

正規表現の記載例

LDAPサーバ側の"department"に「12345 総務部」と登録されているケースにおいて、「総務部」を抽出する例です。

1
2
            "LdapDeptName": "department",
            "LdapDeptNamePattern": "(?<=^.{6}).*",

対応バージョン

対応バージョン 内容
1.4.11.0以降 LdapGroupExtendedAttributesを追加
1.5.1.0以降 PasskeyParametersを追加
1.5.3.0以降 TrustedProxyParametersを追加

関連情報

  1. 正規表現に一致する最初の文字列が使用されます。nullの場合は文字列全体が使用されます。 ↩↩↩↩↩↩↩↩↩

  2. 以下のAPIのレスポンスに該当カラムを含めたい場合は、「拡張機能：拡張項目」に、パラメータ "GridEnabled"と"EditorEnabled"のどちらか一方または両方に"1"を指定したカラムを追加してください。

    1. API：ユーザ操作：ユーザ取得
    2. API：グループ操作：グループ取得

    ↩↩

  3. 検索パターンはマイクロソフト社のリファレンスに従って記述してください。 ↩↩