Desarrollador de OneSpan: Autenticación Adaptativa Inteligente - Punto Final de Consulta de Usuarios

La Autenticación Adaptativa Inteligente (IAA) de OneSpan proporciona una manera fácil de listar los usuarios que se han registrado para un dominio específico. Con el punto final de consulta de usuarios, puede obtener información sobre cada uno de los usuarios actualmente registrados en su cuenta de sandbox. Hay varios parámetros que le permiten consultar convenientemente sólo a usuarios específicos o paginar a través de múltiples instancias. En este blog, echaremos un vistazo al punto final de la Consulta del Usuario, sus opciones de parámetros de ruta, y cómo puede probarlo desde la API Interactiva del Sandbox de IAA.

Antes de empezar: únase a la comunidad de desarrolladores de OneSpan

Antes de explorar el servicio web de consulta de los usuarios, primero debe ser miembro de la Comunidad OneSpan y registrarse para obtener una cuenta gratuita del sandbox de Autenticación Adaptativa Inteligente. Aquí tienes las instrucciones paso a paso para hacerlo.

También debes asegurarte de tener al menos un usuario registrado antes de intentar esta llamada. Para saber cómo registrar un usuario, consulte este blog detallado sobre el registro de usuarios.

También debes asegurarte de tener al menos un usuario registrado antes de intentar esta llamada. Para aprender a registrar un usuario, consulte OneSpan Developer: Intelligent Adaptive Authentication - User Registration.

URL del punto final

La URL de solicitud para esta llamada a la API se parecerá al ejemplo siguiente:

https://{su_ID_de_arrendatario}.sdb.tid.onespan.cloud/v1/users

No necesitarás proporcionar esta URL durante el tutorial. Es sólo para mostrar la estructura de la URL. La URL se asignará automáticamente en la API interactiva cuando se llame al servicio web

Pruébelo con el documento interactivo de la API

Para experimentar con la API de consulta de los usuarios, navegue hasta el documento de la API interactiva IAA Sandbox de su cuenta de la Comunidad OneSpan. En el editor de Open API Swagger, expanda el recurso "Usuarios". Entonces encontrará una entrada para el método Users Query HTTP Get como en la imagen de abajo

La API de consulta de usuarios es bastante sencilla de utilizar. No es necesario proporcionar un cuerpo de solicitud JSON para la llamada al método HTTP GET. Todo lo que necesita es configurar los parámetros de la ruta que se explican a continuación para adaptar la llamada a resultados específicos.

Parámetros de la URL

La siguiente tabla muestra las distintas opciones de parámetros de ruta que se utilizan para personalizar la consulta dentro de la API de la Plataforma Sandbox. También incluye la descripción y el ejemplo de cada parámetro de la ruta para ayudarle a hacer el mejor uso del punto final de la Consulta del Usuario.

Parámetro	Descripción	Campo Tipo de datos
userID	ID del usuario a buscar	Tipo: cadena Ejemplo: "iaa_user1" o "*" para listar todas las cuentas hasta 100 cuentas, soporta Wildcards.
dominio	Dominio en el que buscar cuentas de usuario.	Tipo: cadena Ejemplo: ospanuser-mail
bloqueado	Estado de bloqueo de la cuenta de usuario	Tipo: booleano Ejemplo: "Verdadero" o "Falso"
offset	Índice de la primera cuenta de usuario devuelta. El parámetro offset es más importante cuando hay más de 100 usuarios registrados, se utilizará para paginar a través de las cuentas registradas a partir del valor especificado	Tipo: entero Valor por defecto : 0 Ejemplo: 100 (esto listará los usuarios de la cuenta número 100, y el número de las cuentas listadas dependerá del parámetro "límite")
limitar	Número de cuentas de usuario devueltas. Juega un papel importante con el parámetro "offset" para personalizar la lista devuelta cuando el número de cuentas pasa de 100 cuentas	Tipo: entero Valor por defecto : 20 Valor máximo :100 Ejemplo: 20

A continuación se muestra un ejemplo sencillo de cómo será la URL de solicitud con algunos de los parámetros añadidos:

https://ospanuser-mail.sdb.tid.onespan.cloud/v1/users?locked=false&offset=20&limit=20

En el ejemplo, el parámetro Offset se ha fijado en 20. El parámetro Límite se ha establecido en 20, y el atributo booleano Bloqueado se ha establecido en Falso. Esto devolvería 20 usuarios desbloqueados, empezando por el vigésimo usuario de la lista.

Ejecución de la solicitud

