Databricks SDK for JavaScript
    Preparing search index...

    Interface FederationPolicy

    interface FederationPolicy {
        createTime?: Instant;
        description?: string;
        name?: string;
        policy?: { $case: "oidcPolicy"; oidcPolicy: OidcFederationPolicy };
        policyId?: string;
        servicePrincipalId?: bigint;
        uid?: string;
        updateTime?: Instant;
    }
    Index

    Properties

    createTime? description? name? policy? policyId? servicePrincipalId? uid? updateTime?

    Properties

    createTime?: Instant

    Creation time of the federation policy.

    description?: string

    Description of the federation policy.

    name?: string

    Resource name for the federation policy. Example values include accounts/<account-id>/federationPolicies/my-federation-policy for Account Federation Policies, and accounts/<account-id>/servicePrincipals/<service-principal-id>/federationPolicies/my-federation-policy for Service Principal Federation Policies. Typically an output parameter, which does not need to be specified in create or update requests. If specified in a request, must match the value in the request URL.

    policy?: { $case: "oidcPolicy"; oidcPolicy: OidcFederationPolicy }

    Type Declaration

    • $case: "oidcPolicy"
    • oidcPolicy: OidcFederationPolicy

      audit_mode INCLUDE is required on both this message field and its leaf fields so the OIDC policy configuration is captured in create/update audit logs (see go/auditlogs).

    policyId?: string

    The ID of the federation policy. Output only.

    servicePrincipalId?: bigint

    The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies.

    uid?: string

    Unique, immutable id of the federation policy.

    updateTime?: Instant

    Last update time of the federation policy.

    Settings

    Member Visibility

    On This Page

    Properties