SIsigmacomputing
API credentials

Get an API credential

This endpoint returns nonsensitive details for a single API credential. 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 and have at least Can view access on the credential.
  • Retrieve the apiCredentialId by calling the /v2/api-credentials endpoint.
  • Secret fields (passwords, tokens, client secrets, secret access keys) are never returned.

Usage scenarios

  • Credential inspection: Retrieve the configuration of a credential to verify its settings before using it with a connector.
get/v2/api-credentials/{apiCredentialId}

Request

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

Path parameters

apiCredentialIdstring required

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.