Crear Roles

Documentación: Flujo Crear Roles

Descripción

Para crear roles asociados al proveedor, sigue estos pasos. Este proceso involucra la configuración del rol dentro de la base de datos del core del país y unidad de negocio correspondiente.

---

Pasos para Crear Roles

Para crear un rol, utiliza la siguiente solicitud POST:

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

Cuerpo de la Solicitud

{
  "name": "security_admin_role_pe",
  "auth_provider_default": [],
  "label": "Administrador de Seguridad Peru",
  "scope_ids": [
    "670972f361dade039b0f88d6",
    "66c666908bd2409eab6f9e26"
  ],
  "resources": [
    {
      "name": "tenant",
      "actions": [
        "get_available"
      ]
    },
    {
      "name": "application",
      "actions": [
        "get_available"
      ]
    },
    {
      "name": "reports",
      "actions": [
        "create",
        "read",
        "update",
        "delete",
        "export"
      ]
    }
  ]
}

Campos Detallados

Descripción de los Campos:

Campo	Tipo	Descripción
name	string	Nombre único e identificador del rol.
auth_provider_default	string[]	Lista de proveedores de autenticación por defecto asociados al rol.
label	string	Etiqueta descriptiva del rol visible para el usuario.
scope_ids	string[]	Lista de identificadores de alcance (scopes) asociados al rol.
resources	object[]	Lista de recursos y acciones permitidas para el rol.
└ name	string	Nombre del recurso (por ejemplo, tenant, application, reports).
└ actions	string[]	Acciones permitidas sobre el recurso (por ejemplo, create, read, update, delete, export, get_available).

Proceso

1. El usuario accede al portal de desarrolladores y navega a la sección de roles.
2. Selecciona la opción para crear un nuevo rol.
3. Completa el formulario con los datos requeridos (ver tabla de campos).
4. Define los recursos y permisos asociados al rol.
5. El sistema valida la información ingresada.
6. Si la validación es exitosa, se realiza la solicitud POST al endpoint correspondiente.
7. 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 "Roles".
3. Hacer clic en "Crear nuevo rol".
4. Completar los campos obligatorios: name, label y scope_ids.
5. (Opcional) Configurar proveedores de autenticación en auth_provider_default si corresponde.
6. Definir los recursos y sus acciones permitidas en el array resources.
7. Verificar que los permisos configurados sean correctos para cada recurso.
8. Enviar el formulario y esperar confirmación.

Consideraciones

• Los campos name, label, scope_ids y resources son obligatorios.
• El name del rol debe ser único dentro del sistema.
• Los scope_ids deben corresponder a scopes previamente creados y válidos en el sistema.
• El campo auth_provider_default puede estar vacío si no se requieren proveedores específicos.
• Las acciones disponibles en resources dependen del tipo de recurso y pueden incluir: create, read, update, delete, export, get_available, entre otras.
• Se recomienda seguir el principio de menor privilegio al asignar acciones a los recursos.
• El sistema puede requerir permisos específicos para crear o modificar roles.
• Se recomienda documentar internamente los cambios realizados para futuras referencias.
• Verificar que el rol se haya creado correctamente en la base de datos del core del país y la unidad de negocio correspondiente.