user_identity_attribute_values Función

Se aplica a:marcado sí Databricks SQL marcado sí Databricks Runtime 19 y superior

Importante

Esta función lee atributos de identidad que están en Beta. Antes de poder usarlo, un administrador de cuenta debe habilitar la vista previa de la lista de control de atributos de identidad desde la página de vistas previas de la consola de la cuenta y proporcionar atributos de identidad para tus usuarios. Ver Atributos de Identidad.

Devuelve los valores de un atributo de identidad del usuario de la sesión.

Utilice esta función en los UDF de filtro de filas para filtrar filas según atributos del usuario que realiza la consulta, como su departamento o país. Para aplicar el filtro entre tablas, referencia la UDF en una política de filtro de fila ABAC.

Sintaxis

user_identity_attribute_values(principal, attributeName)

Arguments

  • principal: Una expresión constante STRING . El único valor admitido es session_user().
  • attributeName: Una expresión que nombra STRING un atributo de identidad. El nombre no tiene por qué ser una constante, así que puede ser una columna o un parámetro SQL UDF. Los nombres distinguen entre mayúsculas y minúsculas. Para los atributos disponibles, consulte Atributos de identidad.

Devoluciones

Un no anulable ARRAY<STRING>.

Si el usuario no tiene valor para attributeName, la función devuelve un array vacío.

Condiciones del error

  • Si principal no es el usuario de la sesión, Azure Databricks eleva UNSUPPORTED_FEATURE.IDENTITY_ATTRIBUTES_NON_SESSION_USER.
  • Si principal no es constante, Azure Databricks sube NON_FOLDABLE_ARGUMENT.
  • Si attributeName es NULL o no nombra un atributo de identidad existente, Azure Databricks genera IDENTITY_ATTRIBUTE_NOT_FOUND. Esto incluye nombres que solo difieren en el caso de mayúsculas, como 'Department'.

Notes

  • La función devuelve los atributos del usuario que ejecuta la consulta. Dentro de una vista o de una UDF SQL, devuelve los atributos del usuario que consulta la vista o que llama a la UDF, no del propietario.
  • Si utilizas la función en un filtro de filas UDF, escribe la condición del filtro para que un array vacío niegue el acceso. Por ejemplo, array_contains(..., 'HR') oculta filas a usuarios sin department valor, por lo que denega el acceso por defecto. NOT array_contains(..., 'contractor') Muestra filas a usuarios sin valor userType , por lo que concede acceso por defecto.
  • Utilice funciones del array como array_contains o arrays_overlap para probar el resultado, en lugar de asumir que el array tiene exactamente un elemento.
  • No puedes usar la función en una vista compartida a través de OpenSharing.
  • Para comprobar qué valores de atributo devuelve la función para ti, llámalo directamente en una consulta, por SELECT user_identity_attribute_values(session_user(), 'department')ejemplo .

Examples

> 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);