You are here

Home » API reference » SAML Service Provider 8.2

saml_sp_drupal_login.schema.yml in SAML Service Provider 8.2

Same filename and directory in other branches
  1. 8.3 modules/saml_sp_drupal_login/config/schema/saml_sp_drupal_login.schema.yml
  2. 4.x modules/saml_sp_drupal_login/config/schema/saml_sp_drupal_login.schema.yml
  3. 3.x modules/saml_sp_drupal_login/config/schema/saml_sp_drupal_login.schema.yml
modules/saml_sp_drupal_login/config/schema/saml_sp_drupal_login.schema.yml

File

modules/saml_sp_drupal_login/config/schema/saml_sp_drupal_login.schema.yml
View source 
  1. saml_sp_drupal_login.config:

  2.   type: config_object

  3.   label: 'Configuration'

  4.   mapping:

  5.     idp:

  6.       type: sequence

  7.       label: 'IdP'

  8.       description: 'The IdP(s) which are enabled for login'

  9.       sequence:

  10.         type: string

  11.     logout:

  12.       type: boolean

  13.       label: 'Single Logout'

  14.       description: 'When logging out of the site also logout of the IdP'

  15.     update_email:

  16.       type: boolean

  17.       label: 'Update Email address'

  18.       description: 'If an account can be found on the site but the e-mail address differs from the IdP update the email on record with the new address from the IdP.'

  19.     update_language:

  20.       type: boolean

  21.       label: 'Update Language'

  22.       description: 'If the account language of the site differs from that of the IdP update the site account to match.'

  23.     no_account_authenticated_user_role:

  24.       type: boolean

  25.       label: 'Login users without a user account as an authenticated user.'

  26.       description: 'If a user is authenticated by the SAML Service Provider but no matching account can be found the user will be logged in as an authenticated user. This will allow users to be authenticated to receive more permissions than an anonymous user but less than a user with any other role.'

  27.     no_account_authenticated_user_account:

  28.       type: integer

  29.       label: 'Authenticated user account'

  30.       description: 'This is the account with only the authenticated user role which a user is logged in as if no matching account exists. As this account will be used for all users make sure that this account has only the "Authenticated User" role.'

  31.     force_saml_only:

  32.       type: boolean

  33.       label: 'Force SAML Login'

  34.       description: 'The User Login form will not be used, when an anonymous user goes to /user they will be automatically redirected to the SAML authentication page.'

  35.     request_account:

  36.       type: boolean

  37.       label: 'Allow Account Request'

  38.       description: 'Allow users who do not have an account on the site to request an account on the site.'

  39.     site_mail:

  40.       type: boolean

  41.       label: 'Send messages to the site email'

  42.       description: 'Should the account request be sent to the site email address?'

  43.     site_administrators:

  44.       type: sequence

  45.       label: 'The site administrators user ids'

  46.       description: 'This is the list of user ids of site administrators who need to receive an email messages about the request for an account.'

  47.       sequence:

  48.         type: integer

  49.     

  50.