Sync all secrets

To send metadata of a secret used to access applications or infrastructure, use Secret.

This call replaces ALL existing Secret resources for the given app and source_id - this is a “state of the world” sync. In other words, if a Secret resource is sent for a user in a previous sync_all call, but is not included in a later sync_all call for that customer, it is assumed to no longer exist and is deleted in Vanta.

** Headers **

Authorization: Bearer <access_token>

** Scopes **

connectors.self:write-resource

** Schema **

Expand the resources array below for the schema of Secret.

PUT /v1/resources/secret

Sync all secrets

cURL

curl --request PUT \
  --url https://api.vanta.com/v1/resources/secret \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resourceId": "<string>",
  "resources": [
    {
      "displayName": "<string>",
      "uniqueId": "<string>",
      "externalUrl": "<string>",
      "name": "<string>",
      "description": "<string>",
      "createdTimestamp": "2023-11-07T05:31:56Z",
      "creator": "<string>",
      "owner": "<string>",
      "updatedTimestamp": "2023-11-07T05:31:56Z",
      "lastAccessedTimestamp": "2023-11-07T05:31:56Z",
      "expiresTimestamp": "2023-11-07T05:31:56Z"
    }
  ]
}
'

200

{
  "success": true
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

List of resources to sync

resourceId · string · required

Vanta generated identifier for the given resource, and can be found on the developer console page. See the list of registered resources and their IDs on https://app.vanta.com/settings/developer-console/<app_id>?tab=resources

resources · object[] · required

Show child attributes

Response

200 - application/json

The current resources synced.

success · boolean · required