Databricks SDK for JavaScript
    Preparing search index...

    Interface ListCredentialsRequest

    ListCredentialsRequest is used to list credentials in the metastore. Returns an array of credentials (as CredentialInfo objects). The array is limited to the credentials that 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.

    interface ListCredentialsRequest {
        includeUnbound?: boolean;
        maxResults?: number;
        pageToken?: string;
    }
    Index

    Properties

    includeUnbound? maxResults? pageToken?

    Properties

    includeUnbound?: boolean

    Whether to include credentials not bound to the workspace. Effective only if the user has permission to update the credential–workspace binding.

    maxResults?: number

    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.
    pageToken?: string

    Opaque token to retrieve the next page of results.

    Settings

    Member Visibility

    On This Page

    Properties