You are here

Home » API reference » User protect 8

README.txt in User protect 8

Same filename and directory in other branches
  1. 5 README.txt
  2. 6 README.txt
  3. 7 README.txt
User Protect
============

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Maintainers


INTRODUCTION
------------

The User Protect module allows fine-grained access control of user
administrators, by providing various editing protection for users. The
protections can be specific to a user, or applied to all users in a role.

The following protections are supported:

 * Username
 * E-mail address
 * Password
 * Status
 * Roles
 * Edit operation (user/X/edit)
 * Delete operation (user/X/cancel)

 * For a full description of the module visit:
   https://www.drupal.org/project/userprotect

 * To submit bug reports and feature suggestions, or to track changes visit:
   https://www.drupal.org/project/issues/userprotect


REQUIREMENTS
------------

This module requires no modules outside of Drupal core.


INSTALLATION
------------

 * Install the User Protect module as you would normally install a contributed
   Drupal module. Visit https://www.drupal.org/node/1897420 for further
   information.


CONFIGURATION
-------------

    1. Navigate to Administration > Extend and enable the module.
    2. Navigate to Administration > Configuration > People > User protect for
       configurations.

There are two types of protection rules:

 * User based protection rules:
   This user will be protected for all users except: "User 1" (admin), the
   protected user itself, and users with the permissions to "Bypass all user
   protections".
 * Role based protection rules:
   This role will be protected for all users except: "User 1" (admin), and users
   with the permissions to "Bypass all user protections".

A protection rule prevents any user to perform the selected editing operations
(such as changing password or changing mail address) on the specified user.
There are two exceptions in which a configured protection rule does not apply:

 * The logged in user has permission to bypass the protection rule.

 * The specified user is the current logged in user.
   Protection rules don't count for the user itself. Instead, there are
   permissions available to prevent an user from editing its own account,
   username, e-mail address, or password.

Protected fields will be disabled or hidden on the form at user/X/edit. The edit
and delete operations are protected by controlling entity access for the
operations 'update' and 'delete'.


MAINTAINERS
-----------

 * Youri van Koppen (MegaChriz) - https://www.drupal.org/user/654114

File

README.txt
View source 
  1. User Protect

  2. ============

  3. 

  4. CONTENTS OF THIS FILE

  5. ---------------------

  6. 

  7.  * Introduction

  8.  * Requirements

  9.  * Installation

  10.  * Configuration

  11.  * Maintainers

  12. 

  13. 

  14. INTRODUCTION

  15. ------------

  16. 

  17. The User Protect module allows fine-grained access control of user

  18. administrators, by providing various editing protection for users. The

  19. protections can be specific to a user, or applied to all users in a role.

  20. 

  21. The following protections are supported:

  22. 

  23.  * Username

  24.  * E-mail address

  25.  * Password

  26.  * Status

  27.  * Roles

  28.  * Edit operation (user/X/edit)

  29.  * Delete operation (user/X/cancel)

  30. 

  31.  * For a full description of the module visit:

  32.    https://www.drupal.org/project/userprotect

  33. 

  34.  * To submit bug reports and feature suggestions, or to track changes visit:

  35.    https://www.drupal.org/project/issues/userprotect

  36. 

  37. 

  38. REQUIREMENTS

  39. ------------

  40. 

  41. This module requires no modules outside of Drupal core.

  42. 

  43. 

  44. INSTALLATION

  45. ------------

  46. 

  47.  * Install the User Protect module as you would normally install a contributed

  48.    Drupal module. Visit https://www.drupal.org/node/1897420 for further

  49.    information.

  50. 

  51. 

  52. CONFIGURATION

  53. -------------

  54. 

  55.     1. Navigate to Administration > Extend and enable the module.

  56.     2. Navigate to Administration > Configuration > People > User protect for

  57.        configurations.

  58. 

  59. There are two types of protection rules:

  60. 

  61.  * User based protection rules:

  62.    This user will be protected for all users except: "User 1" (admin), the

  63.    protected user itself, and users with the permissions to "Bypass all user

  64.    protections".

  65.  * Role based protection rules:

  66.    This role will be protected for all users except: "User 1" (admin), and users

  67.    with the permissions to "Bypass all user protections".

  68. 

  69. A protection rule prevents any user to perform the selected editing operations

  70. (such as changing password or changing mail address) on the specified user.

  71. There are two exceptions in which a configured protection rule does not apply:

  72. 

  73.  * The logged in user has permission to bypass the protection rule.

  74. 

  75.  * The specified user is the current logged in user.

  76.    Protection rules don't count for the user itself. Instead, there are

  77.    permissions available to prevent an user from editing its own account,

  78.    username, e-mail address, or password.

  79. 

  80. Protected fields will be disabled or hidden on the form at user/X/edit. The edit

  81. and delete operations are protected by controlling entity access for the

  82. operations 'update' and 'delete'.

  83. 

  84. 

  85. MAINTAINERS

  86. -----------

  87. 

  88.  * Youri van Koppen (MegaChriz) - https://www.drupal.org/user/654114