Skip to main content

entitlements

Creates, updates, deletes, gets or lists an entitlements resource.

Overview

Nameentitlements
TypeResource
Idcloudflare.tenants.entitlements

Fields

The following fields are returned by SELECT queries:

The request has succeeded.

NameDatatypeDescription
allow_add_subdomainobject
allow_auto_accept_invitesobject
cname_setup_allowedobject
custom_entitlementsarray
mhs_certificate_countobject
partial_setup_allowedobject

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselecttenant_idList of innate entitlements available for the Tenant.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
tenant_idstring

SELECT examples

List of innate entitlements available for the Tenant.

SELECT
allow_add_subdomain,
allow_auto_accept_invites,
cname_setup_allowed,
custom_entitlements,
mhs_certificate_count,
partial_setup_allowed
FROM cloudflare.tenants.entitlements
WHERE tenant_id = '{{ tenant_id }}' -- required
;