--- title: "Retrieve Tenant Account" method: GET path: "/v2/org/{org}/nico/tenant/account/{accountId}" tags: ["Tenant Account"] --- # Retrieve Tenant Account `GET /v2/org/{org}/nico/tenant/account/{accountId}` ## Request - Base URL: `https://nico-rest-api.nico.svc.cluster.local` - URL: `https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/tenant/account/{accountId}` - Auth: HTTP bearer Retrieve a Tenant Account by ID. The Infrastructure Provider and Tenant are inferred from the org's membership. User must have authorization role with `PROVIDER_ADMIN`, `PROVIDER_VIEWER`, or `TENANT_ADMIN` suffix. ## Query parameters - `infrastructureProviderId` string, uuid - `tenantId` string, uuid - `includeRelation` 'InfrastructureProvider' | 'Tenant' ## Response `200` OK - TenantAccount: Associates a Tenant with an Infrastructure Provider - `id` string, uuid: Unique UUID v4 identifier for the Tenant Account - `infrastructureProviderId` string, uuid: ID of the Infrastructure Provider - `infrastructureProviderOrg` string: Organization name of the Infrastructure Provider - `tenantId` string, uuid, nullable: ID of the Tenant - `tenantOrg` string, nullable: Org of the Tenant - `tenantContact` User: Details of the user collected from authentication tokens - `id` string, uuid: Unique identifier for the given user. - `email` string, email, nullable: Email used by the user to register with NGC - `firstName` string, nullable: First name of the user - `lastName` string, nullable: Surname of the user - `created` string, date-time: The date that the user was created. - `updated` string, date-time: Date/time when the user was last updated in NICo - `allocationCount` integer: Number of Allocations for the Tenant Account - `status` 'Pending' | 'Invited' | 'Ready' | 'Error': Status values for Tenant Account objects - `statusHistory` StatusDetail[]: Chronological status history for the Tenant Account - `status` string: State of the associated entity at a particular time - `message` string, nullable: Description of the state and cause/remedy in case of error - `created` string, date-time: Date/time when the associated entity assumed the status - `updated` string, date-time: Date/time when the associated entity was last observed with this status - `deprecations` Deprecation[]: Deprecations active for this resource. Returned only if there are active deprecations. - `attribute` string, nullable: Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated. - `queryParam` string, nullable: Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated. - `endpoint` string, nullable: API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated. - `replacedBy` string, nullable: Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available. - `takeActionBy` string, date-time: Date/time by which clients should migrate away from the deprecated API surface - `notice` string: Message describing the deprecation - `created` string, date-time: Date/time when the Tenant Account was created - `updated` string, date-time: Date/time when the Tenant Account was last updated - `siteCapabilities` TenantAccountSiteCapability[]: 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. - `siteIds` string[]: Sites to configure. An omitted or empty array identifies the Tenant Account default entry. Each value must be a valid Site UUID, may appear only once across all siteCapabilities entries in the same request, and must be owned by the Tenant Account's Infrastructure Provider; otherwise the server rejects the request with 400. - `targetedInstanceCreation` boolean, required: Whether TargetedInstanceCreation is enabled for the Tenant Account default or listed Sites. When true, Tenant Admins with a Ready Tenant Account on the Site's Infrastructure Provider may create Instances by Machine ID and perform related privileged actions on that Site. ## Other responses - `403`: Error response when user is not authorized to call an endpoint or retrieve/modify objects ## Changes - **2026-10-15** `293dc126ab73`: 2 breaking, 6 warning, 1 info - added `#/components/schemas/User, subschema #2` to the `tenantContact` response property `oneOf` list for the response status `200` - the `tenantContact` response's property type changed from `object` to no type for status `200` - removed the optional property `tenantContact/created` from the response with the `200` status - removed the optional property `tenantContact/email` from the response with the `200` status - …5 more - **2026-09-29** `78f3b35615a5`: 1 info - added the optional property `retryable` to the response with the `403` status - **2026-07-30** `dfd4cab0a8b1`: 1 info - added the optional property `siteCapabilities` to the response with the `200` status - **2026-06-24** `2aec58e1f8ab`: 1 info - added the optional property `deprecations` to the response with the `200` status - **2026-06-11** `1e088fab5547`: 2 info - `query` request parameter `infrastructureProviderId` was deprecated - `query` request parameter `tenantId` was deprecated [Operation history](https://skmtc.dev/nvidia/apis/nvidia-infra-controller-rest-api/changes/v2/org/:org/nico/tenant/account/:accountId/get.md) --- [API](https://skmtc.dev/nvidia/apis/nvidia-infra-controller-rest-api.md) - [All operations](https://skmtc.dev/nvidia/apis/nvidia-infra-controller-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nvidia/apis/nvidia-infra-controller-rest-api/revisions/db15b7308121?raw)