Skip to navigation
Sigma REST APIOrganizationsstorageIntegrations

Create a storage integration

View as Markdown

Configure a storage integration that uses a customer-owned cloud storage bucket.

Usage notes

  • To perform this operation, you must use API credentials owned by a user assigned the Admin account type.
  • To read or update storage integrations for a tenant organization, use impersonation to obtain a token for that tenant, then call this endpoint with that token.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.
objectRequired
AWS S3 storage integration.
OR
objectRequired
Google Cloud Storage storage integration.
OR
objectRequired
Azure Blob Storage storage integration.

Response

The response body.
providerenum
Cloud storage provider for the storage integration.
Allowed values:
storageIntegrationIdstring
Unique identifier of the storage integration.
allowedLocationstring
Cloud storage URI Sigma writes to for the storage integration.
namestringOptional
Display name of the storage integration.
kmsKeyNamestringOptional

KMS key Sigma uses to encrypt objects written to the bucket. Relevant only when provider is s3.

storageAwsRoleArnstringOptional

AWS IAM role ARN Sigma assumes to access the bucket. Relevant only when provider is s3.

externalIdstringOptional

External ID Sigma includes in the AWS role trust policy request. Relevant only when provider is s3.

tenantIdstringOptional

Azure AD tenant ID that owns the storage account. Relevant only when provider is azure.