You are here

Home » API reference » CAS 8

cas.schema.yml in CAS 8

Same filename and directory in other branches
  1. 2.x config/schema/cas.schema.yml
config/schema/cas.schema.yml

File

config/schema/cas.schema.yml
View source 
  1. # Configuration schema for the CAS module

  2. 

  3. cas.settings:

  4.   type: config_object

  5.   label: 'CAS settings'

  6.   mapping:

  7.     login_link_enabled:

  8.       type: boolean

  9.       label: 'Login Link Enabled'

  10.     login_link_label:

  11.       type: label

  12.       label: 'Login Link Label'

  13.     login_success_message:

  14.       type: label

  15.       label: 'Login Success Message'

  16.     server:

  17.       type: mapping

  18.       label: 'CAS Server'

  19.       mapping:

  20.         version:

  21.           type: string

  22.           label: 'Version'

  23.         protocol:

  24.           type: string

  25.           label: 'Protocol'

  26.         hostname:

  27.           type: string

  28.           label: 'Hostname'

  29.         port:

  30.           type: integer

  31.           label: 'Port'

  32.         path:

  33.           type: string

  34.           label: 'Path'

  35.         verify:

  36.           type: integer

  37.           label: 'SSL Verification Method'

  38.         cert:

  39.           type: string

  40.           label: 'PEM Cert path'

  41.     gateway:

  42.       type: mapping

  43.       label: 'Gateway Feature'

  44.       mapping:

  45.         check_frequency:

  46.           type: integer

  47.           label: 'Check Frequency'

  48.         paths:

  49.           type: condition.plugin.request_path

  50.           label: 'Paths'

  51.     forced_login:

  52.       type: mapping

  53.       label: 'Forced Login'

  54.       mapping:

  55.         enabled:

  56.           type: boolean

  57.           label: 'Enable'

  58.         paths:

  59.           type: condition.plugin.request_path

  60.           label: 'Paths'

  61.     user_accounts:

  62.       type: mapping

  63.       label: 'User Accounts'

  64.       mapping:

  65.         prevent_normal_login:

  66.           type: boolean

  67.           label: 'Prevent normal login'

  68.         auto_register:

  69.           type: boolean

  70.           label: 'Auto Register Users'

  71.         email_assignment_strategy:

  72.           type: integer

  73.           label: 'Email Assignment Strategy'

  74.         email_hostname:

  75.           type: string

  76.           label: 'Email Hostname'

  77.         email_attribute:

  78.           type: string

  79.           label: 'Email Attribute'

  80.         auto_assigned_roles:

  81.           type: sequence

  82.           label: 'Auto assigned roles'

  83.           sequence:

  84.             type: string

  85.         restrict_password_management:

  86.           type: boolean

  87.           label: 'Restrict password management'

  88.         restrict_email_management:

  89.           type: boolean

  90.           label: 'Restrict email management'

  91.     error_handling:

  92.       type: mapping

  93.       label: 'Error Handling'

  94.       mapping:

  95.         login_failure_page:

  96.           type: string

  97.           label: 'Login Failure Page'

  98.         message_validation_failure:

  99.           type: label

  100.           label: 'Ticket validation failure error message'

  101.         message_no_local_account:

  102.           type: label

  103.           label: 'Local account does not exist error message'

  104.         message_subscriber_denied_reg:

  105.           type: label

  106.           label: 'Event subscriber denied registration error message'

  107.         message_subscriber_denied_login:

  108.           type: label

  109.           label: 'Event subscriber denied login error message'

  110.         message_account_blocked:

  111.           type: label

  112.           label: 'Local account is blocked error message'

  113.         message_username_already_exists:

  114.           type: label

  115.           label: 'Local account username already exists error message'

  116.         message_prevent_normal_login:

  117.           type: label

  118.           label: 'Prevent normal login error message'

  119.         message_restrict_password_management:

  120.           type: label

  121.           label: 'Restrict password management error message'

  122.     logout:

  123.       type: mapping

  124.       label: 'Logout'

  125.       mapping:

  126.         cas_logout:

  127.           type: boolean

  128.           label: 'Drupal Logout Triggers CAS Logout'

  129.         logout_destination:

  130.           type: string

  131.           label: 'Logout Destination'

  132.         enable_single_logout:

  133.           type: boolean

  134.           label: 'Enable'

  135.         single_logout_session_lifetime:

  136.           type: integer

  137.           label: 'Single Logout Session Lifetime'

  138.     proxy:

  139.       type: mapping

  140.       label: 'Proxy'

  141.       mapping:

  142.         initialize:

  143.           type: boolean

  144.           label: 'Enable'

  145.         can_be_proxied:

  146.           type: boolean

  147.           label: 'Enable'

  148.         proxy_chains:

  149.           type: string

  150.           label: 'Proxy Chains'

  151.     advanced:

  152.       type: mapping

  153.       label: 'Advanced'

  154.       mapping:

  155.         debug_log:

  156.           type: boolean

  157.           label: 'Log Debug Information'

  158.         connection_timeout:

  159.           type: integer

  160.           label: 'Connection Timeout'