Update Tenant Account

View as Markdown

Update a Tenant Account.

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

Org must have a tenant entity whose ID matches the tenantId of the Tenant Account object. User must have FORGE_TENANT_ADMIN role. Can only update a TenantAccount 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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired
accountIdstringRequired

Request

No params needed, an empty request body will suffice.

Response

OK
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

400
Bad Request Error
403
Forbidden Error