Databricks SDK for JavaScript
    Preparing search index...

    Interface GenerateDatabaseCredentialRequest

    interface GenerateDatabaseCredentialRequest {
        claims?: RequestedClaims[];
        endpoint?: string;
        expiration?:
            | { $case: "ttl"; ttl: Duration }
            | { $case: "expireTime"; expireTime: Instant };
        groupName?: string;
    }
    Index

    Properties

    claims? endpoint? expiration? groupName?

    Properties

    claims?: RequestedClaims[]

    The returned token will be scoped to UC tables with the specified permissions.

    endpoint?: string

    The endpoint resource name for which this credential will be generated. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

    expiration?:
        | { $case: "ttl"; ttl: Duration }
        | { $case: "expireTime"; expireTime: Instant }

    Expiration information for the credential. Users can specify either expire_time or ttl. If unspecified, maximum allowed duration (1 hour) is used.

    Type Declaration

    • { $case: "ttl"; ttl: Duration }
      • $case: "ttl"
      • ttl: Duration

        The requested time-to-live for the generated credential token. Must be at least 300 seconds (5 minutes) and at most 3600 seconds (1 hour).

    • { $case: "expireTime"; expireTime: Instant }
      • $case: "expireTime"
      • expireTime: Instant

        Timestamp in UTC of when this credential should expire. Must be at least 300 seconds (5 minutes) and at most 1 hour from the current time.

    groupName?: string

    The display name of a <Databricks> workspace group. When set, the returned credential is scoped to this group, so the caller connects directly as the group's Postgres role. The caller must be a member of the group. When omitted, the credential is scoped to the caller's own identity.

    Settings

    Member Visibility

    On This Page

    Properties