Organizations

List organizations the user has access to

client.Organizations.List(ctx, query) (*SinglePage[Organization], error)

GET/organizations

Get organization

client.Organizations.Get(ctx, organizationID) (*Organization, error)

GET/organizations/{organization_id}

Create organization

client.Organizations.New(ctx, body) (*Organization, error)

POST/organizations

Modify organization.

client.Organizations.Update(ctx, organizationID, body) (*Organization, error)

PUT/organizations/{organization_id}

Delete organization.

client.Organizations.Delete(ctx, organizationID) (*OrganizationDeleteResponse, error)

DELETE/organizations/{organization_id}

ModelsExpand Collapse

type Organization struct{…}

References an Organization in the Cloudflare data model.

ID string

CreateTime Time

formatdate-time

Meta OrganizationMeta

Flags OrganizationMetaFlagsoptional

Enable features for Organizations.

AccountCreation string

AccountDeletion string

AccountMigration string

AccountMobility string

SubOrgCreation string

ManagedBy stringoptional

Name string

Parent OrganizationParentoptional

ID string

Name string

Profile AccountProfileoptional

OrganizationsOrganization Accounts

Get organization accounts

client.Organizations.OrganizationAccounts.Get(ctx, organizationID, query) (*[]OrganizationAccountGetResponse, error)

GET/organizations/{organization_id}/accounts

ModelsExpand Collapse

type OrganizationAccounts struct{…}

ID string

Identifier

maxLength32

minLength32

Name string

Account name

maxLength100

Type OrganizationAccountsType

One of the following:

const OrganizationAccountsTypeStandard OrganizationAccountsType = "standard"

const OrganizationAccountsTypeEnterprise OrganizationAccountsType = "enterprise"

CreatedOn Timeoptional

Timestamp for the creation of the account

formatdate-time

ManagedBy OrganizationAccountsManagedByoptional

Parent container details

ParentOrgID stringoptional

ID of the parent Organization, if one exists

maxLength32

ParentOrgName stringoptional

Name of the parent Organization, if one exists

Settings OrganizationAccountsSettingsoptional

Account settings

AbuseContactEmail stringoptional

Sets an abuse contact email to notify for abuse reports.

EnforceTwofactor booloptional

Indicates whether membership in this account requires that Two-Factor Authentication is enabled

OrganizationsOrganization Profile

Get organization profile

client.Organizations.OrganizationProfile.Get(ctx, organizationID) (*AccountProfile, error)

GET/organizations/{organization_id}/profile

Modify organization profile.

client.Organizations.OrganizationProfile.Update(ctx, organizationID, body) error

PUT/organizations/{organization_id}/profile

ModelsExpand Collapse

type OrganizationProfile struct{…}

BusinessAddress string

BusinessEmail string

BusinessName string

BusinessPhone string

ExternalMetadata string

OrganizationsMembers

List organization members

client.Organizations.Members.List(ctx, organizationID, query) (*SinglePage[OrganizationMember], error)

GET/organizations/{organization_id}/members

Get organization member

client.Organizations.Members.Get(ctx, organizationID, memberID) (*OrganizationMember, error)

GET/organizations/{organization_id}/members/{member_id}

Create organization member

client.Organizations.Members.New(ctx, organizationID, body) (*OrganizationMember, error)

POST/organizations/{organization_id}/members

Delete organization member

client.Organizations.Members.Delete(ctx, organizationID, memberID) error

DELETE/organizations/{organization_id}/members/{member_id}

ModelsExpand Collapse

type OrganizationMember struct{…}

ID string

Organization Member ID

CreateTime Time

formatdate-time

Meta map[string, unknown]

Status OrganizationMemberStatus

One of the following:

const OrganizationMemberStatusActive OrganizationMemberStatus = "active"

const OrganizationMemberStatusCanceled OrganizationMemberStatus = "canceled"

UpdateTime Time

formatdate-time

User OrganizationMemberUser

ID string

Email string

Name string

TwoFactorAuthenticationEnabled bool