API ReferenceTenant Account

Retrieve all Tenant Accounts

View as Markdown
Retrieve all Tenant Accounts. 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 ```

Path parameters

orgstringRequired

Query parameters

infrastructureProviderIdstringOptionalformat: "uuid"
Filter TenantAccounts by Infrastructure Provider ID
tenantIdstringOptionalformat: "uuid"
Filter TenantAccounts 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

X-Paginationstring
Pagination result in JSON format

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

403
Forbidden Error