You are here

Home » API reference » Keycloak OpenID Connect 8

keycloak.schema.yml in Keycloak OpenID Connect 8

config/schema/keycloak.schema.yml

File

config/schema/keycloak.schema.yml
View source 
  1. # Schema for the configuration of the OpenID Connect plugin.

  2. openid_connect.settings.keycloak:

  3.   type: config_object

  4.   label: 'OpenID Connect Keycloak settings'

  5.   mapping:

  6.     enabled:

  7.       type: boolean

  8.       label: 'Enable client'

  9.     settings:

  10.       type: mapping

  11.       mapping:

  12.         debug:

  13.           type: boolean

  14.           label: 'Enable debug mode'

  15.         client_id:

  16.           type: string

  17.           label: 'Client ID'

  18.         client_secret:

  19.           type: string

  20.           label: 'Client secret'

  21.         keycloak_base:

  22.           type: string

  23.           label: 'Keycloak base URL'

  24.         keycloak_realm:

  25.           type: string

  26.           label: 'Keycloak realm'

  27.         userinfo_update_email:

  28.           type: boolean

  29.           label: 'Update email address in user profile'

  30.         keycloak_i18n:

  31.           type: mapping

  32.           label: 'Multi-language settings'

  33.           mapping:

  34.             enabled:

  35.               type: boolean

  36.               label: 'Enable multi-language support'

  37.             mapping:

  38.               type: sequence

  39.               label: 'Language mapping'

  40.               sequence:

  41.                 type: mapping

  42.                 mapping:

  43.                   langcode:

  44.                     type: string

  45.                     label: 'Drupal language code'

  46.                   target:

  47.                     type: string

  48.                     label: 'Keycloak language code'

  49.         keycloak_groups:

  50.           type: mapping

  51.           mapping:

  52.             enabled:

  53.               type: boolean

  54.               label: 'Enable automatic user role assignments'

  55.             claim_name:

  56.               type: string

  57.               label: 'User groups token claim name'

  58.             split_groups:

  59.               type: boolean

  60.               label: 'Split group paths'

  61.             split_groups_limit:

  62.               type: limit

  63.               label: 'Group path nesting limit'

  64.             rules:

  65.               type: sequence

  66.               label: 'Roles mapping rules'

  67.               sequence:

  68.                 type: mapping

  69.                 mapping:

  70.                   id:

  71.                     type: string

  72.                     label: 'ID'

  73.                   role:

  74.                     type: string

  75.                     label: 'Drupal role'

  76.                   action:

  77.                     type: string

  78.                     label: 'Action'

  79.                   operation:

  80.                     type: string

  81.                     label: 'Evaluation type'

  82.                   pattern:

  83.                     type: string

  84.                     label: 'Pattern'

  85.                   case_sensitive:

  86.                     type: boolean

  87.                     label: 'Case sensitive'

  88.                   weight:

  89.                     type: integer

  90.                     label: 'Weight'

  91.                   enabled:

  92.                     type: boolean

  93.                     label: 'enabled'

  94.         keycloak_sso:

  95.           type: boolean

  96.           label: 'Replace Drupal login with Keycloak single sign-on'

  97.         keycloak_sign_out:

  98.           type: boolean

  99.           label: 'Enable Drupal-initiated single sign-out'

  100.         check_session:

  101.           type: mapping

  102.           label: 'Check session settings'

  103.           mapping:

  104.             enabled:

  105.               type: boolean

  106.               label: 'Enable Keycloak-initiated single sign-out'

  107.             interval:

  108.               type: integer

  109.               label: 'Session check interval'