NVnvidia
Tenant Account

Update Tenant Account

Changed on

Update a Tenant Account.

Tenant Admins may accept an invitation sent by an Infrastructure Provider by supplying tenantContactId.

Provider Admins may replace one or more capabilities through 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.

patch/v2/org/{org}/nico/tenant/account/{accountId}

Request

Request body

tenantContactIdstring uuid

Tenant Admin invite acceptance; must match the requesting user

Example request

{
  "tenantContactId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Response

OK

idstring uuid

Unique UUID v4 identifier for the Tenant Account

infrastructureProviderIdstring uuid

ID of the Infrastructure Provider

infrastructureProviderOrgstring

Organization name of the Infrastructure Provider

tenantIdstring uuid nullable

ID of the Tenant

tenantOrgstring nullable

Org of the Tenant

allocationCountinteger

Number of Allocations for the Tenant Account

status'Pending' | 'Invited' | 'Ready' | 'Error'

Status values for Tenant Account objects

createdstring date-time

Date/time when the Tenant Account was created

updatedstring date-time

Date/time when the Tenant Account was last updated

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
  "infrastructureProviderOrg": "xskkpgqpeakn",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "tenantOrg": "rf43bbtnb9c5",
  "tenantContact": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "email": "janed@nvidia.com",
    "firstName": "Jane",
    "lastName": "Doe",
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  },
  "allocationCount": 0,
  "status": "Ready",
  "statusHistory": [
    {
      "status": "Ready",
      "message": "Account ready, Tenant accepted invite",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "siteCapabilities": [
    {
      "siteIds": [],
      "targetedInstanceCreation": true,
      "crossTenantInterfaceCreation": false
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}

Changes

  • 0b509c1d7b6cRevision changes
    • info

      added the new optional request property //

    • info

      the request property // became optional

    • info

      the response property // became required for the status

    • info

      added the required property // to the response with the status

  • 293dc126ab73Revision changes
    • breaking

      added subschema #2 to the response property oneOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • 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