annotate core/modules/user/config/schema/user.schema.yml @ 19:fa3358dc1485 tip

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