Create Access Relationship - Serval Documentation

POST

access-relationships

Create Access Relationship

curl --request POST \
  --url https://public.api.serval.com/v2/access-relationships \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subjectId": "<string>",
  "targetId": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/access-relationships"

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

fetch('https://public.api.serval.com/v2/access-relationships', 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://public.api.serval.com/v2/access-relationships",
  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([
    'subjectId' => '<string>',
    'targetId' => '<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://public.api.serval.com/v2/access-relationships"

	payload := strings.NewReader("{\n  \"subjectId\": \"<string>\",\n  \"targetId\": \"<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://public.api.serval.com/v2/access-relationships")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subjectId\": \"<string>\",\n  \"targetId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/access-relationships")

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  \"subjectId\": \"<string>\",\n  \"targetId\": \"<string>\"\n}"

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

{
  "data": {
    "id": "<string>",
    "relationshipType": "ACCESS_RELATIONSHIP_TYPE_UNSPECIFIED",
    "targetId": "<string>",
    "targetType": "ACCESS_RELATIONSHIP_TARGET_TYPE_UNSPECIFIED",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "subjectType": "ACCESS_RELATIONSHIP_SUBJECT_TYPE_UNSPECIFIED",
    "subjectId": "<string>"
  }
}

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.

Credential	Access requirements
Organization-scoped API key	Integration, Resource, Role: `apps:write` Knowledge item: `knowledge:write` Team: `teams:manage`
Team-scoped API key	Integration, Resource, Role: `apps:write` Knowledge item: `knowledge:write` Team: Unsupported
User-based token (OAuth)	Supported, subject to permissions

Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

subjectType

enum<string>

required

The kind of subject the relationship is on.

Available options:

ACCESS_RELATIONSHIP_SUBJECT_TYPE_UNSPECIFIED,

ACCESS_RELATIONSHIP_SUBJECT_TYPE_APP_INSTANCE,

ACCESS_RELATIONSHIP_SUBJECT_TYPE_RESOURCE,

ACCESS_RELATIONSHIP_SUBJECT_TYPE_ENTITLEMENT,

ACCESS_RELATIONSHIP_SUBJECT_TYPE_TEAM,

ACCESS_RELATIONSHIP_SUBJECT_TYPE_KNOWLEDGE_ITEM

subjectId

string

required

The ID of the subject (app_instance_id | resource_id | entitlement_id | team_id), disambiguated by subject_type.

relationshipType

enum<string>

required

The type of relationship.

Available options:

ACCESS_RELATIONSHIP_TYPE_UNSPECIFIED,

ACCESS_RELATIONSHIP_TYPE_OWNER

targetId

string

required

The ID of the target (user or group).

targetType

enum<string>

required

The type of the target.

Available options:

ACCESS_RELATIONSHIP_TARGET_TYPE_UNSPECIFIED,

ACCESS_RELATIONSHIP_TARGET_TYPE_USER,

ACCESS_RELATIONSHIP_TARGET_TYPE_GROUP

Response

200 - application/json

Success

data

data · object

The created access relationship.

Show child attributes

Create Access Relationship

curl --request POST \
  --url https://public.api.serval.com/v2/access-relationships \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subjectId": "<string>",
  "targetId": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/access-relationships"

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

fetch('https://public.api.serval.com/v2/access-relationships', 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://public.api.serval.com/v2/access-relationships",
  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([
    'subjectId' => '<string>',
    'targetId' => '<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://public.api.serval.com/v2/access-relationships"

	payload := strings.NewReader("{\n  \"subjectId\": \"<string>\",\n  \"targetId\": \"<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://public.api.serval.com/v2/access-relationships")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subjectId\": \"<string>\",\n  \"targetId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/access-relationships")

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  \"subjectId\": \"<string>\",\n  \"targetId\": \"<string>\"\n}"

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

{
  "data": {
    "id": "<string>",
    "relationshipType": "ACCESS_RELATIONSHIP_TYPE_UNSPECIFIED",
    "targetId": "<string>",
    "targetType": "ACCESS_RELATIONSHIP_TARGET_TYPE_UNSPECIFIED",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "subjectType": "ACCESS_RELATIONSHIP_SUBJECT_TYPE_UNSPECIFIED",
    "subjectId": "<string>"
  }
}

​Authentication and permissions

Authorizations

Body

Response

Authentication and permissions