Asignar y Consultar Scopes

Documentación: Flujo Asignar y Consultar Scopes

Descripción

Para gestionar los scopes (alcances) en la instancia del tenant, puedes asignar scopes a usuarios y consultar los scopes disponibles. Este proceso se realiza sobre la base de datos del core del país y unidad de negocio correspondiente.

---

Asignar Scopes a un Usuario

Para asignar scopes a un usuario, utiliza la siguiente solicitud POST:

POST https://apolo-app-platcom-platform-bff-api-api.cencosudx.com/scopes/assign

Cuerpo de la Solicitud

{
  "user_id": "<ID del usuario>",
  "scope_ids": [
    "<ID del scope>"
  ]
}

Campos Detallados

Descripción de los Campos:

Campo	Tipo	Descripción
user_id	string	Identificador único del usuario al que se asignan los scopes.
scope_ids	string[]	Lista de identificadores de scopes que se asignarán al usuario.

Proceso

1. El usuario accede al portal de desarrolladores y navega a la sección de scopes.
2. Selecciona la opción para asignar scopes a un usuario.
3. Completa el formulario con los datos requeridos (ver tabla de campos).
4. El sistema valida la información ingresada.
5. Si la validación es exitosa, se realiza la solicitud POST al endpoint correspondiente.
6. El sistema recibe la respuesta y notifica al usuario el resultado de la operación.

Pasos principales

1. Ingresar al portal y autenticarse.
2. Ir a la sección "Scopes" o "Usuarios".
3. Seleccionar el usuario al que se desea asignar scopes.
4. Hacer clic en "Asignar scopes".
5. Completar los campos obligatorios: user_id y scope_ids.
6. Seleccionar los scopes que se desean asignar desde la lista disponible.
7. Enviar el formulario y esperar confirmación.

Consideraciones

• Los campos user_id y scope_ids son obligatorios.
• El user_id debe corresponder a un usuario válido y existente en el sistema.
• Los scope_ids deben corresponder a scopes previamente creados en el sistema.
• Un usuario puede tener múltiples scopes asignados simultáneamente.
• El sistema puede requerir permisos específicos para asignar scopes a usuarios.
• Se recomienda documentar internamente los cambios realizados para futuras referencias.

---

Consultar Scopes Disponibles

Para consultar los scopes disponibles, utiliza la siguiente solicitud GET:

GET https://apolo-app-platcom-platform-bff-api-api.cencosudx.com/roles

Cuerpo de la Solicitud (opcional)

{
  "user_id": "<ID del usuario>",
  "role_id": "<ID del rol>"
}

Campos Detallados

Descripción de los Campos:

Campo	Tipo	Descripción
user_id	string	(Opcional) Identificador del usuario para filtrar scopes asociados.
role_id	string	(Opcional) Identificador del rol para filtrar scopes asociados.

Proceso

1. El usuario accede al portal de desarrolladores y navega a la sección de scopes.
2. Selecciona la opción para consultar scopes disponibles.
3. (Opcional) Aplica filtros por usuario o rol si es necesario.
4. El sistema realiza la solicitud GET al endpoint correspondiente.
5. El sistema recibe la respuesta con la lista de scopes.
6. Los scopes se muestran al usuario en la interfaz.

Pasos principales

1. Ingresar al portal y autenticarse.
2. Ir a la sección "Scopes".
3. Hacer clic en "Consultar scopes" o "Ver scopes disponibles".
4. (Opcional) Aplicar filtros: ingresar user_id para ver scopes de un usuario específico o role_id para ver scopes de un rol.
5. Revisar la lista de scopes retornada por el sistema.
6. Utilizar la información para asignaciones o auditorías posteriores.

Consideraciones

• Todos los campos en la consulta son opcionales y funcionan como filtros.
• Si no se proporcionan filtros, se retornan todos los scopes disponibles en el sistema.
• El user_id permite consultar qué scopes tiene asignado un usuario específico.
• El role_id permite consultar qué scopes están asociados a un rol específico.
• Los resultados pueden variar según los permisos del usuario que realiza la consulta.
• Esta operación es de solo lectura y no modifica ningún dato en el sistema.
• Se recomienda utilizar esta consulta antes de asignar scopes para verificar disponibilidad.