Skip to main content
POST
/
v2
/
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>"
}
'
{
  "data": {
    "id": "<string>",
    "targetId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "subjectId": "<string>"
  }
}

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
​
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

Success

​
data
data · object

The created access relationship.