Members
Members
Section titled “Members”Administración de miembros dentro de una empresa. Asignación y modificación de roles.
POST /api/companies/{companyId}/members/v1
Section titled “POST /api/companies/{companyId}/members/v1”Agregar miembro a la empresa
Miembro agregado
Parámetros
Section titled “Parámetros”| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
companyId | string | ✅ |
Request Body (requerido ✅)
Section titled “Request Body (requerido ✅)”{ "userId": "00000000-0000-0000-0000-000000000000", "roleId": "00000000-0000-0000-0000-000000000000" }Respuestas
Section titled “Respuestas”Miembro agregado exitosamente
{ "id": "00000000-0000-0000-0000-000000000000", "userId": "00000000-0000-0000-0000-000000000000", "companyId": "00000000-0000-0000-0000-000000000000", "role": { "id": "00000000-0000-0000-0000-000000000000", "companyId": "00000000-0000-0000-0000-000000000000", "name": "name", "isPredefined": true, "permissions": [], "createdAt": "2024-01-15T10:00:00Z", "updatedAt": "2024-01-15T10:00:00Z" }, "joinedAt": "2024-01-15T10:00:00Z" }GET /api/companies/{companyId}/members/v1
Section titled “GET /api/companies/{companyId}/members/v1”Listar miembros de la empresa
Lista de miembros
Parámetros
Section titled “Parámetros”| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
companyId | string | ✅ |
Respuestas
Section titled “Respuestas”Lista de miembros
{ "id": "00000000-0000-0000-0000-000000000000", "userId": "00000000-0000-0000-0000-000000000000", "companyId": "00000000-0000-0000-0000-000000000000", "role": { "id": "00000000-0000-0000-0000-000000000000", "companyId": "00000000-0000-0000-0000-000000000000", "name": "name", "isPredefined": true, "permissions": [], "createdAt": "2024-01-15T10:00:00Z", "updatedAt": "2024-01-15T10:00:00Z" }, "joinedAt": "2024-01-15T10:00:00Z" }PATCH /api/companies/{companyId}/members/v1/{memberId}
Section titled “PATCH /api/companies/{companyId}/members/v1/{memberId}”Cambiar rol de un miembro
Parámetros
Section titled “Parámetros”| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
companyId | string | ✅ | |
memberId | string | ✅ |
Request Body (requerido ✅)
Section titled “Request Body (requerido ✅)”{ "roleId": "00000000-0000-0000-0000-000000000000" }Respuestas
Section titled “Respuestas”Rol del miembro actualizado
{ "id": "00000000-0000-0000-0000-000000000000", "userId": "00000000-0000-0000-0000-000000000000", "companyId": "00000000-0000-0000-0000-000000000000", "role": { "id": "00000000-0000-0000-0000-000000000000", "companyId": "00000000-0000-0000-0000-000000000000", "name": "name", "isPredefined": true, "permissions": [], "createdAt": "2024-01-15T10:00:00Z", "updatedAt": "2024-01-15T10:00:00Z" }, "joinedAt": "2024-01-15T10:00:00Z" }DELETE /api/companies/{companyId}/members/v1/{memberId}
Section titled “DELETE /api/companies/{companyId}/members/v1/{memberId}”Remover miembro de la empresa
Parámetros
Section titled “Parámetros”| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
companyId | string | ✅ | |
memberId | string | ✅ |
Respuestas
Section titled “Respuestas”Miembro removido exitosamente
Schemas
Section titled “Schemas”AddMemberRequest
Section titled “AddMemberRequest”| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
userId | string (uuid) | ✅ | |
roleId | string (uuid) | ✅ |
MemberResponse
Section titled “MemberResponse”| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
id | string (uuid) | ❌ | |
userId | string (uuid) | ❌ | |
companyId | string (uuid) | ❌ | |
role | RoleResponse | ❌ | |
joinedAt | string (date-time) | ❌ |
UpdateMemberRoleRequest
Section titled “UpdateMemberRoleRequest”| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
roleId | string (uuid) | ✅ |