CertificationRequiredByRole

A request or response body; the type column links to the schemas it refers to.

CertificationRequiredByRole

FieldTypeRequiredDescription
link_idstring (uuid)yes—
role_idstring (uuid)yes—
role_namestringyes—
department_idstring (uuid)yes—
department_namestringyes—
organization_idstring (uuid)yes—
organization_namestringyes—
recert_schemestringyes

one of "none" | "anniversary" | "fixed_calendar"

recert_interval_monthsnumber | nullyes—
recert_anchor_monthnumber | nullyes—
recert_anchor_daynumber | nullyes—
initial_due_atstring (date-time) | nullyes

The link's role-level initial due date; null when the role sets no deadline.

jsonExample
{
  "link_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "role_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "role_name": "string",
  "department_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "department_name": "string",
  "organization_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "organization_name": "string",
  "recert_scheme": "none",
  "recert_interval_months": 0,
  "recert_anchor_month": 0,
  "recert_anchor_day": 0,
  "initial_due_at": "2026-01-01T00:00:00.000Z"
}