You are here

Home » API reference » OpenID Connect / OAuth client 8

openid_connect.schema.yml in OpenID Connect / OAuth client 8

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

File

config/schema/openid_connect.schema.yml
View source 
  1. # Schema for the configuration files of the OpenID Connect module.

  2. 

  3. openid_connect.settings:

  4.   type: config_object

  5.   label: 'OpenID Connect settings'

  6.   mapping:

  7.     always_save_userinfo:

  8.       type: boolean

  9.       label: 'Save user claims on every login'

  10.     connect_existing_users:

  11.       type: boolean

  12.       label: 'Automatically connect existing users'

  13.     override_registration_settings:

  14.       type: boolean

  15.       label: 'Override registration settings'

  16.     user_login_display:

  17.       type: string

  18.       label: 'Show external providers in user login form'

  19.     userinfo_mappings:

  20.       type: sequence

  21.       label: 'User claims mapping'

  22.       sequence:

  23.         type: string

  24. 

  25. openid_connect.settings.facebook:

  26.   type: config_object

  27.   label: 'OpenID Connect Facebook settings'

  28.   mapping:

  29.     enabled:

  30.       type: boolean

  31.       label: 'Enable client'

  32.     settings:

  33.       type: mapping

  34.       mapping:

  35.         client_id:

  36.           type: string

  37.           label: 'Client ID'

  38.         client_secret:

  39.           type: string

  40.           label: 'Client secret'

  41.         api_version:

  42.           type: string

  43.           label: 'API Version'

  44. 

  45. openid_connect.settings.generic:

  46.   type: config_object

  47.   label: 'OpenID Connect Generic settings'

  48.   mapping:

  49.     enabled:

  50.       type: boolean

  51.       label: 'Enable client'

  52.     settings:

  53.       type: mapping

  54.       mapping:

  55.         client_id:

  56.           type: string

  57.           label: 'Client ID'

  58.         client_secret:

  59.           type: string

  60.           label: 'Client secret'

  61.         authorization_endpoint:

  62.           type: string

  63.           label: 'Authorization endpoint'

  64.         token_endpoint:

  65.           type: string

  66.           label: 'Token endpoint'

  67.         userinfo_endpoint:

  68.           type: string

  69.           label: 'Userinfo endpoint'

  70. 

  71. openid_connect.settings.github:

  72.   type: config_object

  73.   label: 'OpenID Connect GitHub settings'

  74.   mapping:

  75.     enabled:

  76.       type: boolean

  77.       label: 'Enable client'

  78.     settings:

  79.       type: mapping

  80.       mapping:

  81.         client_id:

  82.           type: string

  83.           label: 'Client ID'

  84.         client_secret:

  85.           type: string

  86.           label: 'Client secret'

  87. 

  88. openid_connect.settings.google:

  89.   type: config_object

  90.   label: 'OpenID Connect Google settings'

  91.   mapping:

  92.     enabled:

  93.       type: boolean

  94.       label: 'Enable client'

  95.     settings:

  96.       type: mapping

  97.       mapping:

  98.         client_id:

  99.           type: string

  100.           label: 'Client ID'

  101.         client_secret:

  102.           type: string

  103.           label: 'Client secret'

  104. 

  105. openid_connect.settings.linkedin:

  106.   type: config_object

  107.   label: 'OpenID Connect LinkedIn settings'

  108.   mapping:

  109.     enabled:

  110.       type: boolean

  111.       label: 'Enable client'

  112.     settings:

  113.       type: mapping

  114.       mapping:

  115.         client_id:

  116.           type: string

  117.           label: 'Client ID'

  118.         client_secret:

  119.           type: string

  120.           label: 'Client secret'

  121. 

  122. openid_connect.settings.okta:

  123.   type: config_object

  124.   label: 'OpenID Connect Okta settings'

  125.   mapping:

  126.     enabled:

  127.       type: boolean

  128.       label: 'Enable client'

  129.     settings:

  130.       type: mapping

  131.       mapping:

  132.         client_id:

  133.           type: string

  134.           label: 'Client ID'

  135.         client_secret:

  136.           type: string

  137.           label: 'Client secret'

  138.         okta_domain:

  139.           type: string

  140.           label: 'Okta domain'