API ReferenceTenant Account

Update Tenant Account

View as Markdown
Update a Tenant Account. Tenant Admins may accept an invitation sent by an Infrastructure Provider by supplying `tenantContactId`. Provider Admins may replace `siteCapabilities` to configure the Tenant Account default and overrides for specific Sites. When `siteCapabilities` is sent, it must be non-empty, include exactly one entry with empty or omitted `siteIds`, and must not repeat any `siteId` across entries. Requests containing both `tenantContactId` and `siteCapabilities` are rejected with 400. Org must have a Tenant entity whose ID matches the `tenantId` of the Tenant Account object when accepting an invite. User must have authorization role with `TENANT_ADMIN` suffix to accept; `PROVIDER_ADMIN` suffix to update `siteCapabilities`. Tenant Admins can only update a Tenant Account that has `Invited` status.

Authentication

AuthorizationBearer
``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired
Name of the Org
accountIdstringRequiredformat: "uuid"
ID of the Tenant Account

Request

Tenant invite acceptance or Provider Admin site capability update.
tenantContactIdstringOptionalformat: "uuid"

Tenant Admin invite acceptance; must match the requesting user

siteCapabilitieslist of objectsOptional

Provider Admin replace payload for TargetedInstanceCreation configuration. Required to be non-empty when sent.

PATCH uses replace semantics: previously configured per-site overrides whose siteId is omitted from the new payload are cleared.

Server validation rules:

  • must contain at least one entry
  • must contain exactly one entry with omitted or empty siteIds
  • must not repeat any siteId across entries
  • every provided siteId must be a valid Site UUID
  • every provided siteId must identify a Site associated with the Tenant and owned by the Tenant Account’s Infrastructure Provider; otherwise the server rejects the request with 400

Response

OK
idstringOptionalRead-onlyformat: "uuid"
Unique UUID v4 identifier for the Tenant Account
infrastructureProviderIdstringOptionalformat: "uuid"
ID of the Infrastructure Provider
infrastructureProviderOrgstringOptional
Organization name of the Infrastructure Provider
tenantIdstring or nullOptionalformat: "uuid"
ID of the Tenant
tenantOrgstring or nullOptional
Org of the Tenant
tenantContactobjectOptional
Contact user for the Tenant
allocationCountintegerOptional
Number of Allocations for the Tenant Account
statusenumOptional
Status of the Tenant Account
statusHistorylist of objectsOptional
Chronological status history for the Tenant Account
deprecationslist of objectsOptional
Deprecations active for this resource. Returned only if there are active deprecations.
createddatetimeOptionalRead-only

Date/time when the Tenant Account was created

updateddatetimeOptionalRead-only

Date/time when the Tenant Account was last updated

siteCapabilitieslist of objectsOptional

Provider-scoped TargetedInstanceCreation settings for this Tenant Account. Replaces the deprecated tenant-level capabilities.targetedInstanceCreation attribute.

When present on a Tenant Account response, the array always includes one entry with omitted siteIds derived from TenantAccount.config, followed by zero or more entries with siteIds for per-site overrides that differ from the account default.

Errors

400
Bad Request Error
403
Forbidden Error