Skip to content

Update Permissions

managedgrafana_update_permissions R Documentation

Updates which users in a workspace have the Grafana Admin or Editor roles

Description

Updates which users in a workspace have the Grafana Admin or Editor roles.

Usage

managedgrafana_update_permissions(updateInstructionBatch, workspaceId)

Arguments

updateInstructionBatch

[required] An array of structures that contain the permission updates to make.

workspaceId

[required] The ID of the workspace to update.

Value

A list with the following syntax:

list(
  errors = list(
    list(
      causedBy = list(
        action = "ADD"|"REVOKE",
        role = "ADMIN"|"EDITOR"|"VIEWER",
        users = list(
          list(
            id = "string",
            type = "SSO_USER"|"SSO_GROUP"
          )
        )
      ),
      code = 123,
      message = "string"
    )
  )
)

Request syntax

svc$update_permissions(
  updateInstructionBatch = list(
    list(
      action = "ADD"|"REVOKE",
      role = "ADMIN"|"EDITOR"|"VIEWER",
      users = list(
        list(
          id = "string",
          type = "SSO_USER"|"SSO_GROUP"
        )
      )
    )
  ),
  workspaceId = "string"
)