SIsigmacomputing
API credentials

Update an API credential

This endpoint updates one or more fields on an existing 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 Can edit access to the API credential.
  • Retrieve the apiCredentialId by calling the /v2/api-credentials endpoint.
  • Omitted fields are left unchanged.
  • If a credential is provided, the provided authentication details (ID, secret, etc.) replace the previous values. To leave secrets unchanged, omit the credential parameter.

Usage scenarios

  • Secret rotation: Update the secret fields for a credential automatically for an external service.
  • Allowlist updates: Expand or restrict the set of hostnames the credential can be used against.
patch/v2/api-credentials/{apiCredentialId}

Request

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

Path parameters

apiCredentialIdstring required

Request body

namestring

New display name.

descriptionstring nullable

New description. Pass null to clear.

allowliststring[]

Replacement list of hostname glob patterns. Must not be empty; use ["*"] to allow every host.

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.