Databricks SDK for JavaScript
    Preparing search index...

    Interface Secret

    A secret stored in Unity Catalog. Secrets are three-level namespace objects (catalog.schema.secret) that securely store sensitive credential data such as passwords, tokens, and keys.

    interface Secret {
        browseOnly?: boolean;
        catalogName?: string;
        comment?: string;
        createdBy?: string;
        createTime?: Instant;
        effectiveOwner?: string;
        effectiveValue?: string;
        expireTime?: Instant;
        externalSecretId?: string;
        fullName?: string;
        metastoreId?: string;
        name?: string;
        owner?: string;
        schemaName?: string;
        updatedBy?: string;
        updateTime?: Instant;
        value?: string;
    }
    Index

    Properties

    browseOnly? catalogName? comment? createdBy? createTime? effectiveOwner? effectiveValue? expireTime? externalSecretId? fullName? metastoreId? name? owner? schemaName? updatedBy? updateTime? value?

    Properties

    browseOnly?: boolean

    Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

    catalogName?: string

    The name of the catalog where the schema and the secret reside.

    comment?: string

    User-provided free-form text description of the secret.

    createdBy?: string

    The principal that created the secret.

    createTime?: Instant

    The time at which this secret was created.

    effectiveOwner?: string

    The effective owner of the secret, which may differ from the directly-set owner due to inheritance.

    effectiveValue?: string

    The secret value. Only populated in responses when you have the READ_SECRET privilege and include_value is set to true in the request. The maximum size is 60 KiB.

    expireTime?: Instant

    User-provided expiration time of the secret. This field indicates when the secret should no longer be used and may be displayed as a warning in the UI. It is purely informational and does not trigger any automatic actions or affect the secret's lifecycle.

    externalSecretId?: string
    fullName?: string

    The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name.

    metastoreId?: string

    Unique identifier of the metastore hosting the secret.

    name?: string

    The name of the secret, relative to its parent schema.

    owner?: string

    The owner of the secret. Defaults to the creating principal on creation. Can be updated to transfer ownership of the secret to another principal.

    schemaName?: string

    The name of the schema where the secret resides.

    updatedBy?: string

    The principal that last updated the secret.

    updateTime?: Instant

    The time at which this secret was last updated.

    value?: string

    The secret value to store. This field is input-only and is not returned in responses — use the effective_value field (via GetSecret with include_value set to true) to read the secret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes passwords, tokens, keys, and other sensitive credential data.

    Settings

    Member Visibility

    On This Page

    Properties