Skip to content

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

NombreTipoRequeridoDescripción
companyIdstring
{
"userId": "00000000-0000-0000-0000-000000000000",
"roleId": "00000000-0000-0000-0000-000000000000"
}

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"
}

Listar miembros de la empresa

Lista de miembros

NombreTipoRequeridoDescripción
companyIdstring

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

NombreTipoRequeridoDescripción
companyIdstring
memberIdstring
{
"roleId": "00000000-0000-0000-0000-000000000000"
}

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

NombreTipoRequeridoDescripción
companyIdstring
memberIdstring

Miembro removido exitosamente


CampoTipoRequeridoDescripción
userIdstring (uuid)
roleIdstring (uuid)
CampoTipoRequeridoDescripción
idstring (uuid)
userIdstring (uuid)
companyIdstring (uuid)
roleRoleResponse
joinedAtstring (date-time)
CampoTipoRequeridoDescripción
roleIdstring (uuid)