Teams

Accept invitation to be a team member

post

https://api-testnet.truvera.iohttps://api.truvera.io

/teams/accept-member-invite

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

accept_invitation_tokenstringRequired

The token received in the mail

Responses

200

Invitation has been accepted

application/json

idintegerRequired

The team ID

team_owner_idintegerOptional

The team owner ID

namestring · nullableOptional

The team name

400

Error accepting the invitation

application/json

402

Transaction limit reached or upgrade required to proceed

application/json

post

/teams/accept-member-invite

HTTPcURLJavaScriptPython

POST /teams/accept-member-invite HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://api-testnet.truvera.iohttps://api.truvera.io

/teams/{id}/invite

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

An ID

Body

application/json

emailsarrayRequired

The emails list

Responses

200

Invitations have been sent

application/json

Default response

codeintegerOptional

400

Error sending the invitations

application/json

401

You are not the owner or the administrator of this team

application/json

402

Transaction limit reached or upgrade required to proceed

application/json

post

/teams/{id}/invite

HTTPcURLJavaScriptPython

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

{
  "emails": []
}

{
  "code": 1
}

Update a Team

patch

https://api-testnet.truvera.iohttps://api.truvera.io

/teams/{id}

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

An ID

Body

application/json

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

idintegerRequired

The team ID

team_owner_idintegerOptional

The team owner ID

namestring · nullableOptional

The team name

400

Error updating team

application/json

401

You are not the owner or the administrator of this team

application/json

patch

/teams/{id}

HTTPcURLJavaScriptPython

PATCH /teams/{id} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://api-testnet.truvera.iohttps://api.truvera.io

/teams/{id}/invitations

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

idintegerRequired

The team member invitation ID

emailstringRequired

The team member invitation email

statusstring · enumOptional

The team member invitation status

Possible values:

400

Application error

application/json

get

/teams/{id}/invitations

HTTPcURLJavaScriptPython

GET /teams/{id}/invitations HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "email": "text",
    "status": "pending"
  }
]

Resend the invitation email

post

https://api-testnet.truvera.iohttps://api.truvera.io

/teams/{id}/invitations/{invitation_id}/resend

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

An ID

invitation_idstringRequired

An ID

Responses

200

The invitation has been resent

application/json

Default response

codeintegerOptional

400

Application error

application/json

401

You are not the owner or the administrator of this team

application/json

404

Invitation not found

application/json

post

/teams/{id}/invitations/{invitation_id}/resend

HTTPcURLJavaScriptPython

POST /teams/{id}/invitations/{invitation_id}/resend HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": 1
}

Cancel the current invitation

post

https://api-testnet.truvera.iohttps://api.truvera.io

/teams/{id}/invitations/{invitation_id}/cancel

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

An ID

invitation_idstringRequired

An ID

Responses

200

The invitation has been canceled.

application/json

Default response

codeintegerOptional

400

Application error

application/json

401

You are not the owner or the administrator of this team

application/json

404

Invitation not found

application/json

post

/teams/{id}/invitations/{invitation_id}/cancel

HTTPcURLJavaScriptPython

POST /teams/{id}/invitations/{invitation_id}/cancel HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": 1
}

List all Team Members

get

https://api-testnet.truvera.iohttps://api.truvera.io

/teams/{id}/members

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

idintegerRequired

The team member ID

namestringRequired

The team member name

emailstringOptional

The team member email

imagestringOptional

The team member image

rolestring · enumOptional

The team member role

Possible values:

400

Application error

application/json

get

/teams/{id}/members

HTTPcURLJavaScriptPython

GET /teams/{id}/members HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Deletes a single team member

delete

https://api-testnet.truvera.iohttps://api.truvera.io

/teams/{id}/members/{user_id}

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

An ID

user_idstringRequired

An ID

Responses

200

Team member deleted

No content

400

Error deleting team member

application/json

401

You are not the owner or the administrator of this team

application/json

404

Team member was not found

application/json

delete

/teams/{id}/members/{user_id}

HTTPcURLJavaScriptPython

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

No content

Update a team member

patch

https://api-testnet.truvera.iohttps://api.truvera.io

/teams/{id}/members/{user_id}

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

An ID

user_idstringRequired

An ID

Body

application/json

rolestring · enumRequired

The new team member role

Possible values:

Responses

200

Team member updated

application/json

idintegerRequired

The team member ID

namestringRequired

The team member name

emailstringOptional

The team member email

imagestringOptional

The team member image

rolestring · enumOptional

The team member role

Possible values:

400

Error updating team member

application/json

401

You are not the owner or the administrator of this team

application/json

404

Team member was not found

application/json

patch

/teams/{id}/members/{user_id}

HTTPcURLJavaScriptPython

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

{
  "role": "member"
}

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