You are here

Home » API reference » Lightweight Directory Access Protocol (LDAP) 8.4

server.schema.yml in Lightweight Directory Access Protocol (LDAP) 8.4

Same filename and directory in other branches
  1. 8.3 ldap_servers/config/schema/server.schema.yml
ldap_servers/config/schema/server.schema.yml

File

ldap_servers/config/schema/server.schema.yml
View source 
  1. ldap_servers.server.*:

  2.   type: config_entity

  3.   label: 'Server config'

  4.   mapping:

  5.     id:

  6.       type: string

  7.       label: 'Machine name for this server configuration'

  8.     label:

  9.       type: label

  10.       label: 'Name'

  11.     uuid:

  12.       type: string

  13.     status:

  14.       type: boolean

  15.       label: 'Enabled'

  16.     type:

  17.       type: string

  18.       label: 'LDAP Server type'

  19.     address:

  20.       type: string

  21.       label: 'LDAP Server address'

  22.     port:

  23.       type: integer

  24.       label: 'LDAP Server port'

  25.     timeout:

  26.       type: integer

  27.       label: 'Timeout'

  28.     encryption:

  29.       type: string

  30.       label: 'Encryption'

  31.     weight:

  32.       type: integer

  33.       label: 'Weight'

  34.     bind_method:

  35.       type: string

  36.       label: 'Binding Method for Searches (such as finding user object or their group memberships)'

  37.     binddn:

  38.       type: string

  39.       label: 'DN for non-anonymous search'

  40.     bindpw:

  41.       type: string

  42.       label: 'Password for non-anonymous search'

  43.     basedn:

  44.       type: sequence

  45.       label: 'Base DNs for LDAP users, groups, and other entries.'

  46.       sequence:

  47.         type: string

  48.     user_attr:

  49.       type: string

  50.       label: 'Authentication name attribute'

  51.     account_name_attr:

  52.       type: string

  53.       label: 'Account name attribute'

  54.     mail_attr:

  55.       type: string

  56.       label: 'Email attribute'

  57.     mail_template:

  58.       type: string

  59.       label: 'Email template'

  60.     picture_attr:

  61.       type: string

  62.       label: 'Thumbnail attribute'

  63.     unique_persistent_attr:

  64.       type: string

  65.       label: 'Persistent and Unique User ID Attribute'

  66.     unique_persistent_attr_binary:

  67.       type: boolean

  68.       label: 'Does PUID hold a binary value?'

  69.     user_dn_expression:

  70.       type: string

  71.       label: 'Expression for user DN. Required when "Bind with Users Credentials" method selected.'

  72.     testing_drupal_username:

  73.       type: string

  74.       label: 'Testing Drupal Username'

  75.     testing_drupal_user_dn:

  76.       type: string

  77.       label: 'DN of testing username, e.g. cn=hpotter,ou=people,dc=hogwarts,dc=edu'

  78.     grp_unused:

  79.       type: boolean

  80.       label: 'Groups are not relevant to this Drupal site. This is generally true if LDAP Groups and LDAP Authorization are not in use.'

  81.     grp_object_cat:

  82.       type: string

  83.       label: 'Name of Group Object Class'

  84.     grp_nested:

  85.       type: boolean

  86.       label: 'Nested groups are used in my LDAP'

  87.     grp_user_memb_attr_exists:

  88.       type: boolean

  89.       label: 'Attribute in User Entry Containing Groups'

  90.     grp_user_memb_attr:

  91.       type: string

  92.       label: 'Attribute in User Entry Containing Groups'

  93.     grp_memb_attr:

  94.       type: string

  95.       label: "LDAP Group Entry Attribute Holding User's DN, CN, etc."

  96.     grp_memb_attr_match_user_attr:

  97.       type: string

  98.       label: 'User attribute held in "LDAP Group Entry Attribute Holding..."'

  99.     grp_derive_from_dn:

  100.       type: boolean

  101.       label: "Groups are derived from user's LDAP entry DN."

  102.     grp_derive_from_dn_attr:

  103.       type: string

  104.       label: "Attribute of the User's LDAP Entry DN which contains the group"

  105.     grp_test_grp_dn:

  106.       type: string

  107.       label: 'Testing LDAP Group DN'

  108.     grp_test_grp_dn_writeable:

  109.       type: string

  110.       label: 'Testing LDAP Group DN that is writable. WARNING the test script for the server will create, delete, and add members to this group!'