user_identity_attribute_values Função

Aplica-se a:marcado sim Databricks SQL marcado sim Databricks Runtime 19 e superior

Importante

Esta função lê atributos de identidade, que estão em Beta. Antes de poder usá-la, um administrador de conta deve habilitar a prévia da Lista de Controle de Atributos de Identidade na página de Visualizações do console da conta e provisionar atributos de identidade para seus usuários. Veja Atributos de Identidade.

Retorna os valores de um atributo de identidade do usuário da sessão.

Use esta função nos UDFs de filtro de linha para filtrar linhas com base em atributos do usuário que faz a consulta, como seu departamento ou país. Para aplicar o filtro entre tabelas, faça referência ao UDF em uma política de filtro de linha ABAC.

Sintaxe

user_identity_attribute_values(principal, attributeName)

Arguments

  • principal: Uma expressão constante STRING . O único valor com suporte é session_user().
  • attributeName: Uma expressão que nomeia STRING um atributo de identidade. O nome não precisa ser uma constante, então pode ser uma coluna ou um parâmetro SQL UDF. Os nomes diferenciam maiúsculas de minúsculas. Para os atributos disponíveis, veja Atributos de identidade.

Returns

Um não anulável ARRAY<STRING>.

Se o usuário não tiver valor para attributeName, a função retorna um array vazio.

Condições de erro

  • Se principal não for o usuário da sessão, o Azure Databricks levanta UNSUPPORTED_FEATURE.IDENTITY_ATTRIBUTES_NON_SESSION_USER.
  • Se principal não for uma constante, Azure Databricks eleva NON_FOLDABLE_ARGUMENT.
  • Se attributeName for NULL ou não nomear um atributo de identidade existente, o Azure Databricks levanta IDENTITY_ATTRIBUTE_NOT_FOUND. Isso inclui nomes que diferem apenas em maiúsculas e minúsculas, como 'Department'.

Notes

  • A função retorna os atributos do usuário que executa a consulta. Dentro de uma view ou de um UDF SQL, ele retorna os atributos do usuário que consulta a view ou que chama a UDF, não do proprietário.
  • Se você usar a função em um UDF de filtro de linha, escreva a condição de filtro para que um array vazio negue o acesso. Por exemplo, array_contains(..., 'HR') oculta linhas de usuários sem department valor, negando o acesso por padrão. NOT array_contains(..., 'contractor') Mostra linhas para usuários sem userType valor, portanto concede acesso por padrão.
  • Use funções de array como array_contains ou arrays_overlap para testar o resultado, em vez de assumir que o array tem exatamente um elemento.
  • Você não pode usar a função em uma visualização compartilhada via OpenSharing.
  • Para verificar quais valores de atributo a função retorna para você, chame-a diretamente em uma consulta, por SELECT user_identity_attribute_values(session_user(), 'department')exemplo.

Exemplos

> SELECT user_identity_attribute_values(session_user(), 'department');
 ["Finance"]

-- The user has no value for the attribute
> SELECT user_identity_attribute_values(session_user(), 'costCenter');
 []

-- Attribute names are case-sensitive
> SELECT user_identity_attribute_values(session_user(), 'Department');
 Error: IDENTITY_ATTRIBUTE_NOT_FOUND

-- The function only works for the session user's attributes
> SELECT user_identity_attribute_values('alice@example.com', 'department');
 Error: UNSUPPORTED_FEATURE.IDENTITY_ATTRIBUTES_NON_SESSION_USER

-- Row filter UDF that returns only rows for the user's country
> CREATE FUNCTION main.sales.country_filter(country STRING)
    RETURN array_contains(user_identity_attribute_values(session_user(), 'country'), country);

-- Apply the UDF to every table in the schema that has a column tagged 'country'
> CREATE POLICY filter_by_user_country
    ON SCHEMA main.sales
    ROW FILTER main.sales.country_filter
    TO `account users`
    FOR TABLES
    MATCH COLUMNS has_tag('country') AS country_col
    USING COLUMNS (country_col);