SIsigmacomputing
API credentials

List API credentials

This endpoint returns a paginated list of API credentials. 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.
  • Only returns API credentials that the user making this request has at least Can view access to.
  • Secret fields such as passwords, tokens, and client secrets are never included in the response.
  • Use the name query parameter to filter by credential name.
  • Use the orderBy query parameter to set sort order.

Usage scenarios

  • Credential management: View and audit the credentials used by API connectors in your Sigma organization.
  • API connector creation: Retrieve available credentials to present as options when creating an API connector.
get/v2/api-credentials

Request

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

Query parameters

pageTokenstring

Use to specify the next set of results with the string returned in the nextPageToken field of the previous response.

pageSizeinteger

Number of results to return per page, with a maximum of 1000. Defaults to 50.

orderBystring

Sort order. Supported fields: name, description. Append desc for descending (e.g. name desc). Defaults to name ascending.

namestring

Filter results to credentials whose name contains this substring.

Response

The response body.

nextPageTokenstring

A string that can be passed to the pageToken parameter in the next request to fetch the next page of results. Not present in the last page of results. Must be treated as an opaque string.

Changes

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