Added GDPR docs

This commit is contained in:
E.Alamo
2018-05-27 18:26:38 +02:00
parent f68312f27e
commit 9275b16d1d
2 changed files with 80 additions and 2 deletions

View File

@ -7,10 +7,41 @@ The module comes with a set of attributes to configure. The following is the lis
Setting this attribute will allow users to configure their login process with two-factor authentication.
### twoFactorAuthenticationCycles (type: `integer`, default: `1`)
#### twoFactorAuthenticationCycles (type: `integer`, default: `1`)
By default, Google Authenticator App for two-factor authentication cycles in periods of 30 seconds. In order to allow
a bigger period so to avoid out of sync issues.
a bigger period so to avoid out of sync issues.
#### enableGDPRcompliance (type: `boolean`, default: `false`)
Setting this attribute enables a serie of measures to comply with EU GDPR regulation, like data consent, right to be forgotten and data portability.
#### GDPRprivacyPolicyUrl (type: `array`, default: null)
The link to privacy policy. This will be used on registration form as "read our pivacy policy". It must follow the same format as `yii\helpers\Url::to`
#### GDPRexportProperties (type: `array`)
An array with the name of the user identity properties to be included when user request download of his data.
Names can include relations like `profile.name`.
Defaults to:
```php
[
'email',
'username',
'profile.public_email',
'profile.name',
'profile.gravatar_email',
'profile.location',
'profile.website',
'profile.bio'
]
```
#### GDPRanonymPrefix (type: `string`, default: `GDPR`)
Prefix to be used as a replacement when user requeste deletion of his data
#### enableRegistration (type: `boolean`, default: `true`)