Grant/revoke permissions on the dashboard to/from a list of Security Identities (groups, users, account)

curl --request PATCH \
  --url http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/acls/bulk \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
[
  {
    "sid": {
      "id": "5ea2da788669fa30869b50b4",
      "type": "ACCOUNT"
    },
    "grant": [],
    "revoke": []
  }
]
'

import requests

url = "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/acls/bulk"

payload = [
    {
        "sid": {
            "id": "5ea2da788669fa30869b50b4",
            "type": "ACCOUNT"
        },
        "grant": [],
        "revoke": []
    }
]
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify([
    {sid: {id: '5ea2da788669fa30869b50b4', type: 'ACCOUNT'}, grant: [], revoke: []}
  ])
};

fetch('http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/acls/bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/acls/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'sid' => [
                'id' => '5ea2da788669fa30869b50b4',
                'type' => 'ACCOUNT'
        ],
        'grant' => [
                
        ],
        'revoke' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/acls/bulk"

	payload := strings.NewReader("[\n  {\n    \"sid\": {\n      \"id\": \"5ea2da788669fa30869b50b4\",\n      \"type\": \"ACCOUNT\"\n    },\n    \"grant\": [],\n    \"revoke\": []\n  }\n]")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/vnd.composer.v3+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/acls/bulk")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("[\n  {\n    \"sid\": {\n      \"id\": \"5ea2da788669fa30869b50b4\",\n      \"type\": \"ACCOUNT\"\n    },\n    \"grant\": [],\n    \"revoke\": []\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/acls/bulk")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "[\n  {\n    \"sid\": {\n      \"id\": \"5ea2da788669fa30869b50b4\",\n      \"type\": \"ACCOUNT\"\n    },\n    \"grant\": [],\n    \"revoke\": []\n  }\n]"

response = http.request(request)
puts response.read_body

Grant/revoke permissions on the dashboard to/from a list of Security Identities (groups, users, account)

curl --request PATCH \
  --url http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/acls/bulk \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
[
  {
    "sid": {
      "id": "5ea2da788669fa30869b50b4",
      "type": "ACCOUNT"
    },
    "grant": [],
    "revoke": []
  }
]
'

import requests

url = "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/acls/bulk"

payload = [
    {
        "sid": {
            "id": "5ea2da788669fa30869b50b4",
            "type": "ACCOUNT"
        },
        "grant": [],
        "revoke": []
    }
]
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify([
    {sid: {id: '5ea2da788669fa30869b50b4', type: 'ACCOUNT'}, grant: [], revoke: []}
  ])
};

fetch('http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/acls/bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/acls/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'sid' => [
                'id' => '5ea2da788669fa30869b50b4',
                'type' => 'ACCOUNT'
        ],
        'grant' => [
                
        ],
        'revoke' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/acls/bulk"

	payload := strings.NewReader("[\n  {\n    \"sid\": {\n      \"id\": \"5ea2da788669fa30869b50b4\",\n      \"type\": \"ACCOUNT\"\n    },\n    \"grant\": [],\n    \"revoke\": []\n  }\n]")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/vnd.composer.v3+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/acls/bulk")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("[\n  {\n    \"sid\": {\n      \"id\": \"5ea2da788669fa30869b50b4\",\n      \"type\": \"ACCOUNT\"\n    },\n    \"grant\": [],\n    \"revoke\": []\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/acls/bulk")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "[\n  {\n    \"sid\": {\n      \"id\": \"5ea2da788669fa30869b50b4\",\n      \"type\": \"ACCOUNT\"\n    },\n    \"grant\": [],\n    \"revoke\": []\n  }\n]"

response = http.request(request)
puts response.read_body

Authorizations

Authorization

string

header

required

HTTP Basic authentication using global administrator credentials (username and password).

Path Parameters

dashboardId

string

required

Dashboard identifier

Body

application/vnd.composer.v3+json

sid

object

required

Security Identity

Show child attributes

grant

enum<string>[]

required

Permissions to be granted

Available options:

READ,

WRITE,

DELETE,

DATA_ACCESS,

COMMENT,

CREATE,

ADMINISTER

revoke

enum<string>[]

required

Permissions to be revoked

Available options:

READ,

WRITE,

DELETE,

DATA_ACCESS,

COMMENT,

CREATE,

ADMINISTER

Response

The permissions were assigned successfully

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

Grant/revoke permissions on the dashboard to/from a list of Security Identities (groups, users, account)

Authorizations

Path Parameters

Body

Response