identity_visibility_filters

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

Overview

Name	identity_visibility_filters
Type	Resource
Id	databricks_account.iamv2.identity_visibility_filters

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	The resource name of the identity-visibility filter. Format: accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}
▶exact	object	Exact match on the group's external ID from the identity provider.
▶prefix	object	Case-sensitive starts-with match on the group's display name.
principal_type	string	The type of principal this rule applies to. Set to ``GROUP`` when creating a filter. Other principal types are not supported for creation. (GROUP, SERVICE_PRINCIPAL, USER)
▶regex	object	Full, case-sensitive RE2 match on the identity's display name.

list

Name	Datatype	Description
name	string	The resource name of the identity-visibility filter. Format: accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}
▶exact	object	Exact match on the group's external ID from the identity provider.
▶prefix	object	Case-sensitive starts-with match on the group's display name.
principal_type	string	The type of principal this rule applies to. Set to ``GROUP`` when creating a filter. Other principal types are not supported for creation. (GROUP, SERVICE_PRINCIPAL, USER)
▶regex	object	Full, case-sensitive RE2 match on the identity's display name.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, identity_visibility_filter_id, account_host		Gets a group visibility filter by its resource name. Requires account admin privileges. Returns the
list	select	account_id, account_host	page_size, page_token	Lists group visibility filters in the account, returning one page per call. Requires account admin
create	insert	account_id, account_host, principal_type	identity_visibility_filter_id	Creates a group visibility filter in the account. Requires account admin privileges. Set
delete	delete	account_id, identity_visibility_filter_id, account_host		Deletes a group visibility filter by its resource name. Requires account admin privileges. Deleting a

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
account_host	string	The Databricks account console host. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws), or set explicitly with DATABRICKS_ACCOUNT_HOST (bare host, no scheme). (default: accounts.cloud.databricks.com, x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST, x-stackQL-envVarSelector: {"envVar":"DATABRICKS_CLOUD","default":"aws","values":{"aws":"accounts.cloud.databricks.com","azure":"accounts.azuredatabricks.net","gcp":"accounts.gcp.databricks.com"}})
account_id	string	The account_id segment of the name resource name (accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}). Required. The resource name of the filter. Format: accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}
identity_visibility_filter_id	string	The identity_visibility_filter_id segment of the name resource name (accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}). Required. The resource name of the filter. Format: accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}
identity_visibility_filter_id	string	Optional. The ID to use for the filter, which becomes the final component of its resource name. If not specified or empty, the server generates one. Must not contain /.
page_size	integer	The maximum number of filters to return. The service may return fewer than this value. If omitted or non-positive, defaults to 100. Values above 1000 are reduced to 1000.
page_token	string	A page token, received from a previous ListIdentityVisibilityFilters call. Provide this to retrieve the subsequent page.

SELECT examples

get

Gets a group visibility filter by its resource name. Requires account admin privileges. Returns the

SELECT
name,
exact,
prefix,
principal_type,
regex
FROM databricks_account.iamv2.identity_visibility_filters
WHERE account_id = '{{ account_id }}' -- required
AND identity_visibility_filter_id = '{{ identity_visibility_filter_id }}' -- required
AND account_host = '{{ account_host }}' -- required
;

list

Lists group visibility filters in the account, returning one page per call. Requires account admin

SELECT
name,
exact,
prefix,
principal_type,
regex
FROM databricks_account.iamv2.identity_visibility_filters
WHERE account_id = '{{ account_id }}' -- required
AND account_host = '{{ account_host }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates a group visibility filter in the account. Requires account admin privileges. Set

INSERT INTO databricks_account.iamv2.identity_visibility_filters (
principal_type,
exact,
name,
prefix,
regex,
account_id,
account_host,
identity_visibility_filter_id
)
SELECT 
'{{ principal_type }}' /* required */,
'{{ exact }}',
'{{ name }}',
'{{ prefix }}',
'{{ regex }}',
'{{ account_id }}',
'{{ account_host }}',
'{{ identity_visibility_filter_id }}'
RETURNING
name,
exact,
prefix,
principal_type,
regex
;

Manifest

# Description fields are for documentation purposes
- name: identity_visibility_filters
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the identity_visibility_filters resource.
  - name: account_host
    value: "{{ account_host }}"
    description: Required parameter for the identity_visibility_filters resource.
  - name: principal_type
    value: "{{ principal_type }}"
    description: |
      The type of principal this rule applies to. Set to ``GROUP`` when creating a filter. Other principal types are not supported for creation.
  - name: exact
    description: |
      Exact match on the group's external ID from the identity provider.
    value:
      external_id: "{{ external_id }}"
  - name: name
    value: "{{ name }}"
    description: |
      The resource name of the identity-visibility filter. Format: accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}
  - name: prefix
    description: |
      Case-sensitive starts-with match on the group's display name.
    value:
      display_name_prefix: "{{ display_name_prefix }}"
  - name: regex
    description: |
      Full, case-sensitive RE2 match on the identity's display name.
    value:
      display_name_regex: "{{ display_name_regex }}"
  - name: identity_visibility_filter_id
    value: "{{ identity_visibility_filter_id }}"
    description: Optional. The ID to use for the filter, which becomes the final component of its resource name. If not specified or empty, the server generates one. Must not contain ``/``.
    description: Optional. The ID to use for the filter, which becomes the final component of its resource name. If not specified or empty, the server generates one. Must not contain ``/``.

DELETE examples

delete

Deletes a group visibility filter by its resource name. Requires account admin privileges. Deleting a

DELETE FROM databricks_account.iamv2.identity_visibility_filters
WHERE account_id = '{{ account_id }}' --required
AND identity_visibility_filter_id = '{{ identity_visibility_filter_id }}' --required
AND account_host = '{{ account_host }}' --required
;