Skip to main content
PATCH
/
trust-centers
/
{slugId}
/
viewers
/
{viewerId}
Update Trust Center viewer
curl --request PATCH \
  --url https://api.vanta.com/v1/trust-centers/{slugId}/viewers/{viewerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resourceIds": [
    "<string>"
  ],
  "expirationDate": "2023-11-07T05:31:56Z",
  "isNdaRequired": true,
  "customerTrustAccountId": "<string>"
}
'
{
  "id": "a2f7e1b9d0c3f4e5a6c7b8d9",
  "email": "exampleviewer@company.com",
  "name": "Example Viewer",
  "companyName": "Viewer Company, Inc.",
  "resourceIds": null,
  "accessLevel": "FULL_ACCESS",
  "ndaInfo": null,
  "externalServiceAssociations": [
    {
      "service": "SALESFORCE",
      "id": "0032S000062DfqnQBG",
      "objectType": "Salesforce Contact"
    }
  ],
  "creationDate": "2020-01-01T00:00:00.000Z",
  "updatedDate": "2020-01-01T00:00:00.000Z",
  "expirationDate": null,
  "addedByUser": null
}

Documentation Index

Fetch the complete documentation index at: https://developer.vanta.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Path Parameters

slugId
string
required
viewerId
string
required

Body

application/json
accessLevel
enum<string>

Access level for the viewer.

Available options:
FULL_ACCESS,
PARTIAL_ACCESS
resourceIds
string[]

Identifiers for the resources that this viewer should have access to.

expirationDate
string<date-time> | null

The date access should expire for this viewer. Set to null to remove expiration.

isNdaRequired
boolean

Whether to require an NDA for the viewer.

customerTrustAccountId
string | null

ID of a Customer Trust Account to associate with this viewer. Set to null to remove the association. Omit to leave unchanged.

Response

200 - application/json

Ok

id
string
required

Unique identifier for the viewer.

email
string
required

Email of the viewer.

name
string | null
required

Name of the viewer.

companyName
string | null
required

Name of the viewer's company.

resourceIds
string[] | null
required

IDs for the resources this viewer has access to. If null, the viewer has access to all resources on the Trust Center.

accessLevel
enum<string>
required

Access level of the viewer.

Available options:
FULL_ACCESS,
PARTIAL_ACCESS
ndaInfo
object
required

NDA-related information for the viewer.

externalServiceAssociations
object[] | null
required

Objects in external services that the viewer is associated with.

creationDate
string<date-time>
required

Date the viewer was created.

updatedDate
string<date-time>
required

Date the viewer was last updated.

expirationDate
string<date-time> | null
required

Expiration date for the viewer's access.

addedByUser
object
required

User that shared the Trust Center with this viewer.