Configurar un filtro de clientes mediante la API ListCustomers

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

Si usas un filtro, habrá un breve retraso (normalmente, de unos segundos) durante la creación de un cliente. Si necesitas acceder a un cliente inmediatamente después de crearlo, te recomendamos que uses customers.list sin filtro o customers.get.

Filtros disponibles

Las cadenas del parámetro de filtro admiten la concordancia exacta o la concordancia exacta más el filtrado por prefijo. Los filtros no distinguen entre mayúsculas y minúsculas.

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

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

Puedes consultar la sintaxis completa de los filtros en la guía de filtrado de la API.

Sintaxis de 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 prefijo

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

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 Cloud Channel admiten el uso de los operadores lógicos AND y OR. Puede usar ambos operadores en un mismo filtro mediante una instrucción entre paréntesis.

Ejemplo de Y

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

Ejemplo de 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*" )

Si el filtro contiene las instrucciones AND y OR, debe usar paréntesis. El siguiente ejemplo no es una cadena de filtro válida.

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