user.schema.yml

Same filename in other branches
  1. 9 core/modules/user/config/schema/user.schema.yml
  2. 10 core/modules/user/config/schema/user.schema.yml
  3. 11.x 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. user.settings:
  3. type: config_object
  4. label: 'User settings'
  5. mapping:
  6. anonymous:
  7. type: label
  8. label: 'Name'
  9. verify_mail:
  10. type: boolean
  11. label: 'Require email verification when a visitor creates an account'
  12. notify:
  13. type: mapping
  14. label: 'Notify user'
  15. mapping:
  16. cancel_confirm:
  17. type: boolean
  18. label: 'Account cancellation confirmation'
  19. password_reset:
  20. type: boolean
  21. label: 'Notify user when password reset'
  22. status_activated:
  23. type: boolean
  24. label: 'Notify user when account is activated'
  25. status_blocked:
  26. type: boolean
  27. label: 'Account blocked'
  28. status_canceled:
  29. type: boolean
  30. label: 'Account canceled'
  31. register_admin_created:
  32. type: boolean
  33. label: 'Welcome (new user created by administrator)'
  34. register_no_approval_required:
  35. type: boolean
  36. label: 'Welcome (no approval required)'
  37. register_pending_approval:
  38. type: boolean
  39. label: 'Welcome (awaiting approval)'
  40. register:
  41. type: string
  42. label: 'Who can register accounts?'
  43. cancel_method:
  44. type: string
  45. label: 'When cancelling a user account'
  46. password_reset_timeout:
  47. type: integer
  48. label: 'Password reset timeout'
  49. password_strength:
  50. type: boolean
  51. label: 'Enable password strength indicator'
  52. user.mail:
  53. type: config_object
  54. label: 'Email settings'
  55. mapping:
  56. cancel_confirm:
  57. type: mail
  58. label: 'Account cancellation confirmation'
  59. password_reset:
  60. type: mail
  61. label: 'Password recovery'
  62. register_admin_created:
  63. type: mail
  64. label: 'Account created by administrator'
  65. register_no_approval_required:
  66. type: mail
  67. label: 'Registration confirmation (No approval required)'
  68. register_pending_approval:
  69. type: mail
  70. label: 'Registration confirmation (Pending approval)'
  71. register_pending_approval_admin:
  72. type: mail
  73. label: 'Admin (user awaiting approval)'
  74. status_activated:
  75. type: mail
  76. label: 'Account activation'
  77. status_blocked:
  78. type: mail
  79. label: 'Account blocked'
  80. status_canceled:
  81. type: mail
  82. label: 'Account cancelled'
  83. user.flood:
  84. type: config_object
  85. label: 'User flood settings'
  86. mapping:
  87. uid_only:
  88. type: boolean
  89. label: 'UID only identifier'
  90. ip_limit:
  91. type: integer
  92. label: 'IP limit'
  93. ip_window:
  94. type: integer
  95. label: 'IP window'
  96. user_limit:
  97. type: integer
  98. label: 'User limit'
  99. user_window:
  100. type: integer
  101. label: 'User window'
  102. user.role.*:
  103. type: config_entity
  104. label: 'User role settings'
  105. mapping:
  106. id:
  107. type: string
  108. label: 'ID'
  109. label:
  110. type: label
  111. label: 'Label'
  112. weight:
  113. type: integer
  114. label: 'User role weight'
  115. is_admin:
  116. type: boolean
  117. label: 'User is admin'
  118. permissions:
  119. type: sequence
  120. label: 'Permissions'
  121. sequence:
  122. type: string
  123. label: 'Permission'
  124. action.configuration.user_add_role_action:
  125. type: mapping
  126. label: 'Configuration for the add role action'
  127. mapping:
  128. rid:
  129. type: string
  130. label: 'The ID of the role to add'
  131. action.configuration.user_block_user_action:
  132. type: action_configuration_default
  133. label: 'Block the selected users configuration'
  134. action.configuration.user_cancel_user_action:
  135. type: action_configuration_default
  136. label: 'Cancel the selected user accounts configuration'
  137. action.configuration.user_remove_role_action:
  138. type: mapping
  139. label: 'Configuration for the remove role action'
  140. mapping:
  141. rid:
  142. type: string
  143. label: 'The ID of the role to remove'
  144. action.configuration.user_unblock_user_action:
  145. type: action_configuration_default
  146. label: 'Unblock the selected users configuration'
  147. search.plugin.user_search:
  148. type: sequence
  149. label: 'User search'
  150. condition.plugin.user_role:
  151. type: condition.plugin
  152. mapping:
  153. roles:
  154. type: sequence
  155. sequence:
  156. type: string
  157. # Schema for the entity reference 'default:user' selection handler settings.
  158. entity_reference_selection.default:user:
  159. type: entity_reference_selection.default
  160. label: 'User selection handler settings'
  161. mapping:
  162. filter:
  163. type: mapping
  164. label: 'Filter settings'
  165. mapping:
  166. type:
  167. type: string
  168. label: 'Filter by'
  169. role:
  170. type: sequence
  171. label: 'Restrict to the selected roles'
  172. sequence:
  173. type: string
  174. label: 'Role'
  175. include_anonymous:
  176. type: boolean
  177. label: 'Include the anonymous user in the matched entities.'
  178. field.formatter.settings.user_name:
  179. type: mapping
  180. mapping:
  181. link_to_entity:
  182. type: boolean
  183. label: 'Link to the user'

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.