Lire les utilisateurs par attribut depuis le serveur

Lire les utilisateurs par attribut depuis le serveurServer-side

post/attributes/users/get

Récupère une liste d'utilisateurs par attribut. Renvoie une liste comprenant les ID des utilisateurs, leurs adresses e-mail et les attributs spécifiés dans l'objet « key » de la requête.

Remarque
Les limites de fréquence pour les méthodes côté serveur s'appliquent à cette méthode.

SecurityAttributesServer

Request

Request Body schema: application/json

required

object

Attribut utilisé pour obtenir la liste des utilisateurs.

key required	string <= 256 characters [A-Za-z0-9_]+ Nom de l'attribut utilisé pour identifier l'attribut utilisateur. Il doit être unique pour chaque utilisateur.
value	string or null Valeur de l'attribut utilisateur. Nécessaire pour récupérer les utilisateurs ayant pour valeur de paramètre `key` la valeur spécifiée. Si non spécifiée, tous les utilisateurs ayant une valeur quelconque pour ce paramètre sont renvoyés.

after

string or null

Date de la mise à jour de l'attribut utilisateur et ID de l'attribut le plus récent dans la liste keys. Ne la définissez pas la première fois. Lorsque vous obtenez des utilisateurs par attribut, ils sont triés en fonction de leur date de mise à jour. Si plusieurs attributs ont la même date de mise à jour, ils sont triés par ID d'attribut. Elle est utilisée pour la pagination de l'API.

attr_type

string

Default: "client"

Définition du niveau d'accès de l'utilisateur aux attributs de service.

Enum: "client" "server"

keys

Array of strings <= 5 items

Liste des clés des attributs que vous voulez récupérer. Si vous ne les spécifiez pas, la méthode renvoie tous les attributs de l'utilisateur.

limit

integer [ 0 .. 20 ]

Default: 20

Nombre d'utilisateurs renvoyés lors d'une recherche par attribut.

login_project_id

string

ID de connexion issu du Compte éditeur pour lequel vous souhaitez récupérer les attributs utilisateur. Si vous le spécifiez, il sera utilisé à la place de l'ID de commerçant et de l'ID de projet issus du Compte éditeur.

publisher_id

integer or null

Votre ID de commerçant pour lequel la requête est faite. Nécessaire pour l'autorisation de la requête.

publisher_project_id

integer

ID de projet issu du Compte éditeur pour lequel vous voulez récupérer les utilisateurs. Si vous ne le spécifiez pas, l'appel renvoie les utilisateurs sans la valeur de ce paramètre.

search_type

string

Default: "equal"

Condition de comparaison qui définit les critères de recherche.

Enum: "equal" "like"

Responses

200

400

Bad Request

403

Forbidden

422

Unprocessable Entity

429

Too Many Requests

Request samples

application/json

{"after": "string",
"attr_type": "client",
"attribute": {"key": "string",
"value": "string"
},
"keys": ["string"
],
"limit": 20,
"login_project_id": "string",
"publisher_id": 0,
"publisher_project_id": 0,
"search_type": "equal"
}

Response samples

application/json

[{"attributes": [{"attr_type": "client",
"data_type": "string",
"description": "string",
"format": "string",
"key": "string",
"permission": "public",
"readonly": true,
"value": "string"
}
],
"email": "string",
"user_id": "string"
}
]