GuidesRecipesAPI ReferenceChangelog
Log In
Changelog
Added

11.33 Additions

What's new

POST /v1/system/fedramp-initialize — new

Performs the one-time initialization of a freshly installed FedRAMP instance. In a single call it creates the initial federated account, records the activation code and Jamf Pro URL, acknowledges the EULA, stores the tenant's OIDC broker (Keycloak) configuration UUID, and enables FedRAMP SSO. It joins the existing family of fresh-install initialization endpoints and, like them, is gated by the activation code rather than by a privilege.

This is a run-once operation. It succeeds only on a FedRAMP instance where no Jamf Pro users exist yet, the broker is enabled, and no broker UUID is already stored. A non-FedRAMP instance is rejected with INVALID_STATE.

No privilege is required. The call authenticates with the activation code and runs before any user account exists.

Request: FedRampBrokerInitializeV1 — activationCode, configUuid, email, eulaAccepted, institutionName, jssUrl, and username are all required.

{
  "activationCode": "VFAB-YDAB-DFAB-UDAB-DEAB-EFAB-ABAB-DEAB",
  "institutionName": "Jamf",
  "configUuid": "11111111-2222-3333-4444-555555555555",
  "eulaAccepted": true,
  "username": "admin",
  "email": "[email protected]",
  "jssUrl": "https://jamf.jamfcloud.com"
}
StatusMeaning
202The broker configuration UUID has been stored and initialization is complete.
400The request could not be processed. Returned codes are INVALID_ACTIVATION_CODE (the activation code is invalid or expired), INVALID_STATE (the instance is not in a state that allows broker initialization — for example, it is not a FedRAMP instance, or it has already been initialized), INVALID_FIELD (a field failed validation), and FIELD_REQUIRED (a required field was missing). The offending field name is included in the response where applicable.