Organizations

Update a storage integration

Update a storage integration configured for an organization. This endpoint replaces the identity details for the integration.

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.
patch/v2/organizations/settings/storageIntegrations/{storageIntegrationId}

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

storageIntegrationIdstring required

Unique identifier of the storage integration.

Request body

OR
OR

Response

The response body.

provider's3' | 'gcs' | 'azure' required

Cloud storage provider for the storage integration.

storageIntegrationIdstring required

Unique identifier of the storage integration.

allowedLocationstring required

Cloud storage URI Sigma writes to for the storage integration.

namestring

Display name of the storage integration.

kmsKeyNamestring

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

storageAwsRoleArnstring

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

externalIdstring

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

tenantIdstring

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

Changes

No recorded changes to this operation across all 1 revision of this API.