Skip to main content
POST
/
access_grants
Create access grant
curl --request POST \
  --url https://api.vantage.sh/v2/access_grants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resource_token": "<string>",
  "team_token": "<string>"
}
'
import requests

url = "https://api.vantage.sh/v2/access_grants"

payload = {
"resource_token": "<string>",
"team_token": "<string>"
}
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({resource_token: '<string>', team_token: '<string>'})
};

fetch('https://api.vantage.sh/v2/access_grants', 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.vantage.sh/v2/access_grants",
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([
'resource_token' => '<string>',
'team_token' => '<string>'
]),
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.vantage.sh/v2/access_grants"

payload := strings.NewReader("{\n \"resource_token\": \"<string>\",\n \"team_token\": \"<string>\"\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.vantage.sh/v2/access_grants")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"resource_token\": \"<string>\",\n \"team_token\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.vantage.sh/v2/access_grants")

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 \"resource_token\": \"<string>\",\n \"team_token\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "token": "rsrc_accss_grnt_9f8aeb3cedda3831",
  "resource_token": "rprt_3b935d26cba36fb0",
  "access": "denied",
  "team_token": "team_26865e16e46028ae",
  "created_at": "2024-01-18T17:39:37Z",
  "created_by": "usr_2fc38883da3726b9"
}
{
"errors": [
"<string>"
],
"links": {
"self": "<string>",
"first": "<string>",
"next": "<string>",
"last": "<string>",
"prev": "<string>"
}
}
{
"errors": [
"<string>"
],
"links": {
"self": "<string>",
"first": "<string>",
"next": "<string>",
"last": "<string>",
"prev": "<string>"
}
}
{
"errors": [
"<string>"
],
"links": {
"self": "<string>",
"first": "<string>",
"next": "<string>",
"last": "<string>",
"prev": "<string>"
}
}
{
"errors": [
"<string>"
],
"links": {
"self": "<string>",
"first": "<string>",
"next": "<string>",
"last": "<string>",
"prev": "<string>"
}
}
{
"errors": [
"<string>"
],
"links": {
"self": "<string>",
"first": "<string>",
"next": "<string>",
"last": "<string>",
"prev": "<string>"
}
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Create an Access Grant.

resource_token
string
required

The token of the resource for which you are granting access.

team_token
string
required

The token of the Team you want to grant access to.

access
enum<string>

The access level you want to grant. Defaults to 'allowed'.

Available options:
denied,
allowed

Response

AccessGrant model

token
string
required
resource_token
string
required

The token for any resource the AccessGrant is applied to.

Example:

"rprt_abcd1234"

access
string
required

The access status of the AccessGrant.

team_token
string | null
required

The Team token for which an AccessGrant is applied to.

created_at
string
required

The date and time, in UTC, the AccessGrant was created. ISO 8601 Formatted.

Example:

"2023-08-04T00:00:00Z"

created_by
string | null
required

The token for the User who created the AccessGrant.