Saltar al contenido principal

OPERATOR_TEAM_PROVISIONING_API

API_SEC_LOG: USER_MANAGER_ACTIVE

La API de aprovisionamiento de equipo permite al rol Admin de un Workspace añadir operadores, invitar ingenieros externos (Users) y gestionar sus privilegios granulares dentro de la consola analítica.

01_LIST_MEMBERS_AND_ROLES​

Consulta rápida sobre el personal activo y las jerarquías registradas en el Workspace:

  • Listar Operadores en el Workspace: GET /admin/users/list/{workspaceId}
  • Listar Roles del Sistema (Jerarquías): GET /admin/users/roles/{workspaceId}

02_INVITATION_AND_ONBOARDING_SYSTEM​

Para incorporar un desarrollador o SRE externo al Workspace de forma segura sin revelar secretos de base de datos:

1. Enviar Nueva Invitación (Invite)​

  • Endpoint: POST /admin/users/sendinvitation
  • Payload (JSON):
{
  "email": "desarrollador.externo@empresa.com",
  "workspaceId": 1,
  "roleId": 2
}

2. Monitorear Invitaciones Pendientes​

  • Endpoint: GET /admin/users/invitations/pending/{workspaceId}
  • Descripción: Retorna la lista de correos que aún no han completado el flujo de onboarding.

3. Cancelar Invitación Emitida​

  • Endpoint: DELETE /admin/users/invitations/{email}/{workspaceId}
  • Descripción: Revoca inmediatamente el acceso del token de invitación enviado por correo.

03_ONBOARDING_COMPLETION​

Cuando un usuario invitado hace clic en el enlace de su correo, la interfaz le redirige a la pantalla de establecimiento de contraseña, la cual consume este endpoint de activación:

  • Endpoint: POST /admin/users/createUserInvitation
  • Cuerpo de Petición:
{
  "hashCode": "verification_hash_received_by_email",
  "password": "user_chosen_secure_password_string",
  "confirmPassword": "user_chosen_secure_password_string"
}
  • Efecto: Registra la contraseña de manera cifrada e introduce inmediatamente al usuario al Workspace como operador activo.