You are here

Home » API reference » OpenID Connect / OAuth client 2.x

openid_connect.schema.yml in OpenID Connect / OAuth client 2.x

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

File

config/schema/openid_connect.schema.yml
View source 
  1. openid_connect.settings:

  2.   type: config_object

  3.   label: 'OpenID Connect settings'

  4.   mapping:

  5.     always_save_userinfo:

  6.       type: boolean

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

  8.     connect_existing_users:

  9.       type: boolean

  10.       label: 'Automatically connect existing users'

  11.     override_registration_settings:

  12.       type: boolean

  13.       label: 'Override registration settings'

  14.     end_session_enabled:

  15.       type: boolean

  16.       label: 'Logout from identity provider'

  17.     user_login_display:

  18.       type: string

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

  20.     redirect_login:

  21.       type: string

  22.       label: 'Redirect on login'

  23.     redirect_logout:

  24.       type: string

  25.       label: 'Redirect on logout'

  26.     userinfo_mappings:

  27.       type: sequence

  28.       label: 'User claims mapping'

  29.       sequence:

  30.         type: string

  31.     role_mappings:

  32.       type: sequence

  33.       label: 'User role mapping'

  34.       sequence:

  35.         type: sequence

  36.         sequence:

  37.           type: string

  38. 

  39. openid_connect.client.*:

  40.   type: config_entity

  41.   label: 'OpenID Connect entity definitions'

  42.   mapping:

  43.     id:

  44.       type: string

  45.       label: 'OpenID Connect client entity ID'

  46.     label:

  47.       type: string

  48.       label: 'OpenID Connect client name'

  49.     plugin:

  50.       type: string

  51.       label: 'OpenID Connect client plugin ID'

  52.     settings:

  53.       type: openid_connect.client.plugin.[%parent.plugin]

  54. 

  55. openid_connect.client.plugin.*:

  56.   type: mapping

  57.   label: 'OpenID Connect plugin base settings'

  58.   mapping: &base

  59.     client_id:

  60.       type: string

  61.       label: 'Client ID'

  62.     client_secret:

  63.       type: string

  64.       label: 'Client secret'

  65. 

  66. openid_connect.client.plugin.facebook:

  67.   type: mapping

  68.   label: 'OpenID Connect Facebook settings'

  69.   mapping:

  70.     <<: *base

  71.     api_version:

  72.       type: string

  73.       label: 'API Version'

  74. 

  75. openid_connect.client.plugin.generic:

  76.   type: mapping

  77.   label: 'OpenID Connect Generic settings'

  78.   mapping:

  79.     <<: *base

  80.     issuer_url:

  81.       type: string

  82.       label: 'Issuer URL'

  83.     authorization_endpoint:

  84.       type: string

  85.       label: 'Authorization endpoint'

  86.     token_endpoint:

  87.       type: string

  88.       label: 'Token endpoint'

  89.     userinfo_endpoint:

  90.       type: string

  91.       label: 'Userinfo endpoint'

  92.     end_session_endpoint:

  93.       type: string

  94.       label: 'End Session endpoint'

  95.     scopes:

  96.       type: sequence

  97.       label: 'Scopes'

  98.       sequence:

  99.         type: string

  100. 

  101. openid_connect.client.plugin.okta:

  102.   type: mapping

  103.   label: 'OpenID Connect Okta settings'

  104.   mapping:

  105.     <<: *base

  106.     okta_domain:

  107.       type: string

  108.       label: 'Okta domain'

  109.     scopes:

  110.       type: sequence

  111.       label: 'Scopes'

  112.       sequence:

  113.         type: string