Saltar al contenido principal
Un socio puede llamar a Reporter con su propia credencial. En Reporter, restringes esa credencial a algunas instituciones, a algunos templates, o a ambos. Esta página muestra cómo elegir ese ámbito, qué alcanza cada opción y qué recibe el socio cuando sale de él. Todo socio de Reporter necesita un ámbito: al menos una institución o un template.

​
Paso a paso

1

Elige con qué trabaja el socio

Elige el ámbito más estrecho que cubra lo que el socio necesita. Cada fila es una restricción que puedes agregar. El campo en la API es el field de una entrada de ámbito; la Console muestra el nombre de la primera columna.Las dos restricciones se pueden combinar. Un socio restringido por ambas nombra una institución y un template de su ámbito en toda solicitud sobre reportes, y lee un reporte por ID solo bajo ambos. Cada valor es el ID que Reporter devuelve cuando creas la institución o el template.El catálogo de ámbito lista todas las restricciones de Reporter. Léelo con Consultar el catálogo de ámbito de un producto para reporter.Algunas reglas valen para todo ámbito:
  • Una solicitud que no nombra un elemento de un tipo restringido se rechaza cuando actúa sobre reportes. Por ejemplo, un socio restringido a algunas instituciones no puede listar todos los reportes de tu tenant.
  • Una query que lista varios valores se rechaza cuando cualquiera de ellos está fuera del ámbito. Un campo del cuerpo acepta un valor: una lista en él se rechaza con 400.
  • Las rutas que actúan sobre todo el tenant se rechazan a todo socio: fuentes de datos, plazos, métricas, eventos, las listas de templates y de instituciones, el catálogo regulatorio, las suscripciones regulatorias y sus mapeos, y las correcciones, la aprobación y la procedencia de una remesa regulatoria.
2

Da al socio sus permisos y su ámbito

Crea el socio, o cámbialo, en la Console o con la API de Identity. El identificador del producto es reporter.
  • Agrega al menos una entrada de ámbito de Reporter. Sin ella, Access Manager rechaza el socio con 400 y IDE-1060.
  • Marca los recursos y las acciones. Lo máximo que puedes dar es lo que el rol reporter-editor-role tiene en tu tenant.
Access Manager verifica cada escritura que das contra el ámbito. Una escritura que actúa sobre todo el tenant nunca se da a un socio, y se rechaza con 400 y IDE-1056. La Console marca la línea como Outside the scope. En Reporter, esas escrituras son:
  • Crear, cambiar o eliminar templates, fuentes de datos, plazos e instituciones.
  • Cambiar o eliminar una suscripción regulatoria y su mapeo.
  • Aprobar una remesa regulatoria (regulatory-approval).
Las escrituras que un socio puede recibir son reports con post, para generar reportes, y regulatory con post, para suscribir sus instituciones y generar sus remesas.
3

Crea su aplicación de Reporter

Crea la aplicación del socio con el producto reporter. Consulta cómo crear las aplicaciones del socio en la guía de la API o en la Console. Envía el client ID y el client secret al socio por un canal seguro.
4

Indica al socio cómo nombrar sus elementos

En las rutas que leen un reporte, el path trae la institución, el template o ambos, según la ruta que el socio elige. En las demás rutas, el socio los nombra en las queries y los cuerpos que Reporter ya tiene. Solo se verifican las restricciones que el socio tiene: cada valor que nombra para una de ellas debe estar dentro de su ámbito. Un socio restringido solo por template puede nombrar cualquier institución.Un socio lee un reporte por ID solo por las rutas que nombran su institución o su template. GET /v1/reports/{id} y su /download se rechazan a todo socio. Para generar una remesa, un socio usa /v1/institutions/{institutionId}/regulatory/reports. POST /v1/regulatory/reports se rechaza a todo socio.Un reporte de otra institución o de otro template, pedido bajo el path del propio socio, responde 404 con RPT-0011. Es la misma respuesta que para un ID que no existe. Lo mismo vale para una suscripción regulatoria de otra institución, enviada bajo la institución del propio socio.
Lo que el socio ve en un reporte es lo que el template y la fuente de datos leen. Reporter limita las filas a una institución solo por el ámbito de la institución: las filas de cada fuente de datos que le pertenecen. Antes de dar una institución a un socio, verifica que el ámbito de la institución nombre sus filas en toda fuente de datos que sus templates leen.Un socio restringido solo por template no queda limitado a una institución: puede generar sus templates para cualquier institución. Da a ese socio templates y fuentes de datos hechos solo para él. Si un socio lee filas que no son suyas, el template, la fuente de datos o el ámbito de la institución está mal configurado. Es un error de configuración, no de autorización, y la corrección está en esa configuración.
5

Confirma que funciona

Esta verificación supone que el socio tiene el recurso reports con la acción get en Reporter, y un ámbito restringido a una o más instituciones. Usa la credencial del socio. Lee un reporte de una institución dentro de su ámbito. La respuesta es 200:
Envía la misma solicitud con una institución fuera del ámbito. La respuesta es 403. Para ver el código, quita el -o /dev/null: el cuerpo de la respuesta trae AUT-1020.

​
Si algo falla

La respuesta no indica si fueron los permisos o el ámbito los que rechazaron la solicitud. Es intencional: un socio no puede usar un rechazo para saber qué instituciones o templates existen fuera de su ámbito. Para todos los demás códigos, consulta la lista de errores de Reporter. Para los rechazos al crear o cambiar un socio, consulta los códigos de error de la guía de la API.