You are here

Home » API reference » OAuth2 Server 2.0.x

oauth2_server.schema.yml in OAuth2 Server 2.0.x

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

File

config/schema/oauth2_server.schema.yml
View source 
  1. oauth2_server.oauth:

  2.   type: config_object

  3.   label: 'OAuth2 Server settings'

  4.   mapping:

  5.     user_sub_property:

  6.       type: string

  7.       label: 'Property of user object to use'

  8. oauth2_server.server.*:

  9.   type: config_entity

  10.   label: 'OAuth2 Server'

  11.   mapping:

  12.     name:

  13.       type: label

  14.       label: 'Name'

  15.     server_id:

  16.       type: string

  17.       label: 'Machine-readable name'

  18.     module:

  19.       type: string

  20.       label: 'The name of the providing module.'

  21.     settings:

  22.       type: mapping

  23.       label: 'Settings'

  24.       mapping:

  25.         default_scope:

  26.           type: string

  27.           label: 'Default scope'

  28.         enforce_state:

  29.           type: boolean

  30.           label: 'Enforce state'

  31.         allow_implicit:

  32.           type: boolean

  33.           label: 'Allow Implicit'

  34.         use_openid_connect:

  35.           type: boolean

  36.           label: 'Use OpenID Connect'

  37.         use_crypto_tokens:

  38.           type: boolean

  39.           label: 'Use crypto tokens'

  40.         store_encrypted_token_string:

  41.           type: boolean

  42.           label: 'Store encrypted token string'

  43.         grant_types:

  44.           type: sequence

  45.           label: 'Grant types'

  46.           sequence:

  47.             type: string

  48.             label: 'Grant type'

  49.         always_issue_new_refresh_token:

  50.           type: boolean

  51.           label: 'Always issue new refresh token'

  52.         unset_refresh_token_after_use:

  53.           type: boolean

  54.           label: 'Unset (delete) the refresh token after it has been used'

  55.         advanced_settings:

  56.           type: mapping

  57.           label: 'Advanced Settings'

  58.           mapping:

  59.             access_lifetime:

  60.               type: integer

  61.               label: 'Access lifetime'

  62.             id_lifetime:

  63.               type: integer

  64.               label: 'ID lifetime'

  65.             refresh_token_lifetime:

  66.               type: integer

  67.               label: 'Refresh token lifetime'

  68.             require_exact_redirect_uri:

  69.               type: boolean

  70.               label: 'Require exact redirect uri'

  71. oauth2_server.scope.*:

  72.   type: config_entity

  73.   label: 'OAuth2 Server scope'

  74.   mapping:

  75.     id:

  76.       type: string

  77.       label: 'Machine-readable name'

  78.     scope_id:

  79.       type: string

  80.       label: 'Scope ID'

  81.     server_id:

  82.       type: string

  83.       label: 'Server ID'

  84.     description:

  85.       type: string

  86.       label: 'Description'

  87. oauth2_server.client.*:

  88.   type: config_entity

  89.   label: 'OAuth2 Server client'

  90.   mapping:

  91.     client_id:

  92.       type: string

  93.       label: 'Client ID'

  94.     server_id:

  95.       type: string

  96.       label: 'Server ID'

  97.     description:

  98.       type: string

  99.       label: 'Description'

  100.     name:

  101.       type: label

  102.       label: 'Name'

  103.     client_secret:

  104.       type: string

  105.       label: 'Client Secret'

  106.     public_key:

  107.       type: string

  108.       label: 'Public Key'

  109.     redirect_uri:

  110.       type: string

  111.       label: 'Redirect Uri'

  112.     automatic_authorization:

  113.       type: boolean

  114.       label: 'Automatic Authorization'

  115.     settings:

  116.       type: mapping

  117.       label: 'Settings'

  118.       mapping:

  119.         override_grant_types:

  120.           type: boolean

  121.           label: 'Override Grant types'

  122.         allow_implicit:

  123.           type: boolean

  124.           label: 'Allow Implicit'

  125.         always_issue_new_refresh_token:

  126.           type: boolean

  127.           label: 'Always issue new refresh token'

  128.         unset_refresh_token_after_use:

  129.           type: boolean

  130.           label: 'Unset (delete) the refresh token after it has been used'

  131.         grant_types:

  132.           type: sequence

  133.           label: 'Grant types'

  134.           sequence:

  135.             type: string

  136.             label: 'Grant type'