You are here

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

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

Same filename and directory in other branches
  1. 8.4 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: 'Network timeout'

  28.     tls:

  29.       type: boolean

  30.       label: 'Use Start-TLS'

  31.     followrefs:

  32.       type: boolean

  33.       label: 'Follow LDAP Referrals'

  34.     weight:

  35.       type: integer

  36.       label: 'Weight'

  37.     bind_method:

  38.       type: string

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

  40.     binddn:

  41.       type: string

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

  43.     bindpw:

  44.       type: string

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

  46.     basedn:

  47.       type: string

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

  49.     user_attr:

  50.       type: string

  51.       label: 'AuthName attribute'

  52.     account_name_attr:

  53.       type: string

  54.       label: 'AccountName attribute'

  55.     mail_attr:

  56.       type: string

  57.       label: 'Email attribute'

  58.     mail_template:

  59.       type: string

  60.       label: 'Email template'

  61.     picture_attr:

  62.       type: string

  63.       label: 'Thumbnail attribute'

  64.     unique_persistent_attr:

  65.       type: string

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

  67.     unique_persistent_attr_binary:

  68.       type: boolean

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

  70.     user_dn_expression:

  71.       type: string

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

  73.     testing_drupal_username:

  74.       type: string

  75.       label: 'Testing Drupal Username'

  76.     testing_drupal_user_dn:

  77.       type: string

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

  79.     grp_unused:

  80.       type: boolean

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

  82.     grp_object_cat:

  83.       type: string

  84.       label: 'Name of Group Object Class'

  85.     grp_nested:

  86.       type: boolean

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

  88.     grp_user_memb_attr_exists:

  89.       type: boolean

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

  91.     grp_user_memb_attr:

  92.       type: string

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

  94.     grp_memb_attr:

  95.       type: string

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

  97.     grp_memb_attr_match_user_attr:

  98.       type: string

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

  100.     grp_derive_from_dn:

  101.       type: string

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

  103.     grp_derive_from_dn_attr:

  104.       type: string

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

  106.     grp_test_grp_dn:

  107.       type: string

  108.       label: 'Testing LDAP Group DN'

  109.     grp_test_grp_dn_writeable:

  110.       type: string

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

  112.     search_pagination:

  113.       type: boolean

  114.       label: 'Use LDAP Pagination.'

  115.     search_page_size:

  116.       type: integer

  117.       label: 'Pagination size limit.'