Teams

Accept invitation to be a team member

post
Authorizations
Body
accept_invitation_tokenstringRequired

The token received in the mail

Responses
200

Invitation has been accepted

application/json
post
POST /teams/accept-member-invite HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "accept_invitation_token": "text"
}
{
  "id": 1,
  "team_owner_id": 1,
  "name": "text"
}

Send email invitations to a list of emails

post
Authorizations
Path parameters
idintegerRequired

An ID

Body
emailsarrayRequired

The emails list

Responses
200

Invitations have been sent

application/json
post
POST /teams/{id}/invite HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "emails": []
}
{
  "code": 1
}

Update a Team

patch
Authorizations
Path parameters
idintegerRequired

An ID

Body
namestringRequired

The new team name

retentionPolicyobjectOptional

The team data retention policy

storeSubjectRefbooleanOptional

Whether to store the subject reference in the team

Responses
200

Team has been updated

application/json
patch
PATCH /teams/{id} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "name": "text",
  "retentionPolicy": {},
  "storeSubjectRef": true
}
{
  "id": 1,
  "team_owner_id": 1,
  "name": "text"
}

List all Team Member Invitations

get
Authorizations
Path parameters
idintegerRequired

An ID

Query parameters
offsetinteger · int32Optional

How many items to offset by for pagination

Default: 0
limitinteger · int32 · min: 1 · max: 64Optional

How many items to return at one time (max 64)

Default: 64
statusstringOptional

Filter invitations by status (pending, canceled, accepted)

Responses
200

A paged array of invitations

application/json
get
GET /teams/{id}/invitations HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Accept: */*
[
  {
    "id": 1,
    "email": "text",
    "status": "pending"
  }
]

Resend the invitation email

post
Authorizations
Path parameters
idintegerRequired

An ID

invitation_idstringRequired

An ID

Responses
200

The invitation has been resent

application/json
post
POST /teams/{id}/invitations/{invitation_id}/resend HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Accept: */*
{
  "code": 1
}

Cancel the current invitation

post
Authorizations
Path parameters
idintegerRequired

An ID

invitation_idstringRequired

An ID

Responses
200

The invitation has been canceled.

application/json
post
POST /teams/{id}/invitations/{invitation_id}/cancel HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Accept: */*
{
  "code": 1
}

List all Team Members

get
Authorizations
Path parameters
idintegerRequired

An ID

Query parameters
offsetinteger · int32Optional

How many items to offset by for pagination

Default: 0
limitinteger · int32 · min: 1 · max: 64Optional

How many items to return at one time (max 64)

Default: 64
Responses
200

A paged array of team members

application/json
get
GET /teams/{id}/members HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Accept: */*
[
  {
    "id": 1,
    "name": "text",
    "email": "text",
    "image": "text",
    "role": "member"
  }
]

Deletes a single team member

delete
Authorizations
Path parameters
idintegerRequired

An ID

user_idstringRequired

An ID

Responses
200

Team member deleted

delete
DELETE /teams/{id}/members/{user_id} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Accept: */*

No content

Update a team member

patch
Authorizations
Path parameters
idstringRequired

An ID

user_idstringRequired

An ID

Body
rolestring · enumRequired

The new team member role

Possible values:
Responses
200

Team member updated

application/json
patch
PATCH /teams/{id}/members/{user_id} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "role": "member"
}
{
  "id": 1,
  "name": "text",
  "email": "text",
  "image": "text",
  "role": "member"
}

Last updated

Was this helpful?