Si vous devez trouver 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, un court délai (généralement quelques secondes) est appliqué lors de la création d'un client. Si vous avez besoin d'accéder à un client immédiatement après sa création, nous vous recommandons d'utiliser customers.list sans filtre ou customers.get.
Filtres disponibles
Les chaînes du paramètre de filtre acceptent les mots clés exacts ou les mots clés exacts avec filtrage par 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 qu'ils acceptent.
| Clé de recherche externe | Prise en charge des 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 des API.
Syntaxe des mots clés exacts
Les filtres de correspondance exacte ne trouveront que les clients qui contiennent 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 recherche les clients dont les champs comportent le préfixe, quel que soit le contenu qui le suit.
Syntaxe: <domain | org_display_name> : <value>*
Exemple : domain : "uw.com*" AND org_display_name : "prefix*"
Exemples de filtres avec des opérateurs logiques
Les filtres de l'API Cloud Channel acceptent l'utilisation des opérateurs logiques ET et OU. Vous pouvez utiliser les deux opérateurs dans un même filtre à l'aide d'une instruction entre parenthèses.
Exemple d'utilisation de la fonction ET
domain = "domain.com" AND channel_partner_id = "12345" AND org_display_name :
"display*"
Exemple d'utilisation de la fonction OU
domain = "domain.com" OR channel_partner_id = "12345" OR org_display_name :
"display*"
Exemple AND + OU
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*