Domain Model
Credential Request
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string.uuid | Yes | — | Id |
| createdAt | string.date-time | Yes | — | Created at |
| updatedAt | string.date-time | Yes | — | Updated at |
| workspaceId | string | Yes | — | ID of the associated workspace |
| credentialId | string | No | — | ID of the associated credential |
| siteId | string | Yes | — | ID of the associated site |
| systemId | string | No | — | ID of the associated system |
| requestType | enum(new, modify, revoke, renew) | Yes | — | Request type |
| requestedScope | string | Yes | — | Requested scope |
| impactedSystems | unknown | Yes | — | Impacted systems |
| requestedBy | string | Yes | — | Requested by |
| assignedApprover | string | No | — | Assigned approver |
| status | enum(pending, approved, denied, cancelled) | Yes | — | Status |
| policyCheckResult | unknown | No | — | Policy check result |
| approvedBy | string | No | — | Approved by |
| approvedAt | string.date-time | No | — | Approved at |
| deniedReason | string | No | — | Denied reason |
| notes | string | No | — | Notes |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| workspaceId | string | No | — | ID of the associated workspace |
| credentialId | string | No | — | ID of the associated credential |
| siteId | string | Yes | — | ID of the associated site |
| systemId | string | No | — | ID of the associated system |
| requestType | enum(new, modify, revoke, renew) | Yes | — | Request type |
| requestedScope | string | Yes | — | Requested scope |
| impactedSystems | unknown | Yes | [] | Impacted systems |
| requestedBy | string | Yes | — | Requested by |
| assignedApprover | string | No | — | Assigned approver |
| status | enum(pending, approved, denied, cancelled) | Yes | "pending" | Status |
| policyCheckResult | unknown | No | — | Policy check result |
| approvedBy | string | No | — | Approved by |
| approvedAt | string.date-time | No | — | Approved at |
| deniedReason | string | No | — | Denied reason |
| notes | string | No | — | Notes |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| credentialId | string | No | — | ID of the associated credential |
| siteId | string | No | — | ID of the associated site |
| systemId | string | No | — | ID of the associated system |
| requestType | enum(new, modify, revoke, renew) | No | — | Request type |
| requestedScope | string | No | — | Requested scope |
| impactedSystems | unknown | No | — | Impacted systems |
| assignedApprover | string | No | — | Assigned approver |
| status | enum(pending, approved, denied, cancelled) | No | — | Status |
| policyCheckResult | unknown | No | — | Policy check result |
| approvedBy | string | No | — | Approved by |
| approvedAt | string.date-time | No | — | Approved at |
| deniedReason | string | No | — | Denied reason |
| notes | string | No | — | Notes |