Skip to content
Start here

Entitlements

List tenant entitlements
client.tenants.entitlements.get(stringtenantId, RequestOptionsoptions?): TenantEntitlements { allow_add_subdomain, allow_auto_accept_invites, cname_setup_allowed, 3 more }
GET/tenants/{tenant_id}/entitlements
ModelsExpand Collapse
TenantEntitlements { allow_add_subdomain, allow_auto_accept_invites, cname_setup_allowed, 3 more }
allow_add_subdomain: AllowAddSubdomain { type, value }
type: "bool"
value: boolean
allow_auto_accept_invites: AllowAutoAcceptInvites { type, value }
type: "bool"
value: boolean
cname_setup_allowed: CNAMESetupAllowed { type, value }
type: "bool"
value: boolean
custom_entitlements: Array<CustomEntitlement> | null
allocation: OrganizationsAPIMaxCountAllocation { type, value } | OrganizationsAPIBoolAllocation { type, value } | OrganizationsAPINullAllocation { type, value }
One of the following:
OrganizationsAPIMaxCountAllocation { type, value }
type: "max_count"
value: number
OrganizationsAPIBoolAllocation { type, value }
type: "bool"
value: boolean
OrganizationsAPINullAllocation { type, value }
type: ""
value?: unknown
feature: Feature { key }
key: string
mhs_certificate_count: MhsCertificateCount { type, value }
type: "max_count"
value: number
partial_setup_allowed: PartialSetupAllowed { type, value }
type: "bool"
value: boolean