Federation > Infra > Onboarding

Update Onboarding Preferences

Update user onboarding preferences to allow or reject site onboarding on
global manager.

Request:

Method:
PUT
URI Path(s):
/global-manager/api/v1/global-infra/sites/<site-id>/onboarding/preferences
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
SiteOnboardingPreference+

Example Request:

PUT /global-infra/sites/site-1/onboarding/user-preferences { "site_id": "site-1", "ignore_import": true, "resource_type": "SiteOnboardingPreference", "id": "site-1", "display_name": "site-1", "_create_user": "admin", "_create_time": 1581541290117, "_last_modified_user": "admin", "_last_modified_time": 1581541290117, "_system_owned": false, "_revision": 0 }

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
SiteOnboardingPreference+

Example Response:

{ "site_id": "site-1", "ignore_import": true, "resource_type": "SiteOnboardingPreference", "id": "site-1", "display_name": "site-1", "_create_user": "admin", "_create_time": 1581541290117, "_last_modified_user": "admin", "_last_modified_time": 1581541290117, "_system_owned": false, "_revision": 1 }

Required Permissions:

crud

Feature:

federated_site_onboarding

Additional Errors: