recipient_federation_policies

Creates, updates, deletes, gets or lists a recipient_federation_policies resource.

Overview

Name	recipient_federation_policies
Type	Resource
Id	databricks_workspace.sharing.recipient_federation_policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Unique, immutable system-generated identifier for the federation policy.
name	string	Name of the federation policy. A recipient can have multiple policies with different names. The name must contain only lowercase alphanumeric characters, numbers, and hyphens.
comment	string
create_time	string	System-generated timestamp indicating when the policy was created.
▶oidc_policy	object	Specifies the policy to use for validating OIDC claims in the federated tokens.
update_time	string	System-generated timestamp indicating when the policy was last updated.

list

Name	Datatype	Description
id	string	Unique, immutable system-generated identifier for the federation policy.
name	string	Name of the federation policy. A recipient can have multiple policies with different names. The name must contain only lowercase alphanumeric characters, numbers, and hyphens.
comment	string
create_time	string	System-generated timestamp indicating when the policy was created.
▶oidc_policy	object	Specifies the policy to use for validating OIDC claims in the federated tokens.
update_time	string	System-generated timestamp indicating when the policy was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	recipient_name, name, deployment_name		Reads an existing federation policy for an OIDC_FEDERATION recipient for sharing data from Databricks
list	select	recipient_name, deployment_name	max_results, page_token	Lists federation policies for an OIDC_FEDERATION recipient for sharing data from Databricks to
create	insert	recipient_name, deployment_name, policy		Create a federation policy for an OIDC_FEDERATION recipient for sharing data from Databricks to
recipient_federation_policies_update	update	recipient_name, name, deployment_name, policy	update_mask	Updates an existing federation policy for an OIDC_RECIPIENT. The caller must be the owner of the
delete	delete	recipient_name, name, deployment_name		Deletes an existing federation policy for an OIDC_FEDERATION recipient. The caller must be the owner

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
name	string	Name of the policy. This is the name of the policy to be deleted.
recipient_name	string	Name of the recipient. This is the name of the recipient for which the policy is being deleted.
max_results	integer
page_token	string
update_mask	string	The field mask specifies which fields of the policy to update. To specify multiple fields in the field mask, use comma as the separator (no space). The special value '*' indicates that all fields should be updated (full replacement). If unspecified, all fields that are set in the policy provided in the update request will overwrite the corresponding fields in the existing policy. Example value: 'comment,oidc_policy.audiences'.

SELECT examples

get

Reads an existing federation policy for an OIDC_FEDERATION recipient for sharing data from Databricks

SELECT
id,
name,
comment,
create_time,
oidc_policy,
update_time
FROM databricks_workspace.sharing.recipient_federation_policies
WHERE recipient_name = '{{ recipient_name }}' -- required
AND name = '{{ name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

Lists federation policies for an OIDC_FEDERATION recipient for sharing data from Databricks to

SELECT
id,
name,
comment,
create_time,
oidc_policy,
update_time
FROM databricks_workspace.sharing.recipient_federation_policies
WHERE recipient_name = '{{ recipient_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND max_results = '{{ max_results }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Create a federation policy for an OIDC_FEDERATION recipient for sharing data from Databricks to

INSERT INTO databricks_workspace.sharing.recipient_federation_policies (
policy,
recipient_name,
deployment_name
)
SELECT 
'{{ policy }}' /* required */,
'{{ recipient_name }}',
'{{ deployment_name }}'
RETURNING
id,
name,
comment,
create_time,
oidc_policy,
update_time
;

Manifest

# Description fields are for documentation purposes
- name: recipient_federation_policies
props:
  - name: recipient_name
    value: "{{ recipient_name }}"
    description: Required parameter for the recipient_federation_policies resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the recipient_federation_policies resource.
  - name: policy
    description: |
      Name of the policy. This is the name of the policy to be created.
    value:
      comment: "{{ comment }}"
      create_time: "{{ create_time }}"
      id: "{{ id }}"
      name: "{{ name }}"
      oidc_policy:
        issuer: "{{ issuer }}"
        subject_claim: "{{ subject_claim }}"
        subject: "{{ subject }}"
        audiences:
          - "{{ audiences }}"
      update_time: "{{ update_time }}"

UPDATE examples

recipient_federation_policies_update

Updates an existing federation policy for an OIDC_RECIPIENT. The caller must be the owner of the

UPDATE databricks_workspace.sharing.recipient_federation_policies
SET 
policy = '{{ policy }}'
WHERE 
recipient_name = '{{ recipient_name }}' --required
AND name = '{{ name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND policy = '{{ policy }}' --required
AND update_mask = '{{ update_mask}}'
RETURNING
id,
name,
comment,
create_time,
oidc_policy,
update_time;

DELETE examples

delete

Deletes an existing federation policy for an OIDC_FEDERATION recipient. The caller must be the owner

DELETE FROM databricks_workspace.sharing.recipient_federation_policies
WHERE recipient_name = '{{ recipient_name }}' --required
AND name = '{{ name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;