Create Tenant Account

POST

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/tenant/account

POST

/v2/org/:org/nico/tenant/account

curl -X POST https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/tenant/account \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "tenantOrg": "rf43bbtnb9c5",
  "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf"
}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
  "infrastructureProviderOrg": "xskkpgqpeakn",
  "tenantId": null,
  "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": "Pending",
  "statusHistory": [
    {
      "status": "Pending",
      "message": "Request received, pending processing",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}

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.

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.

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

``` 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

Request

This endpoint expects an object.

tenantOrgstringRequiredformat: "^[A-Za-z0-9_-]+$">=1 character

Must be a valid Org name

infrastructureProviderIdstringOptionalformat: "uuid"Deprecated

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.

Response

Created

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