GET/v1/access-control/maintenanceList Access Control Maintenance
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
q | query | string o nulo | No |
includeInactive | query | boolean | No |
tenant_id | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | AccessControlMaintenanceOut |
| 422 | Error de validación | HTTPValidationError |
Get Current Access
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | CurrentAccessOut |
POST/v1/access-control/rolesCreate Access Role
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenant_id | query | string o nulo | No |
Cuerpo obligatorio AccessRoleIn
| Campo | Tipo | Obl. |
|---|
code | string | Sí |
name | string | Sí |
description | string o nulo | No |
status | string | No |
grants | lista de ModuleGrantIn | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | AccessRoleOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/v1/access-control/roles/{role_id}Update Access Role
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
role_id | path | string | Sí |
tenant_id | query | string o nulo | No |
Cuerpo obligatorio AccessRoleIn
| Campo | Tipo | Obl. |
|---|
code | string | Sí |
name | string | Sí |
description | string o nulo | No |
status | string | No |
grants | lista de ModuleGrantIn | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | AccessRoleOut |
| 422 | Error de validación | HTTPValidationError |
POST/v1/access-control/usersCreate Access Control User
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenant_id | query | string o nulo | No |
Cuerpo obligatorio AccessUserUpsertIn
| Campo | Tipo | Obl. |
|---|
fullName | string | Sí |
email | string o nulo | No |
phone | string o nulo | No |
cedula | string o nulo | No |
role | string | No |
roles | lista de string | No |
branchId | string o nulo | No |
isActive | boolean | No |
credentialType | string | No |
password | string o nulo | No |
resetPassword | string o nulo | No |
accessCode | string o nulo | No |
regenerateAccessCode | boolean | No |
accessRoleIds | lista de string | No |
directGrants | lista de ModuleGrantIn | No |
directRevocations | lista de ModuleGrantIn | No |
branchScopeIds | lista de string | No |
areaScopeKeys | lista de string | No |
unitScopeKeys | lista de string | No |
accessStatus | string | No |
suspensionReason | string o nulo | No |
auditReason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | AccessUserOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/v1/access-control/users/{user_id}Update Access Control User
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
user_id | path | string | Sí |
tenant_id | query | string o nulo | No |
Cuerpo obligatorio AccessUserUpsertIn
| Campo | Tipo | Obl. |
|---|
fullName | string | Sí |
email | string o nulo | No |
phone | string o nulo | No |
cedula | string o nulo | No |
role | string | No |
roles | lista de string | No |
branchId | string o nulo | No |
isActive | boolean | No |
credentialType | string | No |
password | string o nulo | No |
resetPassword | string o nulo | No |
accessCode | string o nulo | No |
regenerateAccessCode | boolean | No |
accessRoleIds | lista de string | No |
directGrants | lista de ModuleGrantIn | No |
directRevocations | lista de ModuleGrantIn | No |
branchScopeIds | lista de string | No |
areaScopeKeys | lista de string | No |
unitScopeKeys | lista de string | No |
accessStatus | string | No |
suspensionReason | string o nulo | No |
auditReason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | AccessUserOut |
| 422 | Error de validación | HTTPValidationError |
DELETE/v1/access-control/users/{user_id}Delete Access Control User
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
user_id | path | string | Sí |
tenant_id | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 204 | Respuesta correcta | — |
| 422 | Error de validación | HTTPValidationError |
GET/v1/access-control/users/{user_id}/historyList Access Control User History
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
user_id | path | string | Sí |
tenant_id | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de AccessAuditEntryOut |
| 422 | Error de validación | HTTPValidationError |