wikijs-fork/server/modules/authentication/ldap/definition.yml

74 lines
2.2 KiB
YAML
Raw Normal View History

key: ldap
title: LDAP / Active Directory
2018-08-04 21:27:55 +00:00
description: Active Directory is a directory service that Microsoft developed for the Windows domain networks.
author: requarks.io
2018-08-04 21:27:55 +00:00
logo: https://static.requarks.io/logo/active-directory.svg
color: blue darken-3
2018-08-04 21:27:55 +00:00
website: https://www.microsoft.com/windowsserver
2019-04-27 03:59:35 +00:00
isAvailable: true
useForm: true
props:
url:
2019-04-27 03:59:35 +00:00
title: LDAP URL
type: String
default: 'ldap://serverhost:389'
2019-04-27 03:59:35 +00:00
hint: (e.g. ldap://serverhost:389 or ldaps://serverhost:636)
order: 1
bindDn:
2019-04-27 03:59:35 +00:00
title: Admin Bind DN
type: String
default: cn='root'
2018-08-04 21:27:55 +00:00
hint: The dstinguished name (dn) of the account used for binding.
2019-04-27 03:59:35 +00:00
order: 2
2018-08-04 21:27:55 +00:00
bindCredentials:
2019-04-27 03:59:35 +00:00
title: Admin Bind Credentials
2018-08-04 21:27:55 +00:00
type: String
2019-04-27 03:59:35 +00:00
hint: The password of the account used above for binding.
order: 3
searchBase:
2019-04-27 03:59:35 +00:00
title: Search Base
type: String
default: 'o=users,o=example.com'
2019-04-27 03:59:35 +00:00
hint: The base DN from which to search for users.
order: 4
searchFilter:
2019-04-27 03:59:35 +00:00
title: Search Filter
type: String
default: '(uid={{username}})'
2019-04-27 03:59:35 +00:00
hint: The query to use to match username. {{username}} must be present and will be interpolated with the user provided username when performing the LDAP search.
order: 5
tlsEnabled:
2018-08-04 21:27:55 +00:00
title: Use TLS
type: Boolean
default: false
2019-04-27 03:59:35 +00:00
order: 6
2018-08-04 21:27:55 +00:00
tlsCertPath:
title: TLS Certificate Path
type: String
hint: Absolute path to the TLS certificate on the server.
2019-04-27 03:59:35 +00:00
order: 7
mappingUID:
title: Unique ID Field Mapping
type: String
default: 'uid'
hint: The field storing the user unique identifier. Usually "uid" or "sAMAccountName".
order: 8
mappingEmail:
title: Email Field Mapping
type: String
default: 'mail'
hint: The field storing the user email. Usually "mail".
order: 9
mappingDisplayName:
title: Display Name Field Mapping
type: String
default: 'displayName'
hint: The field storing the user display name. Usually "displayName" or "cn".
order: 10
mappingPicture:
title: Avatar Picture Field Mapping
type: String
default: 'jpegPhoto'
hint: The field storing the user avatar picture. Usually "jpegPhoto" or "thumbnailPhoto".
order: 11