List Access Relationships - Serval Documentation

GET

access-relationships

List Access Relationships

curl --request GET \
  --url https://public.api.serval.com/v2/access-relationships \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://public.api.serval.com/v2/access-relationships")
  .header("Authorization", "Bearer <token>")
  .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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "<string>",
      "targetId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "subjectId": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

{
  "message": "<string>",
  "detail": {
    "type": "<string>",
    "value": "<string>",
    "debug": {}
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

subjectType

enum<string>

required

The kind of subject to list relationships for.

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

subjectId

string

required

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

targetId

string

Filter by target ID (user or group ID).

targetType

enum<string>

Filter by target type.

Available options:

ACCESS_RELATIONSHIP_TARGET_TYPE_UNSPECIFIED,

ACCESS_RELATIONSHIP_TARGET_TYPE_USER,

ACCESS_RELATIONSHIP_TARGET_TYPE_GROUP

relationshipType

enum<string>

Filter by relationship type.

Available options:

ACCESS_RELATIONSHIP_TYPE_UNSPECIFIED,

ACCESS_RELATIONSHIP_TYPE_OWNER

pageSize

integer<int32>

Maximum number of results to return per page.

pageToken

string

Token for retrieving the next page of results.

Response

Success

data

AccessRelationship · object[]

The list of access relationships.

Show child attributes

nextPageToken

string | null

Token for retrieving the next page of results. Empty if no more results.

List Access Relationships

curl --request GET \
  --url https://public.api.serval.com/v2/access-relationships \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://public.api.serval.com/v2/access-relationships")
  .header("Authorization", "Bearer <token>")
  .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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "<string>",
      "targetId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "subjectId": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

{
  "message": "<string>",
  "detail": {
    "type": "<string>",
    "value": "<string>",
    "debug": {}
  }
}