Databricks SDK for JavaScript
    Preparing search index...

    Specifies the policy to use for validating OIDC claims in your federated tokens.

    interface OidcFederationPolicy {
        audiences?: string[];
        issuer?: string;
        jwksJson?: string;
        jwksUri?: string;
        subject?: string;
        subjectClaim?: string;
    }
    Index

    Properties

    audiences?: string[]

    The allowed token audiences, as specified in the 'aud' claim of federated tokens. The audience identifier is intended to represent the recipient of the token. Can be any non-empty string value. As long as the audience in the token matches at least one audience in the policy, the token is considered a match. If audiences is unspecified, defaults to your account id.

    issuer?: string

    The required token issuer, as specified in the 'iss' claim of federated tokens.

    jwksJson?: string

    The public keys used to validate the signature of federated tokens, in JWKS format. Most use cases should not need to specify this field. If jwks_uri and jwks_json are both unspecified (recommended), automatically fetches the public keys from your issuer’s well known endpoint. Databricks strongly recommends relying on your issuer’s well known endpoint for discovering public keys.

    jwksUri?: string

    URL of the public keys used to validate the signature of federated tokens, in JWKS format. Most use cases should not need to specify this field. If jwks_uri and jwks_json are both unspecified (recommended), automatically fetches the public keys from your issuer’s well known endpoint. Databricks strongly recommends relying on your issuer’s well known endpoint for discovering public keys.

    subject?: string

    The required token subject, as specified in the subject claim of federated tokens. Must be specified for service principal federation policies. Must not be specified for account federation policies.

    subjectClaim?: string

    The claim that contains the subject of the token. If unspecified, the default value is 'sub'.