Credentials

List credentials

Changed on

Gets an array of credentials (as CredentialInfo objects). The array is limited to only those credentials the caller has permission to access. If the caller is a metastore admin, retrieval of credentials is unrestricted. There is no guarantee of a specific ordering of the elements in the array.

get/credentials

Request

  • Base URL
    http://localhost:8080/api/2.1/unity-catalog
  • Auth
    none declared

Query parameters

max_resultsinteger

Maximum number of credentials to return.

  • If not set, the default max page size is used.
  • When set to a value greater than 0, the page length is the minimum of this value and a server-configured value.
  • When set to 0, the page length is set to a server-configured value (recommended).
  • When set to a value less than 0, an invalid parameter error is returned.
page_tokenstring

Opaque pagination token to go to next page based on previous query.

purpose'STORAGE'

Return only credentials for the specified purpose.

Response

The credentials list was successfully retrieved.

next_page_tokenstring

Opaque token to retrieve the next page of results. Absent if there are no more pages. page_token should be set to this value for the next request (for the next page of results).

Changes