user_identity_attribute_values Fonction

S’applique à :coché oui Databricks SQL coché oui Databricks Runtime 19 et supérieur

Important

Cette fonction lit les attributs d’identité, qui sont en Bêta. Avant de pouvoir l’utiliser, un administrateur de compte doit activer l’aperçu de la liste de contrôle des attributs d’identité depuis la page d’aperçu de la console de compte et fournir des attributs d’identité pour vos utilisateurs. Voir attributs d’identité.

Renvoie les valeurs d’un attribut identity de l’utilisateur de session.

Utilisez cette fonction dans les UDF de filtrage de lignes pour filtrer les lignes en fonction des attributs de l’utilisateur interrogateur, tels que son département ou son pays. Pour appliquer le filtre à travers les tableaux, référez la UDF dans une politique de filtre de ligne ABAC.

Syntaxe

user_identity_attribute_values(principal, attributeName)

Arguments

  • principal: Une expression constante STRING . La seule valeur possible est session_user().
  • attributeName: Une STRING expression qui nomme un attribut identité. Le nom n’a pas besoin d’être une constante, il peut donc être une colonne ou un paramètre SQL UDF. Les noms sont sensibles à la casse. Pour les attributs disponibles, voir Attributs d’identité.

Returns

Un non annulable ARRAY<STRING>.

Si l’utilisateur n’a aucune valeur pour attributeName, la fonction renvoie un tableau vide.

Conditions de l’erreur

  • Si principal ce n’est pas l’utilisateur de la session, Azure Databricks lève UNSUPPORTED_FEATURE.IDENTITY_ATTRIBUTES_NON_SESSION_USER.
  • Si principal n’est pas une constante, Azure Databricks augmente NON_FOLDABLE_ARGUMENT.
  • Si attributeName est NULL ou ne nomme pas un attribut identity existant, Azure Databricks soulève IDENTITY_ATTRIBUTE_NOT_FOUND. Cela inclut les noms qui ne diffèrent que dans les cas, tels que 'Department'.

Notes

  • La fonction retourne les attributs de l’utilisateur qui exécute la requête. À l’intérieur d’une vue ou d’une UDF SQL, il renvoie les attributs de l’utilisateur interrogeant la vue ou appelant l’UDF, et non du propriétaire.
  • Si vous utilisez la fonction dans un filtre de ligne UDF, écrivez la condition de filtre de sorte qu’un tableau vide refuse l’accès. Par exemple, array_contains(..., 'HR') masque les lignes aux utilisateurs sans department valeur, et refuse donc l’accès par défaut. NOT array_contains(..., 'contractor') Affiche les lignes aux utilisateurs sans userType valeur, donc il accorde l’accès par défaut.
  • Utilisez des fonctions de tableau telles que array_contains ou arrays_overlap pour tester le résultat, plutôt que de supposer que le tableau comporte exactement un seul élément.
  • Vous ne pouvez pas utiliser la fonction dans une vue partagée via OpenSharing.
  • Pour vérifier quelles valeurs d’attribut la fonction retourne pour vous, appelez-la directement dans une requête, par SELECT user_identity_attribute_values(session_user(), 'department')exemple .

Exemples

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