Retrieve Tenant Account | NVIDIA Infra Controller

curl https://carbide-rest-api.carbide.svc.cluster.local/v2/org/org/carbide/tenant/account/accountId \
     -H "Authorization: Bearer <token>"

{
  "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": 2,
  "status": "Ready",
  "statusHistory": [
    {
      "status": "Ready",
      "message": "Account ready, Tenant accepted invite",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    },
    {
      "status": "Invited",
      "message": "Request received, pending Tenant acceptance",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}

Retrieve a Tenant Account by ID

Either infrastructureProviderId or tenantId query param must be specified.

If infrastructureProviderId query param is provided, then org must have an Infrastructure Provider entity and its ID should match the query param value. User must have FORGE_PROVIDER_ADMIN role.

If tenantId query param is provided, then org must have a Tenant entity and its ID should match the query param value. User must have FORGE_TENANT_ADMIN role.

Retrieve a Tenant Account by ID Either `infrastructureProviderId` or `tenantId` query param must be specified. If `infrastructureProviderId` query param is provided, then org must have an Infrastructure Provider entity and its ID should match the query param value. User must have `FORGE_PROVIDER_ADMIN` role. If `tenantId` query param is provided, then org must have a Tenant entity and its ID should match the query param value. User must have `FORGE_TENANT_ADMIN` role.

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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired

accountIdstringRequired

Query parameters

infrastructureProviderIdstringOptionalformat: "uuid"

Filter Tenant Accounts by Infrastructure Provider ID

tenantIdstringOptionalformat: "uuid"

Filter Tenant Accounts by Tenant ID

includeRelationenumOptional

Related entity to expand

Allowed values:

Response

idstringRead-onlyformat: "uuid"

infrastructureProviderIdstringformat: "uuid"

infrastructureProviderOrgstring

tenantIdstring or nullformat: "uuid"

tenantOrgstring or null

tenantContactobject

Details of the user collected from authentication tokens

allocationCountinteger

statusenum

Status values for Tenant Account objects

Allowed values:

statusHistorylist of objects

createddatetimeRead-only

updateddatetimeRead-only

Errors

403

Forbidden Error