Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS-9168] updating restricted roles for monitors #26425

Closed
wants to merge 1 commit into from
+7 −5
Closed

[DOCS-9168] updating restricted roles for monitors #26425

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions content/en/monitors/guide/how-to-set-up-rbac-for-monitors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@
}
```

Use the [Create][2] or [Edit a monitor][3] API endpoint and the `restricted_roles` parameter to restrict monitor editing to a specific set of roles and to the monitor's creator.
Use the [Create][2] or [Edit a monitor][3] API endpoint and the `restriction_policy` parameter to restrict monitor editing to a specific set of roles and to the monitor's creator.

Check notice on line 86 in content/en/monitors/guide/how-to-set-up-rbac-for-monitors.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.sentencelength 

Suggestion: Try to keep your sentence length to 25 words or fewer.

**Note:** You can specify one or multiple role UUIDs. Setting `restricted_roles` to `null` allows monitor editing for all users with [Monitor Write permissions][4].
**Note:** You can specify one or multiple role UUIDs. Setting `restriction_policy` to `null` allows monitor editing for all users with [Monitor Write permissions][4].

```bash
curl --location --request POST 'https://api.datadoghq.com/api/v1/monitor' \
Expand All @@ -105,7 +105,7 @@
"frontend"
],
"type": "query alert",
"restricted_roles": ["89f5dh86-e470-11f8-e26f-4h656a27d9cc"]
"restriction_policy": ["89f5dh86-e470-11f8-e26f-4h656a27d9cc"]
}'
```

Expand All @@ -127,13 +127,15 @@

### API

You can update the definition of monitors that are managed through API or Terraform by using the `restricted_roles` parameter. You can also use the [Restriction Policies][4] endpoint to define the access control rules for a monitor, mapping a set of relations (such as editor and viewer) to a set of allowed principals (such as roles, teams, or users). The restriction policy determines who is authorized to perform what actions on the monitor.
You can update the definition of monitors that are managed through API or Terraform by using the [Restriction Policies][4] endpoint to define the access control rules for a monitor, mapping a set of relations (such as editor and viewer) to a set of allowed principals (such as roles, teams, or users). The restriction policy determines who is authorized to perform what actions on the monitor.

Check notice on line 130 in content/en/monitors/guide/how-to-set-up-rbac-for-monitors.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.sentencelength 

Suggestion: Try to keep your sentence length to 25 words or fewer.

For more information, see [Edit a monitor API endpoint][3] and [Restriction Policies API][4].

**Note**: The `restricted_roles` parameter has been deprecated.

### UI

All new monitors created from the UI use the `restricted_roles` parameter.
All new monitors created from the UI use the `restriction_policy` parameter.
All monitors also display the role restriction option regardless of the underlying mechanism:

{{< img src="/monitors/guide/monitor_rbac_non_restricted.jpg" alt="RBAC Non Restricted Monitor" >}}
Expand Down
Loading