SIsigmacomputing
API credentials

Create an API credential

This endpoint creates a new API credential for use with API connectors and the Call API action in Sigma. For more information on API credentials, see Configure API credentials and connectors in Sigma.

Usage notes

  • The user making this request must be assigned an account type with the Manage API connectors permission enabled.
  • The allowlist parameter is required and must contain at least one hostname glob pattern. Use ["*"] to allow the credential to be used against any host.
  • The following authentication methods are supported: basic, bearer, apiKey, oAuthClientCredentials, oAuthAuthorizationCode, oAuthPasswordCredentials, awsSigV4.
  • Secret fields are encrypted at rest and are never returned in subsequent read responses.

Usage scenarios

  • Credential provisioning: Automate credential creation as part of environment setup or onboarding.
  • Multi-service authentication: Create separate credentials for each external service, with allowlists scoped to only that service's domains.
post/v2/api-credentials

Request

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

Request body

namestring required

Display name of the credential.

allowliststring[] required

Hostname glob patterns the credential may be used against (e.g. ["*.example.com"]). Required and must not be empty; use ["*"] to allow every host.

descriptionstring

Human-readable description.

Response

The response body.

apiCredentialIdstring required

Unique identifier of the API credential.

namestring required

Display name of the credential.

authMethod'basic' | 'bearer' | 'apiKey' | 'oAuthClientCredentials' | 'oAuthAuthorizationCode' | 'oAuthPasswordCredentials' | 'awsSigV4' required

Authentication method the credential uses.

allowliststring[] required

Hostname glob patterns (e.g. *.example.com) that the credential is authorized to be used against.

createdBystring required

The identifier of the user who created this object.

updatedBystring required

The identifier of the user or process that last updated this object.

createdAtstring date-time required

When the object was created.

updatedAtstring date-time required

When the object was last updated.

descriptionstring

Human-readable description.

Changes

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