Skip to content

Remove a role from the selected users

Plugin ID: user_remove_role_action

Fields

Role — config key: rid

Type: radios · Required: yes · Default: empty string

Allowed values depend on the configuration of the target site.

Value format: A user role machine name on the target site, for example administrator.

Entity — config key: object

Provide the token name of the user that this action should operate with. Please provide the token name only, without brackets.

Type: textfield · Required: no · Default: empty string

See also: Tokens being forwarded

Replace tokens — config key: replace_tokens

When enabled, tokens will be replaced before executing the action. Please note: Actions might already take care of replacing tokens on their own. Therefore, use this option only with care and when it makes sense.

Type: checkbox · Required: no · Default: false