attribute_control_entries

Creates, updates, deletes, gets or lists an attribute_control_entries resource.

Overview

Name	attribute_control_entries
Type	Resource
Id	databricks_account.iamv2.attribute_control_entries

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
name	string	The resource name of the entry. Format: accounts/{account_id}/attribute-control-entries/{attribute_name} where {attribute_name} is the IdP attribute being governed (e.g. "department").
is_allowed	boolean	Whether the attribute is permitted. Always true in the Identity Attributes PrPr.

get

Name	Datatype	Description
name	string	The resource name of the entry. Format: accounts/{account_id}/attribute-control-entries/{attribute_name} where {attribute_name} is the IdP attribute being governed (e.g. "department").
is_allowed	boolean	Whether the attribute is permitted. Always true in the Identity Attributes PrPr.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	parent	page_size, page_token	Lists the identity attribute control-list entries for an account.
get	select	name		Gets an identity attribute control-list entry.
create	insert	parent, attribute_control_entry	attribute_control_entry_id	Creates (allows) an identity attribute control-list entry for an account.
update	update	name, update_mask, attribute_control_entry		Updates an identity attribute control-list entry for an account.
delete	delete	name		Deletes an identity attribute control-list entry.

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
name	string	Required. The resource name of the entry to delete. Format: accounts/{account_id}/attribute-control-entries/{attribute_name}
parent	string	Required. The account under which to create the entry. Format: accounts/{account_id}
update_mask	object	Required. The fields to update. For the PrPr only is_allowed is mutable, so the backend currently applies the full entry regardless of the mask.
attribute_control_entry_id	string	Optional. The ID to use for the entry, which becomes the last segment of its resource name: the IdP attribute being governed (e.g. "department").
page_size	integer	Optional. The maximum number of entries to return.
page_token	string	Optional. A page token from a previous call, to retrieve the next page.

SELECT examples

list

Lists the identity attribute control-list entries for an account.

SELECT
name,
is_allowed
FROM databricks_account.iamv2.attribute_control_entries
WHERE parent = '{{ parent }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

get

Gets an identity attribute control-list entry.

SELECT
name,
is_allowed
FROM databricks_account.iamv2.attribute_control_entries
WHERE name = '{{ name }}' -- required
;

INSERT examples

create

Creates (allows) an identity attribute control-list entry for an account.

INSERT INTO databricks_account.iamv2.attribute_control_entries (
attribute_control_entry,
parent,
attribute_control_entry_id
)
SELECT 
'{{ attribute_control_entry }}' /* required */,
'{{ parent }}',
'{{ attribute_control_entry_id }}'
RETURNING
name,
is_allowed
;

Manifest

# Description fields are for documentation purposes
- name: attribute_control_entries
props:
  - name: parent
    value: "{{ parent }}"
    description: Required parameter for the attribute_control_entries resource.
  - name: attribute_control_entry
    description: |
      Required. The entry to create.
    value:
      is_allowed: {{ is_allowed }}
      name: "{{ name }}"
  - name: attribute_control_entry_id
    value: "{{ attribute_control_entry_id }}"
    description: Optional. The ID to use for the entry, which becomes the last segment of its resource name: the IdP attribute being governed (e.g. "department").
    description: Optional. The ID to use for the entry, which becomes the last segment of its resource name: the IdP attribute being governed (e.g. "department").

UPDATE examples

update

Updates an identity attribute control-list entry for an account.

UPDATE databricks_account.iamv2.attribute_control_entries
SET 
attribute_control_entry = '{{ attribute_control_entry }}'
WHERE 
name = '{{ name }}' --required
AND update_mask = '{{ update_mask }}' --required
AND attribute_control_entry = '{{ attribute_control_entry }}' --required
RETURNING
name,
is_allowed;

DELETE examples

delete

Deletes an identity attribute control-list entry.

DELETE FROM databricks_account.iamv2.attribute_control_entries
WHERE name = '{{ name }}' --required
;