You are here

Home » API reference » Drupal 9

user.schema.yml in Drupal 9

Same filename and directory in other branches
  1. 8 core/modules/user/config/schema/user.schema.yml
  2. 10 core/modules/user/config/schema/user.schema.yml
core/modules/user/config/schema/user.schema.yml

File

core/modules/user/config/schema/user.schema.yml
View source 
  1. # Schema for the configuration files of the User module.

  2. 

  3. user.settings:

  4.   type: config_object

  5.   label: 'User settings'

  6.   mapping:

  7.     anonymous:

  8.       type: label

  9.       label: 'Name'

  10.     verify_mail:

  11.       type: boolean

  12.       label: 'Require email verification when a visitor creates an account'

  13.     notify:

  14.       type: mapping

  15.       label: 'Notify user'

  16.       mapping:

  17.         cancel_confirm:

  18.           type: boolean

  19.           label: 'Account cancellation confirmation'

  20.         password_reset:

  21.           type: boolean

  22.           label: 'Notify user when password reset'

  23.         status_activated:

  24.           type: boolean

  25.           label: 'Notify user when account is activated'

  26.         status_blocked:

  27.           type: boolean

  28.           label: 'Account blocked'

  29.         status_canceled:

  30.           type: boolean

  31.           label: 'Account canceled'

  32.         register_admin_created:

  33.           type: boolean

  34.           label: 'Welcome (new user created by administrator)'

  35.         register_no_approval_required:

  36.           type: boolean

  37.           label: 'Welcome (no approval required)'

  38.         register_pending_approval:

  39.           type: boolean

  40.           label: 'Welcome (awaiting approval)'

  41.     register:

  42.       type: string

  43.       label: 'Who can register accounts?'

  44.     cancel_method:

  45.       type: string

  46.       label: 'When cancelling a user account'

  47.     password_reset_timeout:

  48.       type: integer

  49.       label: 'Password reset timeout'

  50.     password_strength:

  51.       type: boolean

  52.       label: 'Enable password strength indicator'

  53. 

  54. user.mail:

  55.  type: config_object

  56.  label: 'Email settings'

  57.  mapping:

  58.   cancel_confirm:

  59.     type: mail

  60.     label: 'Account cancellation confirmation'

  61.   password_reset:

  62.     type: mail

  63.     label: 'Password recovery'

  64.   register_admin_created:

  65.     type: mail

  66.     label: 'Account created by administrator'

  67.   register_no_approval_required:

  68.     type: mail

  69.     label: 'Registration confirmation (No approval required)'

  70.   register_pending_approval:

  71.     type: mail

  72.     label: 'Registration confirmation (Pending approval)'

  73.   register_pending_approval_admin:

  74.     type: mail

  75.     label: 'Admin (user awaiting approval)'

  76.   status_activated:

  77.     type: mail

  78.     label: 'Account activation'

  79.   status_blocked:

  80.     type: mail

  81.     label: 'Account blocked'

  82.   status_canceled:

  83.     type: mail

  84.     label: 'Account cancelled'

  85. 

  86. user.flood:

  87.   type: config_object

  88.   label: 'User flood settings'

  89.   mapping:

  90.     uid_only:

  91.       type: boolean

  92.       label: 'UID only identifier'

  93.     ip_limit:

  94.       type: integer

  95.       label: 'IP limit'

  96.     ip_window:

  97.       type: integer

  98.       label: 'IP window'

  99.     user_limit:

  100.       type: integer

  101.       label: 'User limit'

  102.     user_window:

  103.       type: integer

  104.       label: 'User window'

  105. 

  106. user.role.*:

  107.   type: config_entity

  108.   label: 'User role settings'

  109.   mapping:

  110.     id:

  111.       type: string

  112.       label: 'ID'

  113.     label:

  114.       type: label

  115.       label: 'Label'

  116.     weight:

  117.       type: integer

  118.       label: 'User role weight'

  119.     is_admin:

  120.       type: boolean

  121.       label: 'User is admin'

  122.     permissions:

  123.       type: sequence

  124.       label: 'Permissions'

  125.       sequence:

  126.         type: string

  127.         label: 'Permission'

  128. 

  129. action.configuration.user_add_role_action:

  130.   type: mapping

  131.   label: 'Configuration for the add role action'

  132.   mapping:

  133.     rid:

  134.       type: string

  135.       label: 'The ID of the role to add'

  136. 

  137. action.configuration.user_block_user_action:

  138.   type: action_configuration_default

  139.   label: 'Block the selected users configuration'

  140. 

  141. action.configuration.user_cancel_user_action:

  142.   type: action_configuration_default

  143.   label: 'Cancel the selected user accounts configuration'

  144. 

  145. action.configuration.user_remove_role_action:

  146.   type: mapping

  147.   label: 'Configuration for the remove role action'

  148.   mapping:

  149.     rid:

  150.       type: string

  151.       label: 'The ID of the role to remove'

  152. 

  153. action.configuration.user_unblock_user_action:

  154.   type: action_configuration_default

  155.   label: 'Unblock the selected users configuration'

  156. 

  157. search.plugin.user_search:

  158.   type: sequence

  159.   label: 'User search'

  160. 

  161. condition.plugin.user_role:

  162.   type: condition.plugin

  163.   mapping:

  164.     roles:

  165.       type: sequence

  166.       sequence:

  167.         type: string

  168. 

  169. # Schema for the entity reference 'default:user' selection handler settings.

  170. entity_reference_selection.default:user:

  171.   type: entity_reference_selection.default

  172.   label: 'User selection handler settings'

  173.   mapping:

  174.     filter:

  175.       type: mapping

  176.       label: 'Filter settings'

  177.       mapping:

  178.         type:

  179.           type: string

  180.           label: 'Filter by'

  181.         role:

  182.           type: sequence

  183.           label: 'Restrict to the selected roles'

  184.           sequence:

  185.             type: string

  186.             label: 'Role'

  187.     include_anonymous:

  188.       type: boolean

  189.       label: 'Include the anonymous user in the matched entities.'

  190. 

  191. field.formatter.settings.user_name:

  192.   type: mapping

  193.   mapping:

  194.     link_to_entity:

  195.       type: boolean

  196.       label: 'Link to the user'