From 3af03310229dfabdbe77830b97e3e5d0fc8ae326 Mon Sep 17 00:00:00 2001 From: "Grot (@grafanabot)" <43478413+grafanabot@users.noreply.github.com> Date: Fri, 11 Feb 2022 14:48:16 +0100 Subject: [PATCH] Update access_controls.md: Add global to documented query parameter for deleting custom roles. (#40167) (#45270) * Update access_controls.md Update the parameter table for deleting custom roles to make it explicit that the `global` query parameter is handled by this endpoint/should be specified when deleting a globally-scoped role. * Update docs/sources/http_api/access_control.md Co-authored-by: Karl Persson Co-authored-by: achatterjee-grafana (cherry picked from commit 1239911b5b23b4d82fcd5d2703c656dae1b9f234) Co-authored-by: Roberto Acevedo --- docs/sources/http_api/access_control.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/sources/http_api/access_control.md b/docs/sources/http_api/access_control.md index f9b5f9a0dda..9b61737d7e1 100644 --- a/docs/sources/http_api/access_control.md +++ b/docs/sources/http_api/access_control.md @@ -433,9 +433,10 @@ Accept: application/json #### Query parameters -| Param | Type | Required | Description | -| ----- | ------- | -------- | ----------------------------------------------------------------------- | -| force | boolean | No | When set to `true`, the role will be deleted with all it's assignments. | +| Param | Type | Required | Description | +| ------ | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| force | boolean | No | When set to `true`, the role will be deleted with all it's assignments. | +| global | boolean | No | A flag indicating if the role is global or not. If set to false, the default org ID of the authenticated user will be used from the request. Refer to the [Role scopes]({{< relref "../enterprise/access-control/roles.md#built-in-role-assignments" >}}) for more information. | #### Example response