Get details for resource kind

Gets details for a specific resource type (kind) such as S3Bucket or CloudwatchLogGroup.

GET /integrations/{integrationId}/resource-kinds/{resourceKind}

Get details for resource kind

cURL

curl --request GET \
  --url https://api.vanta.com/v1/integrations/{integrationId}/resource-kinds/{resourceKind} \
  --header 'Authorization: Bearer <token>'

200

{
  "integrationId": "asana",
  "resourceKind": "AsanaAccount",
  "isScopable": true,
  "canUpdateDescription": true,
  "canUpdateOwner": true,
  "numResources": 123,
  "numInScope": 100,
  "numOwned": 100,
  "numWithDescription": 100
}

Authorizations

Authorization · string · header · required

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

Path Parameters

integrationId · string · required

Unique identifier of the integration.

resourceKind · string · required

Unique identifier of the integration resource kind.

Query Parameters

connectionId · string

Unique identifier of the integration connection.

Response

200 - application/json

Ok

integrationId · string · required

The unique identifier for the Integration that ingests this resource.

resourceKind · string · required

The identifier for the resource type, unique within the scope of an Integration.

isScopable · boolean · required

Whether resources of this type may be scoped out of an audit.

canUpdateDescription · boolean · required

Whether resources of this type may be assigned a description.

canUpdateOwner · boolean · required

Whether resources of this type may be assigned an owner.

numResources · integer<int32> · required

The count of resources of the given type.

Required range: x >= 0

numInScope · integer<int32> · required

The count of resources of the given type that are in scope for audits.

Required range: x >= 0

numOwned · integer<int32> · required

The count of resources of the given type that have been assigned an owner in Vanta.

Required range: x >= 0

numWithDescription · integer<int32> · required

The count of resources of the given type that have been given a description in Vanta.

Required range: x >= 0