Update file permissions

Updates permissions for a specified file.

PUT /api/data/v1/data-files/{dataFileId}/permissions

Update file permissions

cURL

curl --request PUT \
  --url https://{instance}.domo.com/api/data/v1/data-files/{dataFileId}/permissions \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "publicAccess": true,
  "entries": [
    {
      "entityId": "<string>",
      "grant": "<string>",
      "pass": "<string>"
    }
  ]
}
'

import requests

url = "https://{instance}.domo.com/api/data/v1/data-files/{dataFileId}/permissions"

payload = {
    "publicAccess": True,
    "entries": [
        {
            "entityId": "<string>",
            "grant": "<string>",
            "pass": "<string>"
        }
    ]
}
headers = {
    "X-DOMO-Developer-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-DOMO-Developer-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    publicAccess: true,
    entries: [{entityId: '<string>', grant: '<string>', pass: '<string>'}]
  })
};

fetch('https://{instance}.domo.com/api/data/v1/data-files/{dataFileId}/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_URL => "https://{instance}.domo.com/api/data/v1/data-files/{dataFileId}/permissions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'publicAccess' => true,
    'entries' => [
        [
                'entityId' => '<string>',
                'grant' => '<string>',
                'pass' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-DOMO-Developer-Token: <api-key>"
  ],
]);

$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 := "https://{instance}.domo.com/api/data/v1/data-files/{dataFileId}/permissions"

	payload := strings.NewReader("{\n  \"publicAccess\": true,\n  \"entries\": [\n    {\n      \"entityId\": \"<string>\",\n      \"grant\": \"<string>\",\n      \"pass\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("X-DOMO-Developer-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{instance}.domo.com/api/data/v1/data-files/{dataFileId}/permissions")
  .header("X-DOMO-Developer-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"publicAccess\": true,\n  \"entries\": [\n    {\n      \"entityId\": \"<string>\",\n      \"grant\": \"<string>\",\n      \"pass\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.domo.com/api/data/v1/data-files/{dataFileId}/permissions")

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

request = Net::HTTP::Put.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"publicAccess\": true,\n  \"entries\": [\n    {\n      \"entityId\": \"<string>\",\n      \"grant\": \"<string>\",\n      \"pass\": \"<string>\"\n    }\n  ]\n}"

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

200

{}

Authorizations

X-DOMO-Developer-Token · string · header · required

Domo Developer Token for authentication (Assumed based on similar APIs).

Path Parameters

dataFileId · integer · required

Body

application/json

A permissions object.

publicAccess · boolean

entries · object[]

Show child attributes

Response

200

application/json

OK. Permissions updated successfully.

An empty object indicating success.