ZRM Docs
API ReferenceCredential Request

credentialRequest.create

Type: Mutation · Auth: Workspace-aware

Input

FieldTypeRequiredDefaultDescription
workspaceIdstringNoID of the associated workspace
credentialIdstringNoID of the associated credential
siteIdstringYesID of the associated site
systemIdstringNoID of the associated system
requestTypeenum(new, modify, revoke, renew)YesRequest type
requestedScopestringYesRequested scope
impactedSystemsunknownYes[]Impacted systems
requestedBystringYesRequested by
assignedApproverstringNoAssigned approver
statusenum(pending, approved, denied, cancelled)Yes"pending"Status
policyCheckResultunknownNoPolicy check result
approvedBystringNoApproved by
approvedAtstring.date-timeNoApproved at
deniedReasonstringNoDenied reason
notesstringNoNotes

Example

{
  "workspaceId": "550e8400-e29b-41d4-a716-446655440000",
  "credentialId": "550e8400-e29b-41d4-a716-446655440000",
  "siteId": "550e8400-e29b-41d4-a716-446655440000",
  "systemId": "550e8400-e29b-41d4-a716-446655440000",
  "requestType": "new",
  "requestedScope": "example",
  "impactedSystems": [],
  "requestedBy": "example",
  "status": "pending"
}

On this page