v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB

Tenant Account

Create Tenant Account

Create a Tenant Account.

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix. The Infrastructure Provider is inferred from the caller's org; the deprecated infrastructureProviderId request body field is optional and, when provided, must match the org's Infrastructure Provider.

Infrastructure Provider can create a Tenant Account by specifying the Tenant's UUID or Tenant's org name. This sets the Tenant Account status to "Invited". The Tenant can then view the account information and accept the account by updating the Tenant Account.

post/v2/org/{org}/nico/tenant/account

Request body

infrastructureProviderIdstring uuid

Deprecated; inferred from the caller's org Infrastructure Provider when omitted. When provided, the value must match the org's Infrastructure Provider — mismatched values are rejected with 400.

tenantOrgstring required

Must be a valid Org name

Example request

{
  "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
  "tenantOrg": "rf43bbtnb9c5"
}

Response

Created

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": [
    {
      "targetedInstanceCreation": true
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}