Configura un filtro de clientes con la API de ListCustomers

Si necesitas encontrar información sobre un cliente específico, puedes usar el parámetro filter de la API de Cloud Channel a través del método customers.list.

Si usas un filtro, se produce una breve demora (por lo general, de unos segundos) durante la creación de un cliente. Si necesitas acceso a un cliente inmediatamente después de su creación, te recomendamos que uses customers.list sin un filtro o customers.get.

Filtros disponibles

Las cadenas para el parámetro de filtro admiten la concordancia exacta o la concordancia exacta más el filtrado de prefijos. Los filtros no distinguen mayúsculas de minúsculas.

En la siguiente tabla, se describen los campos disponibles que puedes buscar y los métodos que admiten.

Clave de búsqueda externa Compatibilidad con la concordancia exacta Prefijos admitidos
dominio
org_display_name
cloud_identity_id No
channel_partner_id No

Puedes encontrar la sintaxis de filtro completa en la guía de filtrado de la API.

Sintaxis de la concordancia exacta

Los filtros de concordancia exacta solo encontrarán clientes que contengan los mismos campos que los de la cadena enviada.

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

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

Sintaxis de prefijos

Los filtros de prefijo permiten usar un asterisco como símbolo de comodín. Este filtro encontrará clientes que tengan campos con el prefijo, independientemente del contenido que aparezca después de él.

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

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

Ejemplos de filtros con operadores lógicos

Los filtros de la API de Cloud Channel admiten el uso de operadores lógicos Y y O. Puedes usar ambos operadores en un filtro con una sentencia entre paréntesis.

Ejemplo de Y

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

Ejemplo del operador O

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

Ejemplo de Y + O

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

Debes usar paréntesis si el filtro contiene una sentencia Y y una O. El siguiente ejemplo no es una cadena de filtro válida.

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