Databricks SDK for JavaScript
    Preparing search index...

    Interface ListSecretsRequest

    Request message for ListSecrets.

    interface ListSecretsRequest {
        catalogName?: string;
        includeBrowse?: boolean;
        pageSize?: number;
        pageToken?: string;
        schemaName?: string;
    }
    Index

    Properties

    catalogName? includeBrowse? pageSize? pageToken? schemaName?

    Properties

    catalogName?: string

    The name of the catalog under which to list secrets. Both catalog_name and schema_name must be specified together.

    includeBrowse?: boolean

    Whether to include secrets in the response for which you only have the BROWSE privilege, which limits access to metadata.

    pageSize?: number

    Maximum number of secrets to return.

    • If not specified, at most 10000 secrets are returned.
    • If set to a value greater than 0, the page length is the minimum of this value and 10000.
    • If set to 0, the page length is set to 10000.
    • If set to a value less than 0, an invalid parameter error is returned.
    pageToken?: string

    Opaque pagination token to go to the next page based on previous query. The maximum page length is determined by a server configured value.

    schemaName?: string

    The name of the schema under which to list secrets. Both catalog_name and schema_name must be specified together.

    Settings

    Member Visibility

    On This Page

    Properties