Skip to content
Cloudflare API
Start here
API Reference

Organizations

resource cloudflare_organization

required Expand Collapse
name: String
optional Expand Collapse
profile?: Attributes
business_address: String
business_email: String
business_name: String
business_phone: String
external_metadata: String
parent?: Attributes
id: String
name: String
computed Expand Collapse
id: String
create_time: Time
meta: Attributes
flags: Attributes

Enable features for Organizations.

account_creation: String
account_deletion: String
account_migration: String
account_mobility: String
sub_org_creation: String
managed_by: String

cloudflare_organization

resource "cloudflare_organization" "example_organization" {
  name = "name"
  parent = {
    id = "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8"
  }
  profile = {
    business_address = "business_address"
    business_email = "business_email"
    business_name = "business_name"
    business_phone = "business_phone"
    external_metadata = "external_metadata"
  }
}

data cloudflare_organization

optional Expand Collapse
organization_id?: String
filter?: Attributes
id?: List[String]

Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value.

containing?: Attributes
account?: String

Filter the list of organizations to the ones that contain this particular account.

organization?: String

Filter the list of organizations to the ones that contain this particular organization.

user?: String

Filter the list of organizations to the ones that contain this particular user.

IMPORTANT: Just because an organization "contains" a user is not a representation of any authorization or privilege to manage any resources therein. An organization "containing" a user simply means the user is managed by that organization.

name?: Attributes
contains?: String

(case-insensitive) Filter the list of organizations to where the name contains a particular string.

ends_with?: String

(case-insensitive) Filter the list of organizations to where the name ends with a particular string.

starts_with?: String

(case-insensitive) Filter the list of organizations to where the name starts with a particular string.

page_size?: Int64

The amount of items to return. Defaults to 10.

page_token?: String

An opaque token returned from the last list response that when provided will retrieve the next page.

Parameters used to filter the retrieved list must remain in subsequent requests with a page token.

parent?: Attributes
id?: String

Filter the list of organizations to the ones that are a sub-organization of the specified organization.

"null" is a valid value to provide for this parameter. It means "where an organization has no parent (i.e. it is a 'root' organization)."

computed Expand Collapse
id: String
create_time: Time
name: String
meta: Attributes
flags: Attributes

Enable features for Organizations.

account_creation: String
account_deletion: String
account_migration: String
account_mobility: String
sub_org_creation: String
managed_by: String
parent: Attributes
id: String
name: String
profile: Attributes
business_address: String
business_email: String
business_name: String
business_phone: String
external_metadata: String

cloudflare_organization

data "cloudflare_organization" "example_organization" {
  organization_id = "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8"
}

data cloudflare_organizations

optional Expand Collapse
page_size?: Int64

The amount of items to return. Defaults to 10.

page_token?: String

An opaque token returned from the last list response that when provided will retrieve the next page.

Parameters used to filter the retrieved list must remain in subsequent requests with a page token.

id?: List[String]

Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value.

containing?: Attributes
account?: String

Filter the list of organizations to the ones that contain this particular account.

organization?: String

Filter the list of organizations to the ones that contain this particular organization.

user?: String

Filter the list of organizations to the ones that contain this particular user.

IMPORTANT: Just because an organization "contains" a user is not a representation of any authorization or privilege to manage any resources therein. An organization "containing" a user simply means the user is managed by that organization.

name?: Attributes
contains?: String

(case-insensitive) Filter the list of organizations to where the name contains a particular string.

ends_with?: String

(case-insensitive) Filter the list of organizations to where the name ends with a particular string.

starts_with?: String

(case-insensitive) Filter the list of organizations to where the name starts with a particular string.

parent?: Attributes
id?: String

Filter the list of organizations to the ones that are a sub-organization of the specified organization.

"null" is a valid value to provide for this parameter. It means "where an organization has no parent (i.e. it is a 'root' organization)."

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse
result: List[Attributes]

The items returned by the data source

id: String
create_time: Time
meta: Attributes
flags: Attributes

Enable features for Organizations.

account_creation: String
account_deletion: String
account_migration: String
account_mobility: String
sub_org_creation: String
managed_by: String
name: String
parent: Attributes
id: String
name: String
profile: Attributes
business_address: String
business_email: String
business_name: String
business_phone: String
external_metadata: String

cloudflare_organizations

