API ReferenceTenant

Retrieve Tenant for current Org

View as Markdown

Retrieve Tenant entity for current Org.

User must have FORGE_TENANT_ADMIN authorization 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

Response

OK
idstringRead-onlyformat: "uuid"
Unique ID of the Tenant
orgstring

Name/external ID of Tenant’s organization

orgDisplayNamestring
Display name of Tenant's organization
createddatetimeRead-only

Date/time the Tenant was created

updateddatetime

Date/time when Tenant was last updated

capabilitiesobject

Features that are enabled/disabled for Tenant

Errors

403
Forbidden Error