Skip to content

AccountFederationPolicy

laktory.models.resources.databricks.AccountFederationPolicy ¤

Bases: AccountFederationPolicyBase

Databricks Account Federation Policy

Examples:

import io

from laktory import models

policy_yaml = '''
policy_id: my-policy
oidc_policy:
  issuer: https://myidp.example.com
  audiences:
  - api://AzureADTokenExchange
'''
policy = models.resources.databricks.AccountFederationPolicy.model_validate_yaml(
    io.StringIO(policy_yaml)
)
References
BASE DESCRIPTION
description

Description of the federation policy

TYPE: str | None | VariableType DEFAULT: None

oidc_policy

TYPE: AccountFederationPolicyOidcPolicy | None | VariableType DEFAULT: None

policy_id

The ID of the federation policy. Output only

TYPE: str | None | VariableType DEFAULT: None

service_principal_id

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

TYPE: int | None | VariableType DEFAULT: None


laktory.models.resources.databricks.accountfederationpolicy.AccountFederationPolicyOidcPolicy ¤

Bases: BaseModel

PARAMETER DESCRIPTION
audiences

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 Databricks account id

TYPE: list[str] | None | VariableType DEFAULT: None

issuer

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

TYPE: str | None | VariableType DEFAULT: None

jwks_json

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), Databricks 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

TYPE: str | None | VariableType DEFAULT: None

jwks_uri

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), Databricks 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

TYPE: str | None | VariableType DEFAULT: None

subject

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

TYPE: str | None | VariableType DEFAULT: None

subject_claim

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

TYPE: str | None | VariableType DEFAULT: None