Skip to main content

Account Identity Visibility Filter

View as Markdown

An account-level rule that controls which groups from your identity provider (IdP) can be found in directory search and group pickers when automatic identity management is on. Filters apply to every workspace in the account.

If you have no group filters, all groups are visible. Otherwise, a group is visible if it or any of its parent groups matches at least one filter. A group is also visible if it or any of its parent groups is already in your account. Local Databricks groups are always visible.

You can only create group filters. Filters don't affect provisioning or sign-in for users and service principals. You can't change a filter: to change a rule, delete it and create a new one.

IdentityVisibilityFilter object​

An account-level rule that controls which groups from your identity provider (IdP) can be found in directory search and group pickers when automatic identity management is on. Filters apply to every workspace in the account.

If you have no group filters, all groups are visible. Otherwise, a group is visible if it or any of its parent groups matches at least one filter. A group is also visible if it or any of its parent groups is already in your account. Local Databricks groups are always visible.

You can only create group filters. Filters don't affect provisioning or sign-in for users and service principals. You can't change a filter: to change a rule, delete it and create a new one.

namestringOutput onlyIDImmutable

The resource name of the filter, in the format accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}.

principal_typestringImmutable

The type of principal the filter applies to. Set it to GROUP. Other types aren't supported.

Values:

  • USER
  • SERVICE_PRINCIPAL
  • GROUP
exactobjectImmutable

Matches a group by its ID in your IdP.

Show child attributesHide child attributes
external_idstringImmutable

The ID of the group in your IdP, not its Databricks ID. It's matched exactly, including case.

prefixobjectImmutable

Matches groups whose display name starts with a prefix.

Show child attributesHide child attributes
display_name_prefixstringImmutable

The prefix to match. It must contain at least one non-whitespace character. Leading and trailing spaces are kept.

regexobject

Matches groups whose display name matches a regular expression.

Show child attributesHide child attributes
display_name_regexstring

The RE2 regular expression to match against the whole display name. At most 255 characters.

Get an identity-visibility filter GA​

GET /api/2.0/identity/{name=accounts/*/identity-visibility-filters/*}

Gets a group visibility filter. It returns the rule, not the groups it matches.

API scopes: identity

Parameters​

namestringRequiredpath

The resource name of the filter, in the format accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}.

Response​

Returns the IdentityVisibilityFilter object.

List the identity-visibility filters in the account GA​

GET /api/2.0/identity/{parent=accounts/*}/identity-visibility-filters

Lists the group visibility filters in an account. It returns the rules, not the groups they match.

API scopes: identity

Parameters​

parentstringRequiredpath

The resource name of the account, in the format accounts/{account_id}.

page_sizeint32query

The maximum number of filters to return, up to 1000. The default is 100. A page can contain fewer filters.

page_tokenstringquery

The next_page_token from a previous response, to get the next page.

Response​

Returns a list of IdentityVisibilityFilter objects.

Create an identity-visibility filter in the account GA​

POST /api/2.0/identity/{parent=accounts/*}/identity-visibility-filters

Creates a group visibility filter. It applies to every workspace in the account.

Returns ALREADY_EXISTS if a filter with the same ID, or the same type and match value, already exists. Returns RESOURCE_EXHAUSTED if the account already has the maximum number of filters of that type. You can't change a filter: to change a rule, delete it and create a new one.

API scopes: identity

Parameters​

parentstringRequiredpath

The resource name of the account, in the format accounts/{account_id}.

identity_visibility_filter_idstringquery

The ID to give the filter, which becomes the last part of its resource name. If you leave it empty, Databricks generates one. It can't contain /.

Request body​

The filter to create. Set principal_type to GROUP and exactly one of exact, prefix, or regex. Databricks sets name, so any value you set is ignored.

principal_typestringRequiredImmutable

The type of principal the filter applies to. Set it to GROUP. Other types aren't supported.

Values:

  • USER
  • SERVICE_PRINCIPAL
  • GROUP
exactobjectImmutable

Matches a group by its ID in your IdP.

Show child attributesHide child attributes
external_idstringRequiredImmutable

The ID of the group in your IdP, not its Databricks ID. It's matched exactly, including case.

prefixobjectImmutable

Matches groups whose display name starts with a prefix.

Show child attributesHide child attributes
display_name_prefixstringRequiredImmutable

The prefix to match. It must contain at least one non-whitespace character. Leading and trailing spaces are kept.

regexobject

Matches groups whose display name matches a regular expression.

Show child attributesHide child attributes
display_name_regexstringRequired

The RE2 regular expression to match against the whole display name. At most 255 characters.

Response​

Returns the IdentityVisibilityFilter object.

Delete an identity-visibility filter GA​

DELETE /api/2.0/identity/{name=accounts/*/identity-visibility-filters/*}

Deletes a group visibility filter. Deleting a filter doesn't delete groups or remove access. Groups that only this filter matched stop being visible, unless they or a parent group are already in your account. If no group filters remain, all groups become visible again. Deleting a filter that doesn't exist succeeds.

API scopes: identity

Parameters​

namestringRequiredpath

The resource name of the filter, in the format accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}.