Configurer un filtre client à l'aide de l'API ListCustomers

Pour rechercher des informations sur un client spécifique, vous pouvez utiliser le paramètre filter de l'API Cloud Channel via la méthode customers.list.

Si vous utilisez un filtre, le délai de création d'un client est court (généralement de quelques secondes). Si vous avez besoin d'accéder à un client immédiatement après la création, nous vous recommandons d'utiliser customers.list sans filtre ni customers.get.

Filtres disponibles

Les chaînes du paramètre de filtre sont compatibles avec le filtrage des mots clés exacts ou des mots clés exacts avec préfixe. Les filtres ne sont pas sensibles à la casse.

Le tableau suivant décrit les champs disponibles que vous pouvez rechercher et les méthodes compatibles.

Touche de recherche externe	Compatibilité avec les mots clés exacts	Compatibilité des préfixes
domaine	Oui	Oui
org_display_name	Oui	Oui
cloud_identity_id	Oui	Non
channel_partner_id	Oui	Non

Vous trouverez la syntaxe complète des filtres dans le guide de filtrage de l'API.

Syntaxe des mots clés exacts

Les filtres de correspondance exacte ne trouveront que les clients contenant les mêmes champs que ceux de la chaîne envoyée.

Syntaxe : <domain | org_display_name | cloud_identity_id | channel_partner_id> = <value>

Exemple : domain = "domain.com" AND channel_partner_id = "12345"

Syntaxe du préfixe

Les filtres de préfixe permettent d'utiliser un astérisque comme caractère générique. Ce filtre trouvera les clients qui comportent des champs avec ce préfixe, quel que soit le contenu qui suit.

Syntaxe: <domain | org_display_name> : <value>*

Exemple : domain : "uw.com*" AND org_display_name : "prefix*"

Exemples de filtres avec opérateurs logiques

Les filtres de l'API Cloud Channel sont compatibles avec l'utilisation des opérateurs logiques AND et OR. Vous pouvez utiliser les deux opérateurs dans un même filtre en utilisant une instruction entre parenthèses.

Exemple d'opérateur AND

domain = "domain.com" AND channel_partner_id = "12345" AND org_display_name : "display*"

Exemple avec l'opérateur OR

domain = "domain.com" OR channel_partner_id = "12345" OR org_display_name : "display*"

Exemple d'opérateur AND + OR

domain = "domain.com" OR (channel_partner_id = "12345" AND org_display_name : "display*" )

Vous devez utiliser des parenthèses si le filtre contient une instruction AND et une instruction OR. L'exemple suivant n'est pas une chaîne de filtre valide.

domain = "domain.com" OR channel_partner_id = "12345" AND org_display_name : "display*