Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Tenant Registry

Retrieve a tenant

Example request using curl

curl -X GET {api-url}/registry/v1/currenttenant If the user is not logged in then the /definitions/TenantAnonymous is returned <br />User roles: admin, manager, editor, viewer, authenticatedVisitor, anonymous

get/registry/v1/currenttenant

Query parameters

fieldsstring

return these json fields ex ?fields=id,name

Response

Successful response

namestring
idstring

read-only - UUID of the tenant

_idstring required

DEPRECATED - read-only - UUID of the tenant. Use 'id' instead of _id

localestring

The locale the UI is shown in

defaultContentLocalestring

The default locale for content

contentLocalesstring[]

Array of locales the content can be in

lockedboolean

set to true if the tenant is 'locked' and should not have access to the system

watsonConfidenceLevelnumber double
maxUploadSizeinteger

Max upload size - should apply to files/images/audio/video unless useSingleUploadSize is false in which case the individual max uploads apply

useSingleUploadSizeboolean

Use the maxUploadSize to cover all uploads or use the individual max upload sizes

maxUploadSizeFilesinteger

Max upload size for files (if useSingleUploadSize is false)

maxUploadSizeImageinteger

Max upload size for images (if useSingleUploadSize is false)

maxUploadSizeVideointeger

Max upload size for videos (if useSingleUploadSize is false)

maxAuthorsinteger
maxContentItemsinteger

Max content items the tenant can have based on plan purchased

maxStorageSizeinteger

Max amount of storage the tenant has, based on plan purchased

maxDataTransferinteger

Max amount of data transfer the tenant has per month, based on plan purchased

isDAMEnabledboolean
tierstring

The tier of the product the tenant has purchased

ibmUniqueIdstring
isEdgeSideEnabledboolean
maxUserSessionsinteger

Max number of User sessions

configDeliveryCacheMaxageinteger

Used when setting Cache-Control max-age response header - value in seconds - can not be negative value

capabilitystring

indicates the capabilities supported by a tenant

corsWhiteliststring[]
ibmWcaobject

Properties for Campaign integration

edgeTokenstring

string to hold edge configuration of the tenant

importZipobject

Information on most recent zip imported