Llegados a este punto, estamos preparados para realizar la llamada REST al punto final de Consulta de Usuarios utilizando la API interactiva del Sandbox de IAA. Para llamar al punto final, haga clic en el botón "Probar" que se muestra en la siguiente captura de pantalla y que se encuentra a la derecha de la sección del método HTTP GET "/users". Una vez solicitado, recibirá el cuerpo de la respuesta en formato JSON. Será similar a la carga útil de respuesta descrita en la siguiente sección.

Carga útil de la respuesta

A continuación se muestra un ejemplo del cuerpo de respuesta devuelto de una llamada exitosa a la API "/users".

 

@mailinator{ "total": 20, "offset": 0, "limit": 20, "count": 19, "users": [ { "created": "2020-05-08T22:04:35Z", "domain": "ospanuser-mail", "enabled": true, "isPasswordSet": true, "lastModified": "2020-05-08T22:22:09Z", "lastPasswordUpdate": "2020-05-08T22:04:35Z", "locked": false, "userID": "iaaUser1", "vdpDeliveryMethod": "Default", "emailAddress": "[email protected]", "mobilePhoneNumber": "+1 (555) 555 5555" }, { "created": "2020-05-27T10:35:52Z", "domain": "ospanuser-mail", "enabled": true, "isPasswordSet": true, "lastModified": "2020-05-27T10:35:53Z", "lastPasswordUpdate": "2020-05-27T10:35:52Z", "locked": false, "userID": "any.anyl", "vdpDeliveryMethod": "Default", "authenticators": [ "VDS0119940", "VDS0119940-2", "VDS0119940-

La siguiente tabla ofrece información más detallada sobre cada una de las propiedades de la carga útil de la respuesta anterior.

Objeto de respuesta JSON	Descripción	Tipo de datos
cuenta*	Número de cuentas de usuario devueltas.	Tipo: entero Ejemplo: 19
límite*	Número máximo de cuentas de usuario solicitadas.	Tipo: entero Ejemplo: 20
compensado*	Índice de la primera cuenta de usuario devuelta.	Tipo: entero Ejemplo: 0 para empezar desde el primer índice
total*	Número total de cuentas de usuario que coinciden con los parámetros de entrada de la consulta .	Tipo: entero Ejemplo: 3
usuarios*	Una lista de las cuentas de usuario devueltas, cada objeto de la lista se describe en la tabla siguiente.	Tipo: Una matriz JSON de las cuentas de usuario seleccionadas. Ejemplo: véase la respuesta anterior

Cada entrada en la matriz de usuarios de la tabla anterior contendrá al menos los siguientes campos.

Campo en la matriz de usuarios	Descripción	Tipo de datos
creado*	Fecha de creación de la cuenta de usuario	Tipo: cadena Ejemplo: 2019-02-04T11:42:39Z
dominio*	Dominio en el que reside la cuenta de usuario.	Tipo: cadena Ejemplo: ospanuser-mail
habilitado*	Especifica si la cuenta de usuario está habilitada o no.	Tipo: booleano Ejemplo: "Verdadero" o "Falso"
isPasswordSet*	Especifica si la cuenta de usuario tiene una contraseña estática o no.	Tipo: booleano Ejemplo: "Verdadero" o "Falso"
lastModified*	Fecha de la última modificación de la cuenta de usuario.	Tipo: cadena Ejemplo: 2019-02-04T11:42:39Z
lastPasswordUpdate*	Marca de tiempo de la última actualización de la contraseña estática.	Tipo: cadena Ejemplo: 2019-02-04T11:42:39Z
bloqueado*	Especifica si la cuenta de usuario se crea en estado de bloqueo o no.	Tipo: booleano Ejemplo: "Verdadero" o "Falso"
mdcPerfil*	Perfil del componente de entrega de mensajes (MDC) para el envío de OTP virtuales.	Tipo: cadena ejemplo: EUROPA
iD de usuario*	Identificador del usuario.	Tipo: cadena ejemplo: iaa_user1
vdpDeliveryMethod*	Método de entrega para el envío de la OTP virtual.	Tipo: cadena Ejemplo: SMS
autentificadores	Una lista de los autentificadores asignados a cada usuario.	Tipo: JSON Array ejemplo: ["VDS0119940",...]

En este blog, demostramos cómo utilizar el punto final de Consulta de Usuarios y modificar sus parámetros para obtener la lista actual de usuarios registrados en su cuenta de sandbox. Esté atento a más publicaciones en el blog sobre el uso de la API del Sandbox de la AIA. Mientras tanto, si tiene alguna pregunta, no dude en ponerse en contacto con nosotros en los foros del portal de la comunidad de OneSpan

Consulte más puntos finales de la categoría Usuarios:

• Registro de usuarios Punto final
• Desregistro del usuario en el punto final
• Punto final de actualización del usuario/a>