List tenant entitlements

client.Tenants.Entitlements.Get(ctx, tenantID) (*TenantEntitlements, error)

GET/tenants/{tenant_id}/entitlements

List of innate entitlements available for the Tenant.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

tenantID string

ReturnsExpand Collapse

type TenantEntitlements struct{…}

AllowAddSubdomain TenantEntitlementsAllowAddSubdomain

Type TenantEntitlementsAllowAddSubdomainType

Value bool

AllowAutoAcceptInvites TenantEntitlementsAllowAutoAcceptInvites

Type TenantEntitlementsAllowAutoAcceptInvitesType

Value bool

CNAMESetupAllowed TenantEntitlementsCNAMESetupAllowed

Type TenantEntitlementsCNAMESetupAllowedType

Value bool

CustomEntitlements []TenantEntitlementsCustomEntitlement

Allocation TenantEntitlementsCustomEntitlementsAllocation

One of the following:

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocation struct{…}

Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationType

Value int64

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocation struct{…}

Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationType

Value bool

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocation struct{…}

Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationType

Value unknownOptional

Feature TenantEntitlementsCustomEntitlementsFeature

Key string

MhsCertificateCount TenantEntitlementsMhsCertificateCount

Type TenantEntitlementsMhsCertificateCountType

Value int64

PartialSetupAllowed TenantEntitlementsPartialSetupAllowed

Type TenantEntitlementsPartialSetupAllowedType

Value bool

List tenant entitlements

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  tenantEntitlements, err := client.Tenants.Entitlements.Get(context.TODO(), "tenant_id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", tenantEntitlements.AllowAddSubdomain)
}

{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "allow_add_subdomain": {
      "type": "bool",
      "value": true
    },
    "allow_auto_accept_invites": {
      "type": "bool",
      "value": true
    },
    "cname_setup_allowed": {
      "type": "bool",
      "value": true
    },
    "custom_entitlements": [
      {
        "allocation": {
          "type": "max_count",
          "value": 0
        },
        "feature": {
          "key": "key"
        }
      }
    ],
    "mhs_certificate_count": {
      "type": "max_count",
      "value": 0
    },
    "partial_setup_allowed": {
      "type": "bool",
      "value": true
    }
  },
  "success": true
}

Returns Examples

{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "allow_add_subdomain": {
      "type": "bool",
      "value": true
    },
    "allow_auto_accept_invites": {
      "type": "bool",
      "value": true
    },
    "cname_setup_allowed": {
      "type": "bool",
      "value": true
    },
    "custom_entitlements": [
      {
        "allocation": {
          "type": "max_count",
          "value": 0
        },
        "feature": {
          "key": "key"
        }
      }
    ],
    "mhs_certificate_count": {
      "type": "max_count",
      "value": 0
    },
    "partial_setup_allowed": {
      "type": "bool",
      "value": true
    }
  },
  "success": true
}