Obtener usuarios filtrados por atributo desde el servidor

post/attributes/users/get

Obtiene una lista de usuarios filtrados por un atributo. Devuelve una lista de ID de usuarios, sus correos electrónicos y los atributos que se especificaron en el objeto 'key' de la solicitud.

SecurityAttributesServer

Request

Request Body schema: application/json

required

object

El atributo se utiliza para obtener la lista de usuarios.

key required	string <= 256 characters [A-Za-z0-9_]+ Nombre del atributo que se usa para identificar un atributo de usuario. Debe ser único para cada usuario.
value	string or null Valor del atributo del usuario. Necesario para obtener usuarios con el parámetro `key` con este valor. Si no se especifica, devuelve todos los usuarios con cualquier valor para esta clave.

after

string or null

Fecha de actualización del atributo del usuario e ID del último atributo presente en la lista de keys. No lo la establezca inicialmente. Cuando obtenga usuarios filtrados por atributo, se ordenan por su fecha de actualización. Si varios atributos tienen la misma fecha de actualización, se ordenan por ID de atributo. Se utiliza para la paginación de la API.

attr_type

string

Default: "client"

Definición del nivel de acceso del usuario a los atributos del servicio.

Enum: "client" "server"

keys

Array of strings <= 5 items

Lista de claves de atributos que desea obtener. Si no los especifica, el método devuelve todos los atributos del usuario.

limit

integer [ 0 .. 20 ]

Default: 20

Número de usuarios que devuelve la búsqueda por atributo.

login_project_id

string

ID de Login de la Cuenta del editor respecto a la cual desea obtener los atributos del usuario. Si no lo especifica, se utilizará en su lugar el ID del comerciante y el ID del proyecto de la Cuenta del editor.

publisher_id

integer or null

Su ID de comerciante para el que se realiza la solicitud. Necesario para autorizar la solicitud.

publisher_project_id

integer

ID del proyecto de la Cuenta del editor de la cual desea obtener los usuarios. Si no lo especifica, devuelve los usuarios sin el valor de este parámetro.

search_type

string

Default: "equal"

Condición de comparación que define los criterios de búsqueda.

Enum: "equal" "like"

Responses

200

ACEPTAR

400

Bad Request (Solicitud errónea)

403

Unprocessable Entity (Entidad no procesable)

422

Unprocessable Entity (Entidad no procesable)

429

Too Many Requests (Demasiadas solicitudes)

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"
}
]