Skip to content

Commit

Permalink
add to guide: (AthenZ#1808)
Browse files Browse the repository at this point in the history
1. disable role member expiry notification
2. disable role member review notification

Signed-off-by: mshneorson <[email protected]>

Co-authored-by: mshneorson <[email protected]>
  • Loading branch information
mendi160 and mshneorson authored Mar 9, 2022
1 parent 2f4ae7d commit e8f2750
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/member_expiration.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,18 @@ access to be extended.
The domain administrators will receive a single email notification listing all the members
that are about to expire in their domain. It is their responsibility to access their
domain in Athenz UI and extend those member's expiration, if necessary.

### Managing Role Member Expiry Reminder Recipients

By default, both the role members and the domain administrators will receive notifications as described above.
You can change this behavior by adding a tag to the role:

```
zms-cli -d <domain-name> add-role-tag <role-name> zms.DisableExpirationNotifications <one of the following: 0 - non-disabled, 1 - User disabled, 2 - Admin disabled, 3 - both admin and user disabled
```

For example, to prevent administrators from receiving notifications for the "write" role in the domain "sports", run the following:

```
zms-cli -d sports add-role-tag write zms.DisableExpirationNotifications 2
```
15 changes: 15 additions & 0 deletions docs/member_soft_expiration.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,18 @@ The domain administrator or the paranoids team may review the list of members wi
```
zms-cli overdue-review <domain-name>
```

### Managing Soft Expiry Reminder Recipients

By default, both the role members and the domain administrators will receive notifications as described above.
You can change this behavior by adding a tag to the role:

```
zms-cli -d <domain-name> add-role-tag <role-name> zms.DisableReminderNotifications <one of the following: 0 - non-disabled, 1 - User disabled, 2 - Admin disabled, 3 - both admin and user disabled
```

For example, to prevent administrators from receiving notifications for the "write" role in the domain "sports", run the following:

```
zms-cli -d sports add-role-tag write zms.DisableReminderNotifications 2
```

0 comments on commit e8f2750

Please sign in to comment.