Sigma REST APIAPI credentials

Get an API credential

View as MarkdownOpen in Claude
This endpoint returns nonsensitive details for a single API credential. For more information on API credentials, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/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](https://help.sigmacomputing.com/reference/list-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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

apiCredentialIdstringRequired

Response

The response body.
apiCredentialIdstring
Unique identifier of the API credential.
namestring
Display name of the credential.
authMethodenum
Authentication method the credential uses.
allowlistlist of strings

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

credentialobject

Nonsensitive projection of the credential, discriminated by authMethod. Secret fields (password, token, clientSecret, secretAccessKey) are never returned.

createdBystring
The identifier of the user who created this object.
updatedBystring
The identifier of the user or process that last updated this object.
createdAtdatetime
When the object was created.
updatedAtdatetime
When the object was last updated.
descriptionstring

Human-readable description.