Organizations

Get your Zero Trust organization

client.ZeroTrust.Organizations.List(ctx, query) (*Organization, error)

GET/{accounts_or_zones}/{account_or_zone_id}/access/organizations

Create your Zero Trust organization

client.ZeroTrust.Organizations.New(ctx, params) (*Organization, error)

POST/{accounts_or_zones}/{account_or_zone_id}/access/organizations

Update your Zero Trust organization

client.ZeroTrust.Organizations.Update(ctx, params) (*Organization, error)

PUT/{accounts_or_zones}/{account_or_zone_id}/access/organizations

Revoke all Access tokens for a user

client.ZeroTrust.Organizations.RevokeUsers(ctx, params) (*OrganizationRevokeUsersResponse, error)

POST/{accounts_or_zones}/{account_or_zone_id}/access/organizations/revoke_user

ModelsExpand Collapse

type LoginDesign struct{…}

BackgroundColor stringOptional

The background color on your login page.

FooterText stringOptional

The text at the bottom of your login page.

HeaderText stringOptional

The text at the top of your login page.

LogoPath stringOptional

The URL of the logo on your login page.

TextColor stringOptional

The text color on your login page.

type Organization struct{…}

AllowAuthenticateViaWARP boolOptional

When set to true, users can authenticate via WARP for any application in your organization. Application settings will take precedence over this value.

AuthDomain stringOptional

The unique subdomain assigned to your Zero Trust organization.

AutoRedirectToIdentity boolOptional

When set to true, users skip the identity provider selection step during login.

CustomPages OrganizationCustomPagesOptional

Forbidden stringOptional

The uid of the custom page to use when a user is denied access after failing a non-identity rule.

IdentityDenied stringOptional

The uid of the custom page to use when a user is denied access.

DenyUnmatchedRequests boolOptional

Determines whether to deny all requests to Cloudflare-protected resources that lack an associated Access application. If enabled, you must explicitly configure an Access application and policy to allow traffic to your Cloudflare-protected resources. For domains you want to be public across all subdomains, add the domain to the deny_unmatched_requests_exempted_zone_names array.

DenyUnmatchedRequestsExemptedZoneNames []stringOptional

Contains zone names to exempt from the deny_unmatched_requests feature. Requests to a subdomain in an exempted zone will block unauthenticated traffic by default if there is a configured Access application and policy that matches the request.

IsUIReadOnly boolOptional

Lock all settings as Read-Only in the Dashboard, regardless of user permission. Updates may only be made via the API or Terraform for this account when enabled.

LoginDesign LoginDesignOptional

MfaConfig OrganizationMfaConfigOptional

Configures multi-factor authentication (MFA) settings for an organization.

AllowedAuthenticators []OrganizationMfaConfigAllowedAuthenticatorOptional

Lists the MFA methods that users can authenticate with.

One of the following:

const OrganizationMfaConfigAllowedAuthenticatorTotp OrganizationMfaConfigAllowedAuthenticator = "totp"

const OrganizationMfaConfigAllowedAuthenticatorBiometrics OrganizationMfaConfigAllowedAuthenticator = "biometrics"

const OrganizationMfaConfigAllowedAuthenticatorSecurityKey OrganizationMfaConfigAllowedAuthenticator = "security_key"

const OrganizationMfaConfigAllowedAuthenticatorSSHPivKey OrganizationMfaConfigAllowedAuthenticator = "ssh_piv_key"

AmrMatchingSessionDuration stringOptional

Allows a user to skip MFA via Authentication Method Reference (AMR) matching when the AMR claim provided by the IdP the user used to authenticate contains “mfa”. Must be in minutes (m) or hours (h). Minimum: 0m. Maximum: 720h (30 days).

RequiredAaguids stringOptional

Specifies a Cloudflare List of required FIDO2 authenticator device AAGUIDs.

formatuuid

SessionDuration stringOptional

Defines the duration of an MFA session. Must be in minutes (m) or hours (h). Minimum: 0m. Maximum: 720h (30 days). Examples:5m or 24h.

MfaRequiredForAllApps boolOptional

Determines whether global MFA settings apply to applications by default. The organization must have MFA enabled with at least one authentication method and a session duration configured.

MfaSSHPivKeyRequirements OrganizationMfaSSHPivKeyRequirementsOptional

Configures SSH PIV key requirements for MFA using hardware security keys.

PinPolicy OrganizationMfaSSHPivKeyRequirementsPinPolicyOptional

Defines when a PIN is required to use the SSH key. Valid values: never (no PIN required), once (PIN required once per session), always (PIN required for each use).

One of the following:

