Skip to main content
GET
/
v2
/
access-relationships
List Access Relationships
curl --request GET \
  --url https://public.api.serval.com/v2/access-relationships \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "targetId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "subjectId": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

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.

​
nextPageToken
string | null

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