Obtenir les valeurs d'attribut utilisateur

Version 3.1.23.2

Récupère les valeurs d'attribut pour un utilisateur donné.

Renvoie les valeurs des attributs utilisateur spécifiés (ou de tous les attributs utilisateur) d'un utilisateur spécifique.

Une valeur est définie pour chaque attribut utilisateur aux emplacements suivants, dans cet ordre:

  1. dans les informations de compte de l'utilisateur
  2. dans les groupes dont l'utilisateur est membre
  3. la valeur par défaut de l'attribut utilisateur

Si plusieurs groupes ont une valeur définie pour un attribut utilisateur, celui dont le classement est le plus faible l'emporte.

La réponse n'inclut que les attributs utilisateur pour lesquels des valeurs ont été trouvées. Utilisez include_unset=true pour inclure des enregistrements vides pour les attributs utilisateur sans valeur.

La valeur de tous les attributs utilisateur masqués sera vide.

Demande

GET /users/{user_id}/attribute_values
Type de données
Description
Demande
HTTPRequest
chemin d'accès
Chemin HTTP
Développer la définition HTTPPath...
user_id
integer
ID de l'utilisateur
query
Requête HTTP
Développer la définition de la requête HTTP...
champs
string
Champs demandés.
id_attribut_utilisateur
entier[]
toutes_valeurs
booléen
Si la valeur est "true", toutes les valeurs du chemin de recherche sont renvoyées, pas uniquement la première valeur trouvée. Utile pour déboguer la priorité du groupe.
inclure_non défini
booléen
Si la valeur est "true", renvoie un enregistrement vide pour chaque attribut demandé qui n'a pas d'utilisateur, de groupe ni de valeur par défaut.

Réponse

200: Valeur de l'attribut utilisateur.

Type de données
Description
peut
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
name
string
Nom de l'attribut utilisateur
label
string
Libellé lisible pour l'attribut utilisateur
rank
integer
Priorité à la définition de la valeur sur l'utilisateur (victoires les plus faibles)
valeur
string
Valeur de l'attribut pour l'utilisateur
user_id
integer
ID de l'utilisateur
Modification par l'utilisateur
booléen
L'utilisateur peut-il définir cette valeur ?
valeur_est_masquée
booléen
Si la valeur est "true", le champ "value" sera nul, car les paramètres de l'attribut bloquent l'accès à cette valeur.
id_attribut_utilisateur
integer
ID de l'attribut utilisateur
source
string
Comment l'utilisateur a-t-il obtenu cette valeur pour cet attribut ?
domaine_valeur_masquée_liste_blanche
string
Si cet attribut utilisateur est masqué, liste de destinations autorisée vers laquelle il peut être envoyé.

404: introuvable

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

Examples