Credential Rotation

Rotate Credential

Changed on

Stage a site-wide credential rotation: publish a new rotate-to secret and bump the site-wide target version. Devices converge to the new version asynchronously; poll the status endpoint to observe convergence. Equivalent to nico-admin-cli credential rotate.

User must have authorization role with PROVIDER_ADMIN suffix.

post/v2/org/{org}/nico/credential/rotation

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/credential/rotation
  • Auth
    HTTP bearer

Request body

siteIdstring uuid required

ID of the Site whose credential family is rotated.

credentialType'BMC' | 'HostUEFI' | 'DPUUEFI' | 'NVOS' | 'LockdownIKM' required

Credential family to rotate.

passwordstring

Explicit rotate-to password. When omitted, a strong password is auto-generated. Never returned.

reasonstring

Free-form operator note recorded with the rotation. Must not contain secrets.

Response

Credential rotation was staged

credentialType'BMC' | 'HostUEFI' | 'DPUUEFI' | 'NVOS' | 'LockdownIKM' required

Credential family that was rotated.

targetVersioninteger required

Newly published site-wide target version that devices converge to.

startedstring date-time nullable

When the rotation was staged.

Changes

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

  • 78f3b35615a5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status