Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks Provider
  3. API Docs
  4. getServicePrincipalFederationPolicy
Databricks v1.75.0 published on Thursday, Sep 11, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.getServicePrincipalFederationPolicy

Explore with Pulumi AI

databricks logo
Databricks v1.75.0 published on Thursday, Sep 11, 2025 by Pulumi
pulumi/pulumi-databricks

    This data source can be used to get a single service principal federation policy.

    Note This data source can only be used with an account-level provider!

    Example Usage

    Referring to a service principal federation policy by id:

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    variables:
  myPolicy:
    fn::invoke:
      function: databricks:getServicePrincipalFederationPolicy
      arguments:
        servicePrincipalId: 1234
        policyId: my-policy
        oidcPolicy:
          issuer: https://myidp.example.com
          subject_claim: sub
          subject: subject-in-token-from-myidp

    Using getServicePrincipalFederationPolicy

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getServicePrincipalFederationPolicy(args: GetServicePrincipalFederationPolicyArgs, opts?: InvokeOptions): Promise<GetServicePrincipalFederationPolicyResult>
function getServicePrincipalFederationPolicyOutput(args: GetServicePrincipalFederationPolicyOutputArgs, opts?: InvokeOptions): Output<GetServicePrincipalFederationPolicyResult>
    def get_service_principal_federation_policy(description: Optional[str] = None,
                                            oidc_policy: Optional[GetServicePrincipalFederationPolicyOidcPolicy] = None,
                                            policy_id: Optional[str] = None,
                                            service_principal_id: Optional[int] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetServicePrincipalFederationPolicyResult
def get_service_principal_federation_policy_output(description: Optional[pulumi.Input[str]] = None,
                                            oidc_policy: Optional[pulumi.Input[GetServicePrincipalFederationPolicyOidcPolicyArgs]] = None,
                                            policy_id: Optional[pulumi.Input[str]] = None,
                                            service_principal_id: Optional[pulumi.Input[int]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetServicePrincipalFederationPolicyResult]
    func LookupServicePrincipalFederationPolicy(ctx *Context, args *LookupServicePrincipalFederationPolicyArgs, opts ...InvokeOption) (*LookupServicePrincipalFederationPolicyResult, error)
func LookupServicePrincipalFederationPolicyOutput(ctx *Context, args *LookupServicePrincipalFederationPolicyOutputArgs, opts ...InvokeOption) LookupServicePrincipalFederationPolicyResultOutput

    > Note: This function is named LookupServicePrincipalFederationPolicy in the Go SDK.

    public static class GetServicePrincipalFederationPolicy 
{
    public static Task<GetServicePrincipalFederationPolicyResult> InvokeAsync(GetServicePrincipalFederationPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetServicePrincipalFederationPolicyResult> Invoke(GetServicePrincipalFederationPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServicePrincipalFederationPolicyResult> getServicePrincipalFederationPolicy(GetServicePrincipalFederationPolicyArgs args, InvokeOptions options)
public static Output<GetServicePrincipalFederationPolicyResult> getServicePrincipalFederationPolicy(GetServicePrincipalFederationPolicyArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getServicePrincipalFederationPolicy:getServicePrincipalFederationPolicy
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Description string
    (string) - Description of the federation policy
    OidcPolicy GetServicePrincipalFederationPolicyOidcPolicy
    (OidcFederationPolicy)
    PolicyId string
    The ID of the federation policy
    ServicePrincipalId int
    The service principal ID that this federation policy applies to. Only set for service principal federation policies
    Description string
    (string) - Description of the federation policy
    OidcPolicy GetServicePrincipalFederationPolicyOidcPolicy
    (OidcFederationPolicy)
    PolicyId string
    The ID of the federation policy
    ServicePrincipalId int
    The service principal ID that this federation policy applies to. Only set for service principal federation policies
    description String
    (string) - Description of the federation policy
    oidcPolicy GetServicePrincipalFederationPolicyOidcPolicy
    (OidcFederationPolicy)
    policyId String
    The ID of the federation policy
    servicePrincipalId Integer
    The service principal ID that this federation policy applies to. Only set for service principal federation policies
    description string
    (string) - Description of the federation policy
    oidcPolicy GetServicePrincipalFederationPolicyOidcPolicy
    (OidcFederationPolicy)
    policyId string
    The ID of the federation policy
    servicePrincipalId number
    The service principal ID that this federation policy applies to. Only set for service principal federation policies
    description str
    (string) - Description of the federation policy
    oidc_policy GetServicePrincipalFederationPolicyOidcPolicy
    (OidcFederationPolicy)
    policy_id str
    The ID of the federation policy
    service_principal_id int
    The service principal ID that this federation policy applies to. Only set for service principal federation policies
    description String
    (string) - Description of the federation policy
    oidcPolicy Property Map
    (OidcFederationPolicy)
    policyId String
    The ID of the federation policy
    servicePrincipalId Number
    The service principal ID that this federation policy applies to. Only set for service principal federation policies

    getServicePrincipalFederationPolicy Result

    The following output properties are available:

    CreateTime string
    (string) - Creation time of the federation policy
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (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
    PolicyId string
    (string) - The ID of the federation policy
    ServicePrincipalId int
    (integer) - The service principal ID that this federation policy applies to. Only set for service principal federation policies
    Uid string
    (string) - Unique, immutable id of the federation policy
    UpdateTime string
    (string) - Last update time of the federation policy
    Description string
    (string) - Description of the federation policy
    OidcPolicy GetServicePrincipalFederationPolicyOidcPolicy
    (OidcFederationPolicy)
    CreateTime string
    (string) - Creation time of the federation policy
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (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
    PolicyId string
    (string) - The ID of the federation policy
    ServicePrincipalId int
    (integer) - The service principal ID that this federation policy applies to. Only set for service principal federation policies
    Uid string
    (string) - Unique, immutable id of the federation policy
    UpdateTime string
    (string) - Last update time of the federation policy
    Description string
    (string) - Description of the federation policy
    OidcPolicy GetServicePrincipalFederationPolicyOidcPolicy
    (OidcFederationPolicy)
    createTime String
    (string) - Creation time of the federation policy
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (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
    policyId String
    (string) - The ID of the federation policy
    servicePrincipalId Integer
    (integer) - The service principal ID that this federation policy applies to. Only set for service principal federation policies
    uid String
    (string) - Unique, immutable id of the federation policy
    updateTime String
    (string) - Last update time of the federation policy
    description String
    (string) - Description of the federation policy
    oidcPolicy GetServicePrincipalFederationPolicyOidcPolicy
    (OidcFederationPolicy)
    createTime string
    (string) - Creation time of the federation policy
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (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
    policyId string
    (string) - The ID of the federation policy
    servicePrincipalId number
    (integer) - The service principal ID that this federation policy applies to. Only set for service principal federation policies
    uid string
    (string) - Unique, immutable id of the federation policy
    updateTime string
    (string) - Last update time of the federation policy
    description string
    (string) - Description of the federation policy
    oidcPolicy GetServicePrincipalFederationPolicyOidcPolicy
    (OidcFederationPolicy)
    create_time str
    (string) - Creation time of the federation policy
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (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_id str
    (string) - The ID of the federation policy
    service_principal_id int
    (integer) - The service principal ID that this federation policy applies to. Only set for service principal federation policies
    uid str
    (string) - Unique, immutable id of the federation policy
    update_time str
    (string) - Last update time of the federation policy
    description str
    (string) - Description of the federation policy
    oidc_policy GetServicePrincipalFederationPolicyOidcPolicy
    (OidcFederationPolicy)
    createTime String
    (string) - Creation time of the federation policy
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (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
    policyId String
    (string) - The ID of the federation policy
    servicePrincipalId Number
    (integer) - The service principal ID that this federation policy applies to. Only set for service principal federation policies
    uid String
    (string) - Unique, immutable id of the federation policy
    updateTime String
    (string) - Last update time of the federation policy
    description String
    (string) - Description of the federation policy
    oidcPolicy Property Map
    (OidcFederationPolicy)

    Supporting Types

    GetServicePrincipalFederationPolicyOidcPolicy

    Audiences List<string>
    (list of 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 Databricks account id
    Issuer string
    (string) - The required token issuer, as specified in the 'iss' claim of federated tokens
    JwksJson string
    (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), 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
    JwksUri string
    (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), 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
    Subject string
    (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
    (string) - The claim that contains the subject of the token. If unspecified, the default value is 'sub'
    Audiences []string
    (list of 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 Databricks account id
    Issuer string
    (string) - The required token issuer, as specified in the 'iss' claim of federated tokens
    JwksJson string
    (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), 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
    JwksUri string
    (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), 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
    Subject string
    (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
    (string) - The claim that contains the subject of the token. If unspecified, the default value is 'sub'
    audiences List<String>
    (list of 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 Databricks account id
    issuer String
    (string) - The required token issuer, as specified in the 'iss' claim of federated tokens
    jwksJson String
    (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), 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
    jwksUri String
    (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), 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
    subject String
    (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
    (string) - The claim that contains the subject of the token. If unspecified, the default value is 'sub'
    audiences string[]
    (list of 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 Databricks account id
    issuer string
    (string) - The required token issuer, as specified in the 'iss' claim of federated tokens
    jwksJson string
    (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), 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
    jwksUri string
    (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), 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
    subject string
    (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
    (string) - The claim that contains the subject of the token. If unspecified, the default value is 'sub'
    audiences Sequence[str]
    (list of 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 Databricks account id
    issuer str
    (string) - The required token issuer, as specified in the 'iss' claim of federated tokens
    jwks_json str
    (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), 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
    jwks_uri str
    (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), 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
    subject str
    (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
    subject_claim str
    (string) - The claim that contains the subject of the token. If unspecified, the default value is 'sub'
    audiences List<String>
    (list of 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 Databricks account id
    issuer String
    (string) - The required token issuer, as specified in the 'iss' claim of federated tokens
    jwksJson String
    (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), 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
    jwksUri String
    (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), 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
    subject String
    (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
    (string) - The claim that contains the subject of the token. If unspecified, the default value is 'sub'

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.75.0 published on Thursday, Sep 11, 2025 by Pulumi
    pulumi/pulumi-databricks