パラメータ設定:Authentication.json
## 注意事項
パラメータ変更時は[パラメータ変更時の確認事項](/ja/manual/parameter-edit)をご確認ください。
## 制限事項
グループの同期は、Linux環境では利用できません。また、Windows環境で"DsProvider"に"Novell"を指定した場合も利用できません。
## 設定値
本パラメータファイルの設定値は下記の通りです。
|パラメータ名|設定例|説明|
|:--|:--|:--|
|Provider|null または "LDAP" または "LDAP+Local" または "Windows" |nullを指定した場合はローカルユーザによる認証。"LDAP"を指定した場合はAD等の外部のLDAP認証。"LDAP+Local"を指定した場合、LDAP認証でログインに失敗した場合、ローカルユーザーでのログインを試行。[統合Windows認証](/manual/active-directory-sso)を利用する場合は、"Windows"を指定。 **(必須)**|
|DsProvider|null|デフォルト値はnull。Windows環境において、LDAP認証ライブラリとして明示的に「Novell.Directory.Ldap」を利用したい場合は"Novell"を指定。(Linux環境ではNovellのみ利用可能。)|
|ServiceId|null|変更不可。|
|ExtensionUrl|null|変更不可。|
|RejectUnregisteredUser|true|trueを指定した場合、プリザンターに登録されていないユーザによるログインを拒否。falseを指定した場合且つLDAP認証を行っている場合、認証されたユーザを自動的にプリザンターに登録。|
|LdapParameters|JSON配列|LDAP認証に必要な詳細設定。JSON配列として複数のLDAPサーバを指定可能。ローカル認証の場合は設定不要。|
|LdapSearchRoot|"LDAP://dc.example.local/dc=example,dc=local"|LDAPの検索開始位置を指定。**LDAPは大文字**で記載。**(LDAP認証の場合は必須)**|
|LdapSearchProperty|"sAMAccountName"|ログイン名に使用する属性の名称。**(LDAP認証の場合は必須)**|
|LdapSearchPattern|(&(account={loginId})(deptcode=12345))|ログイン後のログインユーザ情報取得時の検索パターンです。"SearchProperty=loginId"で取得できない場合に対応できます(複数部署に所属するユーザから特定部署に絞るなど)。|
|LdapLoginPattern|null|nullの場合は、「uid={loginId},ou=people,o=example,c=com」の「{loginId}」に入力アカウントをReplaceします。|LDAPサーバへのログインアカウントのパターンを設定します。OpenLDAPでのuid=xx,ou=xx,o=xx,c=xxの形式に対応します。|
|LdapAuthenticationType|null|SASL非対応のサーバに対応します。nullの場合はSimple認証|
|NetBiosDomainName|"EXAMPLE"|ドメインのNetBios名を**大文字で記載。(Windows認証によるシングルサインオンを行う場合には必須。)**|
|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パラメータを1レコードとした配列として格納。複数の項目を指定することが可能。 ※以下に記載例を掲載 ※2|
|Name|"DisplayName"|追加取得する属性の名称。|
|Pattern|null|追加取得する文字の一部を取得する正規表現。※1|
|ColumnName|"ClassA"|追加取得する値を格納するPleasanterの項目名。|
|LdapSyncPageSize|0|LdapSyncの際にPageSizeの変更に対応します。PageSizeを指定できないサーバの場合は-1を設定します。項目がないまたは0の場合はデフォルトとしてこれまで通りの1000となります。|
|LdapSyncPatterns|"(&(ObjectCategory=User)(ObjectClass=Person))"|ユーザを検索するための検索パターン。※3|
|LdapGroupName|"cn"|グループ名に使用する属性の名称。|
|LdapGroupNamePattern|null|グループ名の文字の一部を取得する正規表現。※1|
|LdapSyncGroupPatterns|"(&(ObjectCategory=Group))"|グループを検索するための検索パターン。※3|
|LdapExcludeAccountDisabled|true|無効化されたユーザを取り込まないためのフラグ。|
|AutoDisable|true|LDAPで認証対象外となったアカウントについて、Pleasanterのユーザ情報に無効化を反映するためのフラグ。|
|AutoEnable|true|LDAPで認証対象となったアカウントについて、Pleasanterのユーザ情報に有効化を反映するためのフラグ。|
|LdapSyncUser|"DomainUserName"|LDAPとユーザ同期を行う際に使用するユーザ名。Linuxではドメインを含むユーザーログオン名を指定する(例:hayato@implem.local)。Windowsの場合ドメイン名の指定は不要。|
|LdapSyncPassword|"********"|LDAPとユーザ同期を行う際に使用するユーザのパスワード。|
|NotCreatePersistentCookie|false|SAML認証時に認証クッキーを永続化できないようにします。|
※1 正規表現に一致する最初の文字列が使用されます。nullの場合は文字列全体が使用されます。
※2 「[API:ユーザ操作:ユーザ取得](/manual/api-user-get-all)」のレスポンスに該当カラムを含めたい場合は「[拡張機能:拡張項目](/manual/extended-column)」に、パラメータの"GridEnabled"と"EditorEnabled"のどちらかもしくは両方に"1"を指定したカラムの追加を行ってください。
※3 検索パターンは下記のリファレンスに従って記述してください。
https://technet.microsoft.com/ja-jp/library/security/system.directoryservices.directorysearcher.filter(v=vs.85)?cs-save-lang=1&cs-lang=vb
## LdapExtendedAttributes記載例
```
"LdapExtendedAttributes": [
{
"Name": "DisplayName",
"Pattern": null,
"ColumnName": "DescriptionE"
}
]
```
## 対応バージョン
|対応バージョン|内容|
|:--|:--|
|1.4.8.0以降|NotCreatePersistentCookieを追加|