Desarrollador de OneSpan: Autenticación Adaptativa Inteligente - Punto final de consulta de autenticadores
![OneSpan-BlogImage-[IAA-Authenticators-Query]](/sites/default/files/styles/blog_detail_image/public/2020-09/OneSpan-BlogImage-%5BIAA-Authenticators-Query%5D_1.jpg?itok=iMF-uflg)
Debido a su papel integral en la autenticación adaptativa inteligente (IAA) de OneSpan, se incluyó una sección entera en la API interactiva del Sandbox de IAA sobre los autenticadores Digipass. La sección comprende cada punto final para manejar las actividades relacionadas con los autenticadores. Por ejemplo, con estos endpoints se pueden ver, asignar o desasignar autenticadores a las cuentas de usuario y generar datos de activación. En este blog, exploraremos el punto final de Consulta de Autenticadores y mostraremos cómo personalizar sus parámetros de ruta. Para ello, haremos una llamada HTTP GET para listar todos los autentificadores que pertenecen a una cuenta específica y explicaremos esta llamada a través de la API interactiva del Sandbox de la IAA.
Antes de empezar
Antes de explorar el servicio web Authenticator Query, 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.
URL del punto final
La URL de solicitud para esta llamada a la API se parecerá al ejemplo siguiente:
https://{su_identificación_de_arrendatario}.sdb.tid.onespan.cloud/v1/autenticadores
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 al llamar al servicio web
Experiméntelo con la API interactiva del Sandbox
Para experimentar con la API de consulta del autenticador, navegue hasta el documento de la API interactiva IAA Sandbox en su cuenta de la Comunidad OneSpan. En el editor de Open API Swagger, expanda el recurso "Authenticators". A continuación, encontrará una entrada para el método Authenticators Query HTTP Get, como se muestra en la imagen siguiente:
La API de consulta de autenticadores 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 para adaptar la llamada a resultados específicos.
Parámetros de la ruta URL:
El punto final de consulta de autenticadores abarca varios parámetros de ruta que le ayudan a localizar una lista específica de los autenticadores para personalizar la consulta dentro de la API de la Plataforma Sandbox. La siguiente tabla muestra las distintas opciones de parámetros de la ruta que se utilizan para personalizar la consulta:
| Parámetro de la ruta | Descripción | Campo Tipo de datos |
|---|---|---|
| número de serie | Permite especificar si se quieren listar todos los autentificadores, o si se quiere encontrar un autentificador específico proporcionando su número de serie | Tipo: cadena Ejemplo: VDS0091651 o "*" para listar todas las cuentas hasta 100 cuentas, soporta Wildcards |
| dominio |
Dominio en el que buscar autentificadores. | Tipo: cadena Ejemplo: ospanuser-mail |
| tipo | Tipo de autentificador. | Tipo: cadena ejemplo: DAL10 |
| asignado |
Estado de la asignación para filtrar los resultados | Tipo: booleano Ejemplo: "Verdadero" o "Falso" |
| offset | Índice del primer autentificador devuelto. El parámetro offset es útil cuando se requiere una paginación a través de la lista de autentificadores | Tipo: entero Valor por defecto: 0 Ejemplo: 10 (esto listará los autentificadores a partir del décimo autentificador, y el número de autentificadores listados dependerá del parámetro "límite") |
| limitar | El número de autentificadores devueltos. Juega un papel importante con el parámetro "offset" para personalizar la lista devuelta de los autentificadores | Tipo: entero Valor por defecto : 20 Valor máximo :100 Ejemplo: 4 |
A continuación se muestra un ejemplo de cómo será la URL de solicitud con algunos de los parámetros añadidos:
https://ospanuser-mail.sdb.tid.onespan.cloud/v1/authenticators?
type=DAL10&assigned=true&limit=20
En el ejemplo, el parámetro Tipo se ha ajustado a DAL10. El parámetro booleano "Asignado" se ha fijado en "Verdadero", y el "Límite" se ha fijado en '20'. Esto devolvería un máximo de 20 autentificadores ya asignados de tipo DAL10.
Llamada al punto final
Llegados a este punto, estamos preparados para realizar una llamada RESTful al punto final de consulta de autenticadores utilizando la API interactiva del Sandbox de la IAA. Para realizar la llamada, 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 "/authenticators". 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 a la API "/authenticators" realizada con éxito.
{ "total": 10, "offset": 0, "limit": 20, "count": 10, "authenticators": [ { "applications": [ { "name": "ACTIVATION", "type": "MA" } ], "created": "2018-09-07T11:31:02Z", "domain": "osiaa4-mailinator", "lastModified": "2020-05-28T18:22:07Z", "serialNumber": "VDS0028610", "activation": { "activationsCount": "4", "lastActivated": "2020-05-28T18:22:06Z", "locationsCount": "0", "bound": false }, "assignedUserID": "userid100000", "authenticatorType": "DAL10", "assigned": true }, ...]
Descripción de los campos de la carga útil de la respuesta
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 | Descripción | Tipo de datos |
|---|---|---|
| total* |
Contiene el número total de autentificadores que coinciden con los parámetros de entrada de la consulta. | Tipo: entero Ejemplo: 3 |
| compensado* | Índice del primer autentificador devuelto. | Tipo: entero Ejemplo: 0 para empezar desde el primer índice |
| límite* | Número máximo de autentificadores de usuario solicitados. | Tipo: entero Ejemplo: 20 |
| cuenta* | Número de autentificadores devueltos. | Tipo: entero Ejemplo: 19 |
| autentificadores* | Una lista de los autentificadores devueltos. Cada objeto de la lista se describe en la siguiente tabla. | Tipo: Una matriz JSON de los autenticadores seleccionados. Ejemplo: véase la carga útil de la respuesta anterior. |
El objeto "authenticators" es la parte más importante del cuerpo de la respuesta JSON. Tiene la información correspondiente a cada autentificador listado en la respuesta. En la siguiente tabla, se encuentra la lista de todos los atributos del objeto authenticators.
| Campos de datos | Descripción | Tipo de datos |
|---|---|---|
| aplicaciones* | La lista de aplicaciones soportadas por el autentificador. Este atributo es una matriz que lleva el nombre y el tipo de cada autentificador | Tipo: lista JSON Ejemplo: "aplicaciones": [{ "nombre": ACTIVACIÓN", "tipo": "MA" } ] |
|
asignado* |
Indica si este autentificador está asignado a un usuario. |
Tipo: booleano Ejemplo: Verdadero o Falso |
|
creado* |
La fecha de creación del autentificador. | Tipo: cadena Ejemplo: 2019-02-04T11:42:39Z |
|
dominio* |
El dominio en el que reside la cuenta de usuario. | Tipo: cadena Ejemplo: ospanuser-mail |
|
lastModified* |
La última fecha de modificación del autentificador. | Tipo: cadena Ejemplo: 2019-02-04T11:42:39Z |
|
número de serie* |
El número de serie del autentificador. |
Tipo: cadena Ejemplo: "VDS0091651" |
|
activación |
El objeto de activación tendrá tres atributos, "bound" para indicar si el autentificador está vinculado a un dispositivo específico, "activationsCount" para mostrar el número de activaciones. "lastActivated" para mostrar la última fecha de activación del autentificador. "locationsCount" para mostrar el número de ubicaciones de activación. | Tipo: Lista JSON Ejemplo: Véase la carga útil de la respuesta anterior |
| assignedUserID* | El usuario al que está asignado este autentificador. | Tipo: cadena Ejemplo: "iaa_user1" |
| authenticatorType* | El tipo de autentificador. | Tipo: cadena Ejemplo: "DAL10" |
En este blog, hemos ilustrado cómo utilizar el punto final de consulta de autenticadores y modificar sus parámetros para filtrar los autenticadores disponibles 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 Authenticators:
Comunidad de desarrolladores de OneSpan Sign
¡Únase a la comunidad de desarrolladores de OneSpan Sign! Foros, blogs, documentación, descargas de SDK y más.
Únete hoy