Share a namespace with a user

Grant another user viewer or editor access to a namespace. The grant cascades to all datasets within the namespace. Only the namespace owner may share.

POST /permissions/namespaces/{username}/{namespace}/shares

Share a namespace with a user

cURL

curl --request POST \
  --url https://api.datalinks.com/api/v1/permissions/namespaces/{username}/{namespace}/shares \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "alice",
  "role": "viewer"
}
'

import requests

url = "https://api.datalinks.com/api/v1/permissions/namespaces/{username}/{namespace}/shares"

payload = {
    "username": "alice",
    "role": "viewer"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({username: 'alice', role: 'viewer'})
};

fetch('https://api.datalinks.com/api/v1/permissions/namespaces/{username}/{namespace}/shares', 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://api.datalinks.com/api/v1/permissions/namespaces/{username}/{namespace}/shares",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'username' => 'alice',
    'role' => 'viewer'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/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 := "https://api.datalinks.com/api/v1/permissions/namespaces/{username}/{namespace}/shares"

	payload := strings.NewReader("{\n  \"username\": \"alice\",\n  \"role\": \"viewer\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.post("https://api.datalinks.com/api/v1/permissions/namespaces/{username}/{namespace}/shares")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"username\": \"alice\",\n  \"role\": \"viewer\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.datalinks.com/api/v1/permissions/namespaces/{username}/{namespace}/shares")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"username\": \"alice\",\n  \"role\": \"viewer\"\n}"

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

401

{
  "error_code": "UNAUTHORIZED",
  "message": "Missing authentication token",
  "error_message": "",
  "sub_errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error_code": "UNAUTHORIZED",
  "message": "Missing authentication token",
  "error_message": "",
  "sub_errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error_code": "UNAUTHORIZED",
  "message": "Missing authentication token",
  "error_message": "",
  "sub_errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

bearerAuthopenId

Authorization · string · header · required

Use a Bearer token for authentication. Submit the token using the Authorization header: Authorization: Bearer <token>.

Path Parameters

username · string · required

The username associated with the request.

namespace · string · required

Namespace for the dataset.

Body

application/json

username · string · required

Username of the user to grant or revoke access for.

Example:

"alice"

role · enum<string> · required

Access level. 'viewer' is read-only; 'editor' is read and write.

Available options: viewer, editor

Example:

"viewer"

Response

200

Access was granted.