(experimental) Share/revoke access level on the dashboard

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

import requests

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

payload = {
    "share": [{ "sid": {
                "id": "5ea2da788669fa30869b50b4",
                "type": "ACCOUNT"
            } }],
    "revoke": [{ "sid": {
                "id": "5ea2da788669fa30869b50b4",
                "type": "ACCOUNT"
            } }],
    "update": [{ "sid": {
                "id": "5ea2da788669fa30869b50b4",
                "type": "ACCOUNT"
            } }]
}
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({
    share: [{sid: {id: '5ea2da788669fa30869b50b4', type: 'ACCOUNT'}}],
    revoke: [{sid: {id: '5ea2da788669fa30869b50b4', type: 'ACCOUNT'}}],
    update: [{sid: {id: '5ea2da788669fa30869b50b4', type: 'ACCOUNT'}}]
  })
};

fetch('http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/permissions', 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}/permissions",
  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([
    'share' => [
        [
                'sid' => [
                                'id' => '5ea2da788669fa30869b50b4',
                                'type' => 'ACCOUNT'
                ]
        ]
    ],
    'revoke' => [
        [
                'sid' => [
                                'id' => '5ea2da788669fa30869b50b4',
                                'type' => 'ACCOUNT'
                ]
        ]
    ],
    'update' => [
        [
                'sid' => [
                                'id' => '5ea2da788669fa30869b50b4',
                                'type' => 'ACCOUNT'
                ]
        ]
    ]
  ]),
  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}/permissions"

	payload := strings.NewReader("{\n  \"share\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\n  ],\n  \"revoke\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\n  ],\n  \"update\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\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}/permissions")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"share\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\n  ],\n  \"revoke\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\n  ],\n  \"update\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"share\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\n  ],\n  \"revoke\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\n  ],\n  \"update\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\n  ]\n}"

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

(experimental) Share/revoke access level on the dashboard

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

import requests

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

payload = {
    "share": [{ "sid": {
                "id": "5ea2da788669fa30869b50b4",
                "type": "ACCOUNT"
            } }],
    "revoke": [{ "sid": {
                "id": "5ea2da788669fa30869b50b4",
                "type": "ACCOUNT"
            } }],
    "update": [{ "sid": {
                "id": "5ea2da788669fa30869b50b4",
                "type": "ACCOUNT"
            } }]
}
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({
    share: [{sid: {id: '5ea2da788669fa30869b50b4', type: 'ACCOUNT'}}],
    revoke: [{sid: {id: '5ea2da788669fa30869b50b4', type: 'ACCOUNT'}}],
    update: [{sid: {id: '5ea2da788669fa30869b50b4', type: 'ACCOUNT'}}]
  })
};

fetch('http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/permissions', 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}/permissions",
  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([
    'share' => [
        [
                'sid' => [
                                'id' => '5ea2da788669fa30869b50b4',
                                'type' => 'ACCOUNT'
                ]
        ]
    ],
    'revoke' => [
        [
                'sid' => [
                                'id' => '5ea2da788669fa30869b50b4',
                                'type' => 'ACCOUNT'
                ]
        ]
    ],
    'update' => [
        [
                'sid' => [
                                'id' => '5ea2da788669fa30869b50b4',
                                'type' => 'ACCOUNT'
                ]
        ]
    ]
  ]),
  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}/permissions"

	payload := strings.NewReader("{\n  \"share\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\n  ],\n  \"revoke\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\n  ],\n  \"update\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\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}/permissions")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"share\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\n  ],\n  \"revoke\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\n  ],\n  \"update\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"share\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\n  ],\n  \"revoke\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\n  ],\n  \"update\": [\n    {\n      \"sid\": {\n        \"id\": \"5ea2da788669fa30869b50b4\",\n        \"type\": \"ACCOUNT\"\n      }\n    }\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

Defines access level that should be shared or revoked from a User Security Identity

Access level to be shared

Show child attributes

revoke

object[]

required

Access level to be revoked

Show child attributes

update

object[]

Access level to be updated

Show child attributes

Response

The access level was assigned successfully

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

(experimental) Share/revoke access level on the dashboard

Authorizations

Path Parameters

Body

Response