const OrganizationMfaSSHPivKeyRequirementsPinPolicyNever OrganizationMfaSSHPivKeyRequirementsPinPolicy = "never"

const OrganizationMfaSSHPivKeyRequirementsPinPolicyOnce OrganizationMfaSSHPivKeyRequirementsPinPolicy = "once"

const OrganizationMfaSSHPivKeyRequirementsPinPolicyAlways OrganizationMfaSSHPivKeyRequirementsPinPolicy = "always"

RequireFipsDevice boolOptional

Requires the SSH PIV key to be stored on a FIPS 140-2 Level 1 or higher validated device.

SSHKeySize []OrganizationMfaSSHPivKeyRequirementsSSHKeySizeOptional

Specifies the allowed SSH key sizes in bits. Valid sizes depend on key type. Ed25519 has a fixed key size and does not accept this parameter.

One of the following:

const OrganizationMfaSSHPivKeyRequirementsSSHKeySize256 OrganizationMfaSSHPivKeyRequirementsSSHKeySize = 256

const OrganizationMfaSSHPivKeyRequirementsSSHKeySize384 OrganizationMfaSSHPivKeyRequirementsSSHKeySize = 384

const OrganizationMfaSSHPivKeyRequirementsSSHKeySize521 OrganizationMfaSSHPivKeyRequirementsSSHKeySize = 521

const OrganizationMfaSSHPivKeyRequirementsSSHKeySize2048 OrganizationMfaSSHPivKeyRequirementsSSHKeySize = 2048

const OrganizationMfaSSHPivKeyRequirementsSSHKeySize3072 OrganizationMfaSSHPivKeyRequirementsSSHKeySize = 3072

const OrganizationMfaSSHPivKeyRequirementsSSHKeySize4096 OrganizationMfaSSHPivKeyRequirementsSSHKeySize = 4096

SSHKeyType []OrganizationMfaSSHPivKeyRequirementsSSHKeyTypeOptional

Specifies the allowed SSH key types. Valid values are ecdsa, ed25519, and rsa.

One of the following:

const OrganizationMfaSSHPivKeyRequirementsSSHKeyTypeEcdsa OrganizationMfaSSHPivKeyRequirementsSSHKeyType = "ecdsa"

const OrganizationMfaSSHPivKeyRequirementsSSHKeyTypeEd25519 OrganizationMfaSSHPivKeyRequirementsSSHKeyType = "ed25519"

const OrganizationMfaSSHPivKeyRequirementsSSHKeyTypeRSA OrganizationMfaSSHPivKeyRequirementsSSHKeyType = "rsa"

TouchPolicy OrganizationMfaSSHPivKeyRequirementsTouchPolicyOptional

Defines when physical touch is required to use the SSH key. Valid values: never (no touch required), always (touch required for each use), cached (touch cached for 15 seconds).

One of the following:

const OrganizationMfaSSHPivKeyRequirementsTouchPolicyNever OrganizationMfaSSHPivKeyRequirementsTouchPolicy = "never"

const OrganizationMfaSSHPivKeyRequirementsTouchPolicyAlways OrganizationMfaSSHPivKeyRequirementsTouchPolicy = "always"

const OrganizationMfaSSHPivKeyRequirementsTouchPolicyCached OrganizationMfaSSHPivKeyRequirementsTouchPolicy = "cached"

Name stringOptional

The name of your Zero Trust organization.

SessionDuration stringOptional

The amount of time that tokens issued for applications will be valid. Must be in the format 300ms or 2h45m. Valid time units are: ns, us (or µs), ms, s, m, h.

UIReadOnlyToggleReason stringOptional

A description of the reason why the UI read only field is being toggled.

UserSeatExpirationInactiveTime stringOptional

The amount of time a user seat is inactive before it expires. When the user seat exceeds the set time of inactivity, the user is removed as an active seat and no longer counts against your Teams seat count. Minimum value for this setting is 1 month (730h). Must be in the format 300ms or 2h45m. Valid time units are: ns, us (or µs), ms, s, m, h.

WARPAuthSessionDuration stringOptional

The amount of time that tokens issued for applications will be valid. Must be in the format 30m or 2h45m. Valid time units are: m, h.

OrganizationsDOH

Get your Zero Trust organization DoH settings

client.ZeroTrust.Organizations.DOH.Get(ctx, query) (*OrganizationDOHGetResponse, error)

GET/accounts/{account_id}/access/organizations/doh

Update your Zero Trust organization DoH settings

client.ZeroTrust.Organizations.DOH.Update(ctx, params) (*OrganizationDOHUpdateResponse, error)

PUT/accounts/{account_id}/access/organizations/doh