You are here

Home » API reference » simpleSAMLphp Authentication 8.3

simplesamlphp_auth.schema.yml in simpleSAMLphp Authentication 8.3

config/schema/simplesamlphp_auth.schema.yml

File

config/schema/simplesamlphp_auth.schema.yml
View source 
  1. # Schema for the configuration files of the SimpleSAMLphp_auth module.

  2. 

  3. simplesamlphp_auth.settings:

  4.   type: config_object

  5.   label: 'SimpleSAMLphp Auth Settings'

  6.   mapping:

  7.     activate:

  8.       type: boolean

  9.       label: 'Activate authentication via SimpleSAMLphp'

  10.     auth_source:

  11.       type: string

  12.       label: 'Authentication source for this SP'

  13.     login_link_display_name:

  14.       type: label

  15.       label: 'Federated Log In Link Display Name'

  16.     login_link_show:

  17.       type: boolean

  18.       label: 'Display a link to the Federated Login page on the user login form'

  19.     user_name:

  20.       type: string

  21.       label: 'SimpleSAMLphp attribute to be used as username for the user'

  22.     unique_id:

  23.       type: string

  24.       label: 'SimpleSAMLphp attribute to be used as unique identifier for the user'

  25.     mail_attr:

  26.       type: string

  27.       label: 'SimpleSAMLphp attribute to be used as email address for the user'

  28.     header_no_cache:

  29.       type: boolean

  30.       label: 'Use Header with: Cache-Control: no-cache'

  31.     role:

  32.       type: mapping

  33.       label: 'Role population'

  34.       mapping:

  35.         population:

  36.           type: string

  37.           label: 'Automatic role population from simpleSAMLphp attributes'

  38.         eval_every_time:

  39.           type: boolean

  40.           label: 'Reevaluate roles every time the user logs in'

  41.     register_users:

  42.       type: boolean

  43.       label: 'Register users'

  44.     allow:

  45.       type: mapping

  46.       label: 'Drupal authentication'

  47.       mapping:

  48.         set_drupal_pwd:

  49.           type: boolean

  50.           label: 'Allow SAML users to set Drupal passwords'

  51.         default_login:

  52.           type: boolean

  53.           label: 'Allow authentication with local Drupal accounts'

  54.         default_login_roles:

  55.           type: sequence

  56.           label: 'Roles to be allowed to log in locally'

  57.           sequence:

  58.               type: string

  59.               label: 'role'

  60.         default_login_users:

  61.           type: string

  62.           label: 'Users to be allowed to log in locally'

  63.     logout_goto_url:

  64.       type: string

  65.       label: 'Redirect users after logging out'

  66.     user_register_original:

  67.       type: string

  68.       label: 'Original user register status'

  69.     sync:

  70.       type: mapping

  71.       label: 'Synchronize options'

  72.       mapping:

  73.         mail:

  74.           type: boolean

  75.           label: 'Synchronize mail on every login'

  76.         user_name:

  77.           type: boolean

  78.           label: 'Synchronize user_name on every login'

  79.     autoenablesaml:

  80.       type: boolean

  81.       label: 'Automatically enable SAML authentication for existing users upon successful login'

  82.     debug:

  83.       type: boolean

  84.       label: 'Expand the level of Drupal logging to include debugging information'

  85.     secure:

  86.       type: boolean

  87.       label: 'Cookie only transmitted over HTTPS'

  88.     httponly:

  89.       type: boolean

  90.       label: 'Cookie only accessible over HTTP protocol'