Retrieve all Tenant Accounts

GET

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

GET

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

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

1 [
2   {
3     "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
4     "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
5     "infrastructureProviderOrg": "xskkpgqpeakn",
6     "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
7     "tenantOrg": "rf43bbtnb9c5",
8     "tenantContact": {
9       "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
10       "email": "janed@nvidia.com",
11       "firstName": "Jane",
12       "lastName": "Doe",
13       "created": "2019-08-24T14:15:22Z",
14       "updated": "2019-08-24T14:15:22Z"
15     },
16     "allocationCount": 0,
17     "status": "Pending",
18     "statusHistory": [
19       {
20         "status": "Pending",
21         "message": "Request received, pending processing",
22         "created": "2019-08-24T14:15:22Z",
23         "updated": "2019-08-24T14:15:22Z"
24       }
25     ],
26     "created": "2019-08-24T14:15:22Z",
27     "updated": "2019-08-24T14:15:22Z"
28   }
29 ]

Retrieve all Tenant Accounts for the org.

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.

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

Query parameters

infrastructureProviderIdstringOptionalformat: "uuid"Deprecated

Filter Tenant Accounts by Infrastructure Provider ID. Deprecated: Infrastructure Provider is now inferred from the org’s membership.

tenantIdstringOptionalformat: "uuid"

Filter Tenant Accounts by Tenant ID

querystringOptional

Search string to filter Tenant Accounts by account number, tenant org, or tenant org display name

includeRelationenumOptional

Related entity to expand

Allowed values:

pageNumberintegerOptional>=1Defaults to 1

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

Response headers

Response

idstringRead-onlyformat: "uuid"

Unique UUID v4 identifier for the Tenant Account

infrastructureProviderIdstringformat: "uuid"

ID of the Infrastructure Provider

infrastructureProviderOrgstring

Organization name of the Infrastructure Provider

tenantIdstring or nullformat: "uuid"

ID of the Tenant

tenantOrgstring or null

Org of the Tenant

tenantContactobject

Contact user for the Tenant

allocationCountinteger

Number of Allocations for the Tenant Account

statusenum

Status of the Tenant Account

statusHistorylist of objects

Chronological status history for the Tenant Account

createddatetimeRead-only

Date/time when the Tenant Account was created

updateddatetimeRead-only

Date/time when the Tenant Account was last updated

Errors

403

Forbidden Error