Set up a fresh installed Jamf Pro Server for FedRAMP (v2, self-registering Keycloak config)

post

https://yourServer.jamfcloud.com/api/v2/system/fedramp-initialize

Fresh-install initialization of a FedRAMP instance that accepts the raw Keycloak (OIDC broker)
configuration directly instead of a pre-provisioned configUuid. Registers the configuration with
oidc-authentication-service, persists the returned configuration UUID, creates the initial federated
account, records the activation code and Jamf Pro URL, acknowledges the EULA, and enables FedRAMP SSO.
Run-once operation: allowed only on a FedRAMP instance, while no JSS users exist, the broker is
enabled, and no broker UUID is already stored. Non-FedRAMP instances are rejected with INVALID_STATE.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

FedRAMP broker initialization data (v2, raw Keycloak configuration)

activationCode

string

length between 39 and 39

institutionName

string

required

length ≥ 1

eulaAccepted

boolean

required

username

string

required

length ≥ 1

Federated user OIDC username to create

string

required

Federated user OIDC email to create

jssUrl

string

required

length ≥ 1

discoveryUrl

string

required

HTTPS OIDC discovery document URL for the Keycloak broker

clientId

string

required

length ≥ 1

clientSecret

password

OIDC client secret. Exactly one of clientSecret or privateKeyJwt must be supplied; the client auth method is derived from which one is present. Redacted from all logs.

privateKeyJwt

password

Private key JWT. Exactly one of clientSecret or privateKeyJwt must be supplied; the client auth method is derived from which one is present. Redacted from all logs.

productUsernameClaim

string

productUserMapping

string

Defaults to EMAIL when not provided.

scopes

array of strings

Defaults to ["openid", "profile", "email"] when not provided.

scopes

Responses

202

Broker configuration has been registered and its UUID stored

Language

Credentials

Loading…

Response

Choose an example:

application/json