data "cloudflare_organizations" "example_organizations" {
  id = ["a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8"]
  containing = {
    account = "account"
    organization = "organization"
    user = "user"
  }
  name = {
    contains = "contains"
    ends_with = "endsWith"
    starts_with = "startsWith"
  }
  page_size = 0
  page_token = "page_token"
  parent = {
    id = "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8"
  }
}

OrganizationsOrganization Accounts

data cloudflare_organization_accounts

required Expand Collapse
organization_id: String
optional Expand Collapse
direction?: String

Sort direction for the order_by field. Valid values: asc, desc. Defaults to asc when order_by is specified.

order_by?: String

Field to order results by. Currently supported values: account_name. When not specified, results are ordered by internal account ID.

page_size?: Int64

The amount of items to return. Defaults to 10.

page_token?: String

An opaque token returned from the last list response that when provided will retrieve the next page.

Parameters used to filter the retrieved list must remain in subsequent requests with a page token.

account_pubname?: Attributes
contains?: String

(case-insensitive) Filter the list of accounts to where the account_pubname contains a particular string.

ends_with?: String

(case-insensitive) Filter the list of accounts to where the account_pubname ends with a particular string.

starts_with?: String

(case-insensitive) Filter the list of accounts to where the account_pubname starts with a particular string.

name?: Attributes
contains?: String

(case-insensitive) Filter the list of accounts to where the name contains a particular string.

ends_with?: String

(case-insensitive) Filter the list of accounts to where the name ends with a particular string.

starts_with?: String

(case-insensitive) Filter the list of accounts to where the name starts with a particular string.

computed Expand Collapse
organization_accounts: List[Attributes]
id: String
created_on: Time
name: String
settings: Attributes
abuse_contact_email: String
access_approval_expiry: Time
api_access_enabled: Bool
Deprecateddefault_nameservers: String

Use DNS Settings instead. Deprecated.

enforce_twofactor: Bool
Deprecateduse_account_custom_ns_by_default: Bool

Use DNS Settings instead. Deprecated.

type: String

OrganizationsOrganization Profile

resource cloudflare_organization_profile

required Expand Collapse
organization_id: String
business_address: String
business_email: String
business_name: String
business_phone: String
external_metadata: String

cloudflare_organization_profile

resource "cloudflare_organization_profile" "example_organization_profile" {
  organization_id = "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8"
  business_address = "business_address"
  business_email = "business_email"
  business_name = "business_name"
  business_phone = "business_phone"
  external_metadata = "external_metadata"
}

data cloudflare_organization_profile

required Expand Collapse
organization_id: String
computed Expand Collapse
business_address: String
business_email: String
business_name: String
business_phone: String
external_metadata: String

cloudflare_organization_profile

data "cloudflare_organization_profile" "example_organization_profile" {
  organization_id = "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8"
}

OrganizationsMembers

resource cloudflare_organization_member

required Expand Collapse
organization_id: String
member: Attributes
user: Attributes
email: String
status?: String
computed Expand Collapse
id: String

Organization Member ID

create_time: Time
status: String
update_time: Time
meta: Map[JSON]
user: Attributes
id: String
email: String
name: String
two_factor_authentication_enabled: Bool

data cloudflare_organization_member

required Expand Collapse
organization_id: String
optional Expand Collapse
member_id?: String

Organization Member ID

filter?: Attributes
page_size?: Int64

The amount of items to return. Defaults to 10.

page_token?: String

An opaque token returned from the last list response that when provided will retrieve the next page.

Parameters used to filter the retrieved list must remain in subsequent requests with a page token.

status?: List[String]

Filter the list of memberships by membership status.

user?: Attributes
email?: String

Filter the list of memberships for a specific email that ends with a substring.

computed Expand Collapse
id: String

Organization Member ID

create_time: Time
status: String
update_time: Time
meta: Map[JSON]
user: Attributes
id: String
email: String
name: String
two_factor_authentication_enabled: Bool

data cloudflare_organization_members

required Expand Collapse
organization_id: String
optional Expand Collapse
page_size?: Int64

The amount of items to return. Defaults to 10.

page_token?: String

An opaque token returned from the last list response that when provided will retrieve the next page.

Parameters used to filter the retrieved list must remain in subsequent requests with a page token.

status?: List[String]

Filter the list of memberships by membership status.

user?: Attributes
email?: String

Filter the list of memberships for a specific email that ends with a substring.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse
result: List[Attributes]

The items returned by the data source

id: String

Organization Member ID

create_time: Time
meta: Map[JSON]
status: String
update_time: Time
user: Attributes
id: String
email: String
name: String
two_factor_authentication_enabled: Bool