Update Tenant Account

PATCH

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

PATCH

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

$ curl -X PATCH https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/tenant/account/accountId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

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

Update a Tenant Account.

Can be used to accept an invitation sent by an Infrastructure Provider.

Org must have a Tenant entity whose ID matches the tenantId of the Tenant Account object. User must have authorization role with TENANT_ADMIN suffix. Can only update a Tenant Account that has Invited status.

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

accountIdstringRequiredformat: "uuid"

ID of the Tenant Account

Request

No parameters are required; an empty request body is sufficient.

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

400

Bad Request Error

403

Forbidden Error