Skip to content

Commit 6bc2e67

Browse files
authored
docs(issue 612): updated docs to reflect potential 403 error (#613)
* updated docs to reflect potential 403 error when not setting optionl share_with_current_team in monitor_notification_channels
1 parent fad3656 commit 6bc2e67

24 files changed

+35
-35
lines changed

website/docs/r/monitor_notification_channel_custom_webhook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ resource "sysdig_monitor_notification_channel_custom_webhook" "sample-custom-web
5858
if the notification channel is working. Default is false.
5959

6060
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
61-
Otherwise, it will share it with all teams, which is the default behaviour.
61+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
6262

6363
## Attributes Reference
6464

website/docs/r/monitor_notification_channel_email.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ resource "sysdig_monitor_notification_channel_email" "sample_email" {
4444
if the notification channel is working. Default is false.
4545

4646
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
47-
Otherwise, it will share it with all teams, which is the default behaviour.
47+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
4848

4949
## Attributes Reference
5050

website/docs/r/monitor_notification_channel_google_chat.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ resource "sysdig_monitor_notification_channel_google_chat" "sample-gchat" {
4343
if the notification channel is working. Default is false.
4444

4545
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
46-
Otherwise, it will share it with all teams, which is the default behaviour.
46+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
4747

4848
## Attributes Reference
4949

website/docs/r/monitor_notification_channel_ibm_event_notification.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Creates a Sysdig Monitor Notification Channel of type IBM Event Notification (on
1515
## Example Usage
1616

1717
```terraform
18-
# IBM event notification registering in the same account
18+
# IBM event notification registering in the same account
1919
resource "sysdig_monitor_notification_channel_ibm_event_notification" "sample" {
2020
name = "Example Channel - IBM Event Notification"
2121
enabled = true
@@ -27,7 +27,7 @@ resource "sysdig_monitor_notification_channel_ibm_event_notification" "sample" {
2727
```
2828

2929
```terraform
30-
# IBM event notification registering in different account
30+
# IBM event notification registering in different account
3131
resource "sysdig_monitor_notification_channel_ibm_event_notification" "sample" {
3232
name = "Example Channel - IBM Event Notification"
3333
enabled = true
@@ -42,7 +42,7 @@ resource "sysdig_monitor_notification_channel_ibm_event_notification" "sample" {
4242

4343
* `name` - (Required) The name of the Notification Channel. Must be unique.
4444

45-
* `instance_id` - (Required) id of the Event Notifications Instance. Id value can be either an instance id or CRN. If the event notification instance is within the same account, use the actual instance id. If it is in a different account, then use the Event Notifications Instance's [CRN](https://cloud.ibm.com/docs/account?topic=account-crn).
45+
* `instance_id` - (Required) id of the Event Notifications Instance. Id value can be either an instance id or CRN. If the event notification instance is within the same account, use the actual instance id. If it is in a different account, then use the Event Notifications Instance's [CRN](https://cloud.ibm.com/docs/account?topic=account-crn).
4646

4747
* `enabled` - (Optional) If false, the channel will not emit notifications. Default is true.
4848

@@ -56,7 +56,7 @@ resource "sysdig_monitor_notification_channel_ibm_event_notification" "sample" {
5656
if the notification channel is working. Default is false.
5757

5858
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
59-
Otherwise, it will share it with all teams, which is the default behaviour.
59+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
6060

6161
## Attributes Reference
6262

website/docs/r/monitor_notification_channel_ibm_function.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ resource "sysdig_monitor_notification_channel_ibm_function" "sample-ibm-function
6666
if the notification channel is working. Default is false.
6767

6868
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
69-
Otherwise, it will share it with all teams, which is the default behaviour.
69+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
7070

7171
## Attributes Reference
7272

website/docs/r/monitor_notification_channel_msteams.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ resource "sysdig_monitor_notification_channel_msteams" "sample-msteams" {
4343
if the notification channel is working. Default is false.
4444

4545
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
46-
Otherwise, it will share it with all teams, which is the default behaviour.
46+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
4747

4848
## Attributes Reference
4949

website/docs/r/monitor_notification_channel_opsgenie.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ resource "sysdig_monitor_notification_channel_opsgenie" "sample-opsgenie" {
4444
if the notification channel is working. Default is false.
4545

4646
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
47-
Otherwise, it will share it with all teams, which is the default behaviour.
47+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
4848

4949
## Attributes Reference
5050

website/docs/r/monitor_notification_channel_pagerduty.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ resource "sysdig_monitor_notification_channel_pagerduty" "sample-pagerduty" {
3939

4040
* `enabled` - (Optional) If false, the channel will not emit notifications. Default is true.
4141

42-
* `notify_when_ok` - (Optional) Send a new notification when the alert condition is
42+
* `notify_when_ok` - (Optional) Send a new notification when the alert condition is
4343
no longer triggered. Default is false.
4444

45-
* `notify_when_resolved` - (Optional) Send a new notification when the alert is manually
45+
* `notify_when_resolved` - (Optional) Send a new notification when the alert is manually
4646
acknowledged by a user. Default is false.
4747

4848
* `send_test_notification` - (Optional) Send an initial test notification to check
@@ -57,7 +57,7 @@ In addition to all arguments above, the following attributes are exported:
5757
* `version` - (Computed) The current version of the Notification Channel.
5858

5959
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
60-
Otherwise, it will share it with all teams, which is the default behaviour.
60+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
6161

6262
## Import
6363

website/docs/r/monitor_notification_channel_prometheus_alert_manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ resource "sysdig_monitor_notification_channel_prometheus_alert_manager" "sample"
5151
if the notification channel is working. Default is false.
5252

5353
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
54-
Otherwise, it will share it with all teams, which is the default behaviour.
54+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
5555

5656
## Attributes Reference
5757

website/docs/r/monitor_notification_channel_slack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ In addition to all arguments above, the following attributes are exported:
6767
* `version` - (Computed) The current version of the Notification Channel.
6868

6969
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
70-
Otherwise, it will share it with all teams, which is the default behaviour.
70+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
7171

7272
## Import
7373

website/docs/r/monitor_notification_channel_sns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ resource "sysdig_monitor_notification_channel_sns" "sample-amazon-sns" {
4343
if the notification channel is working. Default is false.
4444

4545
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
46-
Otherwise, it will share it with all teams, which is the default behaviour.
46+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
4747

4848
## Attributes Reference
4949

website/docs/r/monitor_notification_channel_team_email.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ resource "sysdig_monitor_notification_channel_team_email" "sample-gchat" {
4343
if the notification channel is working. Default is false.
4444

4545
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
46-
Otherwise, it will share it with all teams, which is the default behaviour.
46+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
4747

4848
## Attributes Reference
4949

website/docs/r/monitor_notification_channel_victorops.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ resource "sysdig_monitor_notification_channel_victorops" "sample-victorops" {
4646
if the notification channel is working. Default is false.
4747

4848
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
49-
Otherwise, it will share it with all teams, which is the default behaviour.
49+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
5050

5151
## Attributes Reference
5252

website/docs/r/monitor_notification_channel_webhook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ In addition to all arguments above, the following attributes are exported:
6262
* `version` - (Computed) The current version of the Notification Channel.
6363

6464
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
65-
Otherwise, it will share it with all teams, which is the default behaviour.
65+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
6666

6767
## Import
6868

website/docs/r/secure_notification_channel_email.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ resource "sysdig_secure_notification_channel_email" "sample_email" {
4444
if the notification channel is working. Default is false.
4545

4646
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
47-
Otherwise, it will share it with all teams, which is the default behaviour.
47+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
4848

4949
## Attributes Reference
5050

website/docs/r/secure_notification_channel_msteams.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ resource "sysdig_secure_notification_channel_msteams" "sample-msteams" {
3333

3434
* `enabled` - (Optional) If false, the channel will not emit notifications. Default is true.
3535

36-
* `notify_when_ok` - (Optional) Send a new notification when the alert condition is
36+
* `notify_when_ok` - (Optional) Send a new notification when the alert condition is
3737
no longer triggered. Default is false.
3838

39-
* `notify_when_resolved` - (Optional) Send a new notification when the alert is manually
39+
* `notify_when_resolved` - (Optional) Send a new notification when the alert is manually
4040
acknowledged by a user. Default is false.
4141

4242
* `send_test_notification` - (Optional) Send an initial test notification to check
@@ -55,7 +55,7 @@ In addition to all arguments above, the following attributes are exported:
5555
* `version` - (Computed) The current version of the Notification Channel.
5656

5757
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
58-
Otherwise, it will share it with all teams, which is the default behaviour.
58+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
5959

6060
## Import
6161

website/docs/r/secure_notification_channel_opsgenie.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ resource "sysdig_secure_notification_channel_opsgenie" "sample-opsgenie" {
4444
if the notification channel is working. Default is false.
4545

4646
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
47-
Otherwise, it will share it with all teams, which is the default behaviour.
47+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
4848

4949
## Attributes Reference
5050

website/docs/r/secure_notification_channel_pagerduty.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ resource "sysdig_secure_notification_channel_pagerduty" "sample-pagerduty" {
3939

4040
* `enabled` - (Optional) If false, the channel will not emit notifications. Default is true.
4141

42-
* `notify_when_ok` - (Optional) Send a new notification when the alert condition is
42+
* `notify_when_ok` - (Optional) Send a new notification when the alert condition is
4343
no longer triggered. Default is false.
4444

45-
* `notify_when_resolved` - (Optional) Send a new notification when the alert is manually
45+
* `notify_when_resolved` - (Optional) Send a new notification when the alert is manually
4646
acknowledged by a user. Default is false.
4747

4848
* `send_test_notification` - (Optional) Send an initial test notification to check
@@ -57,7 +57,7 @@ In addition to all arguments above, the following attributes are exported:
5757
* `version` - (Computed) The current version of the Notification Channel.
5858

5959
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
60-
Otherwise, it will share it with all teams, which is the default behaviour.
60+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
6161

6262
## Import
6363

website/docs/r/secure_notification_channel_prometheus_alert_manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ resource "sysdig_secure_notification_channel_prometheus_alert_manager" "sample"
5151
if the notification channel is working. Default is false.
5252

5353
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
54-
Otherwise, it will share it with all teams, which is the default behaviour.
54+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
5555

5656
## Attributes Reference
5757

website/docs/r/secure_notification_channel_slack.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ resource "sysdig_secure_notification_channel_slack" "sample-slack" {
3636

3737
* `enabled` - (Optional) If false, the channel will not emit notifications. Default is true.
3838

39-
* `notify_when_ok` - (Optional) Send a new notification when the alert condition is
39+
* `notify_when_ok` - (Optional) Send a new notification when the alert condition is
4040
no longer triggered. Default is false.
4141

42-
* `notify_when_resolved` - (Optional) Send a new notification when the alert is manually
42+
* `notify_when_resolved` - (Optional) Send a new notification when the alert is manually
4343
acknowledged by a user. Default is false.
4444

4545
* `send_test_notification` - (Optional) Send an initial test notification to check
@@ -58,7 +58,7 @@ In addition to all arguments above, the following attributes are exported:
5858
* `version` - (Computed) The current version of the Notification Channel.
5959

6060
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
61-
Otherwise, it will share it with all teams, which is the default behaviour.
61+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
6262

6363
## Import
6464

website/docs/r/secure_notification_channel_sns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ resource "sysdig_secure_notification_channel_sns" "sample-amazon-sns" {
4343
if the notification channel is working. Default is false.
4444

4545
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
46-
Otherwise, it will share it with all teams, which is the default behaviour.
46+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
4747

4848
## Attributes Reference
4949

website/docs/r/secure_notification_channel_team_email.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ resource "sysdig_secure_notification_channel_team_email" "sample-gchat" {
4343
if the notification channel is working. Default is false.
4444

4545
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
46-
Otherwise, it will share it with all teams, which is the default behaviour.
46+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
4747

4848
## Attributes Reference
4949

website/docs/r/secure_notification_channel_victorops.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ resource "sysdig_secure_notification_channel_victorops" "sample-victorops" {
4646
if the notification channel is working. Default is false.
4747

4848
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
49-
Otherwise, it will share it with all teams, which is the default behaviour.
49+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
5050

5151
## Attributes Reference
5252

website/docs/r/secure_notification_channel_webhook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ In addition to all arguments above, the following attributes are exported:
6262
* `version` - (Computed) The current version of the Notification Channel.
6363

6464
* `share_with_current_team` - (Optional) If set to `true` it will share notification channel only with current team (in which user is logged in).
65-
Otherwise, it will share it with all teams, which is the default behaviour.
65+
Otherwise, it will share it with all teams, which is the default behaviour. Although this is an optional setting, beware that if you have lower permissions than admin you may see a `error: 403 Forbidden` if this is not set to `true`.
6666

6767
## Import
6868

0 commit comments

Comments
 (0)