Sigma REST APICredentials

List API credentials

View as Markdown
List the API client credentials created for users in your Sigma organization. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - To read or update credentials for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token. - `clientSecret` is never included in the response. It is returned only once, at creation time, in the response to [POST /v2/credentials](https://help.sigmacomputing.com/reference/create-credentials). - `ownerId` identifies the user the credentials were created for and `createdBy` identifies the admin who created them. ### Usage scenarios - **Credential auditing:** Review which API credentials exist in your organization and who owns each one. - **Credential cleanup:** Look up a credential's `clientId` before revoking it with [DELETE /v2/credentials/{clientId}](https://help.sigmacomputing.com/reference/delete-credentials).

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

pageTokenstringOptional

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

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

Response

The response body.
entrieslist of objects
Array of results returned by the endpoint
nextPageTokenstringOptional

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.