## Create your Zero Trust organization `client.ZeroTrust.Organizations.New(ctx, params) (*Organization, error)` **post** `/{accounts_or_zones}/{account_or_zone_id}/access/organizations` Sets up a Zero Trust organization for your account or zone. ### Parameters - `params OrganizationNewParams` - `AuthDomain param.Field[string]` Body param: The unique subdomain assigned to your Zero Trust organization. - `Name param.Field[string]` Body param: The name of your Zero Trust organization. - `AccountID param.Field[string]` Path param: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. - `ZoneID param.Field[string]` Path param: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. - `AllowAuthenticateViaWARP param.Field[bool]` Body param: When set to true, users can authenticate via WARP for any application in your organization. Application settings will take precedence over this value. - `AutoRedirectToIdentity param.Field[bool]` Body param: When set to `true`, users skip the identity provider selection step during login. - `DenyUnmatchedRequests param.Field[bool]` Body param: 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 param.Field[[]string]` Body param: 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 param.Field[bool]` Body param: 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 param.Field[LoginDesign]` Body param - `MfaConfig param.Field[OrganizationNewParamsMfaConfig]` Body param: Configures multi-factor authentication (MFA) settings for an organization. - `AllowedAuthenticators []OrganizationNewParamsMfaConfigAllowedAuthenticator` Lists the MFA methods that users can authenticate with. - `const OrganizationNewParamsMfaConfigAllowedAuthenticatorTotp OrganizationNewParamsMfaConfigAllowedAuthenticator = "totp"` - `const OrganizationNewParamsMfaConfigAllowedAuthenticatorBiometrics OrganizationNewParamsMfaConfigAllowedAuthenticator = "biometrics"` - `const OrganizationNewParamsMfaConfigAllowedAuthenticatorSecurityKey OrganizationNewParamsMfaConfigAllowedAuthenticator = "security_key"` - `const OrganizationNewParamsMfaConfigAllowedAuthenticatorPivKey OrganizationNewParamsMfaConfigAllowedAuthenticator = "piv_key"` - `AmrMatchingSessionDuration string` 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 string` Specifies a Cloudflare List of required FIDO2 authenticator device AAGUIDs. - `SessionDuration string` 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`. - `MfaPivKeyRequirements param.Field[OrganizationNewParamsMfaPivKeyRequirements]` Body param: Configures PIV key requirements for MFA using hardware security keys. - `PinPolicy OrganizationNewParamsMfaPivKeyRequirementsPinPolicy` 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). - `const OrganizationNewParamsMfaPivKeyRequirementsPinPolicyNever OrganizationNewParamsMfaPivKeyRequirementsPinPolicy = "never"` - `const OrganizationNewParamsMfaPivKeyRequirementsPinPolicyOnce OrganizationNewParamsMfaPivKeyRequirementsPinPolicy = "once"` - `const OrganizationNewParamsMfaPivKeyRequirementsPinPolicyAlways OrganizationNewParamsMfaPivKeyRequirementsPinPolicy = "always"` - `RequireFipsDevice bool` Requires the PIV key to be stored on a FIPS 140-2 Level 1 or higher validated device. - `SSHKeySize []OrganizationNewParamsMfaPivKeyRequirementsSSHKeySize` 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. - `const OrganizationNewParamsMfaPivKeyRequirementsSSHKeySize256 OrganizationNewParamsMfaPivKeyRequirementsSSHKeySize = 256` - `const OrganizationNewParamsMfaPivKeyRequirementsSSHKeySize384 OrganizationNewParamsMfaPivKeyRequirementsSSHKeySize = 384` - `const OrganizationNewParamsMfaPivKeyRequirementsSSHKeySize521 OrganizationNewParamsMfaPivKeyRequirementsSSHKeySize = 521` - `const OrganizationNewParamsMfaPivKeyRequirementsSSHKeySize2048 OrganizationNewParamsMfaPivKeyRequirementsSSHKeySize = 2048` - `const OrganizationNewParamsMfaPivKeyRequirementsSSHKeySize3072 OrganizationNewParamsMfaPivKeyRequirementsSSHKeySize = 3072` - `const OrganizationNewParamsMfaPivKeyRequirementsSSHKeySize4096 OrganizationNewParamsMfaPivKeyRequirementsSSHKeySize = 4096` - `SSHKeyType []OrganizationNewParamsMfaPivKeyRequirementsSSHKeyType` Specifies the allowed SSH key types. Valid values are `ecdsa`, `ed25519`, and `rsa`. - `const OrganizationNewParamsMfaPivKeyRequirementsSSHKeyTypeEcdsa OrganizationNewParamsMfaPivKeyRequirementsSSHKeyType = "ecdsa"` - `const OrganizationNewParamsMfaPivKeyRequirementsSSHKeyTypeEd25519 OrganizationNewParamsMfaPivKeyRequirementsSSHKeyType = "ed25519"` - `const OrganizationNewParamsMfaPivKeyRequirementsSSHKeyTypeRSA OrganizationNewParamsMfaPivKeyRequirementsSSHKeyType = "rsa"` - `TouchPolicy OrganizationNewParamsMfaPivKeyRequirementsTouchPolicy` 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). - `const OrganizationNewParamsMfaPivKeyRequirementsTouchPolicyNever OrganizationNewParamsMfaPivKeyRequirementsTouchPolicy = "never"` - `const OrganizationNewParamsMfaPivKeyRequirementsTouchPolicyAlways OrganizationNewParamsMfaPivKeyRequirementsTouchPolicy = "always"` - `const OrganizationNewParamsMfaPivKeyRequirementsTouchPolicyCached OrganizationNewParamsMfaPivKeyRequirementsTouchPolicy = "cached"` - `MfaRequiredForAllApps param.Field[bool]` Body param: 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. Note: 'allowed_authenticators' cannot only contain 'piv_key' if the organization has any non-infrastructure applications because PIV keys are only compatible with infrastructure apps. - `SessionDuration param.Field[string]` Body param: 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 param.Field[string]` Body param: A description of the reason why the UI read only field is being toggled. - `UserSeatExpirationInactiveTime param.Field[string]` Body param: 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 param.Field[string]` Body param: 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. ### Returns - `type Organization struct{…}` - `AllowAuthenticateViaWARP bool` When set to true, users can authenticate via WARP for any application in your organization. Application settings will take precedence over this value. - `AuthDomain string` The unique subdomain assigned to your Zero Trust organization. - `AutoRedirectToIdentity bool` When set to `true`, users skip the identity provider selection step during login. - `CustomPages OrganizationCustomPages` - `Forbidden string` The uid of the custom page to use when a user is denied access after failing a non-identity rule. - `IdentityDenied string` The uid of the custom page to use when a user is denied access. - `DenyUnmatchedRequests bool` 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 []string` 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 bool` 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 LoginDesign` - `BackgroundColor string` The background color on your login page. - `FooterText string` The text at the bottom of your login page. - `HeaderText string` The text at the top of your login page. - `LogoPath string` The URL of the logo on your login page. - `TextColor string` The text color on your login page. - `MfaConfig OrganizationMfaConfig` Configures multi-factor authentication (MFA) settings for an organization. - `AllowedAuthenticators []OrganizationMfaConfigAllowedAuthenticator` Lists the MFA methods that users can authenticate with. - `const OrganizationMfaConfigAllowedAuthenticatorTotp OrganizationMfaConfigAllowedAuthenticator = "totp"` - `const OrganizationMfaConfigAllowedAuthenticatorBiometrics OrganizationMfaConfigAllowedAuthenticator = "biometrics"` - `const OrganizationMfaConfigAllowedAuthenticatorSecurityKey OrganizationMfaConfigAllowedAuthenticator = "security_key"` - `const OrganizationMfaConfigAllowedAuthenticatorPivKey OrganizationMfaConfigAllowedAuthenticator = "piv_key"` - `AmrMatchingSessionDuration string` 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 string` Specifies a Cloudflare List of required FIDO2 authenticator device AAGUIDs. - `SessionDuration string` 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`. - `MfaPivKeyRequirements OrganizationMfaPivKeyRequirements` Configures PIV key requirements for MFA using hardware security keys. - `PinPolicy OrganizationMfaPivKeyRequirementsPinPolicy` 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). - `const OrganizationMfaPivKeyRequirementsPinPolicyNever OrganizationMfaPivKeyRequirementsPinPolicy = "never"` - `const OrganizationMfaPivKeyRequirementsPinPolicyOnce OrganizationMfaPivKeyRequirementsPinPolicy = "once"` - `const OrganizationMfaPivKeyRequirementsPinPolicyAlways OrganizationMfaPivKeyRequirementsPinPolicy = "always"` - `RequireFipsDevice bool` Requires the PIV key to be stored on a FIPS 140-2 Level 1 or higher validated device. - `SSHKeySize []OrganizationMfaPivKeyRequirementsSSHKeySize` 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. - `const OrganizationMfaPivKeyRequirementsSSHKeySize256 OrganizationMfaPivKeyRequirementsSSHKeySize = 256` - `const OrganizationMfaPivKeyRequirementsSSHKeySize384 OrganizationMfaPivKeyRequirementsSSHKeySize = 384` - `const OrganizationMfaPivKeyRequirementsSSHKeySize521 OrganizationMfaPivKeyRequirementsSSHKeySize = 521` - `const OrganizationMfaPivKeyRequirementsSSHKeySize2048 OrganizationMfaPivKeyRequirementsSSHKeySize = 2048` - `const OrganizationMfaPivKeyRequirementsSSHKeySize3072 OrganizationMfaPivKeyRequirementsSSHKeySize = 3072` - `const OrganizationMfaPivKeyRequirementsSSHKeySize4096 OrganizationMfaPivKeyRequirementsSSHKeySize = 4096` - `SSHKeyType []OrganizationMfaPivKeyRequirementsSSHKeyType` Specifies the allowed SSH key types. Valid values are `ecdsa`, `ed25519`, and `rsa`. - `const OrganizationMfaPivKeyRequirementsSSHKeyTypeEcdsa OrganizationMfaPivKeyRequirementsSSHKeyType = "ecdsa"` - `const OrganizationMfaPivKeyRequirementsSSHKeyTypeEd25519 OrganizationMfaPivKeyRequirementsSSHKeyType = "ed25519"` - `const OrganizationMfaPivKeyRequirementsSSHKeyTypeRSA OrganizationMfaPivKeyRequirementsSSHKeyType = "rsa"` - `TouchPolicy OrganizationMfaPivKeyRequirementsTouchPolicy` 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). - `const OrganizationMfaPivKeyRequirementsTouchPolicyNever OrganizationMfaPivKeyRequirementsTouchPolicy = "never"` - `const OrganizationMfaPivKeyRequirementsTouchPolicyAlways OrganizationMfaPivKeyRequirementsTouchPolicy = "always"` - `const OrganizationMfaPivKeyRequirementsTouchPolicyCached OrganizationMfaPivKeyRequirementsTouchPolicy = "cached"` - `MfaRequiredForAllApps bool` 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. Note: 'allowed_authenticators' cannot only contain 'piv_key' if the organization has any non-infrastructure applications because PIV keys are only compatible with infrastructure apps. - `Name string` The name of your Zero Trust organization. - `SessionDuration string` 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 string` A description of the reason why the UI read only field is being toggled. - `UserSeatExpirationInactiveTime string` 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 string` 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. ### Example ```go package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/zero_trust" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) organization, err := client.ZeroTrust.Organizations.New(context.TODO(), zero_trust.OrganizationNewParams{ AuthDomain: cloudflare.F("test.cloudflareaccess.com"), Name: cloudflare.F("Widget Corps Internal Applications"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", organization.AutoRedirectToIdentity) } ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "allow_authenticate_via_warp": true, "auth_domain": "test.cloudflareaccess.com", "auto_redirect_to_identity": true, "created_at": "2014-01-01T05:20:00.12345Z", "custom_pages": { "forbidden": "699d98642c564d2e855e9661899b7252", "identity_denied": "699d98642c564d2e855e9661899b7252" }, "deny_unmatched_requests": true, "deny_unmatched_requests_exempted_zone_names": [ "example.com" ], "is_ui_read_only": true, "login_design": { "background_color": "#c5ed1b", "footer_text": "This is an example description.", "header_text": "This is an example description.", "logo_path": "https://example.com/logo.png", "text_color": "#c5ed1b" }, "mfa_config": { "allowed_authenticators": [ "totp", "biometrics", "security_key" ], "amr_matching_session_duration": "12h", "required_aaguids": "2fc0579f-8113-47ea-b116-bb5a8db9202a", "session_duration": "24h" }, "mfa_piv_key_requirements": { "pin_policy": "always", "require_fips_device": true, "ssh_key_size": [ 256, 2048 ], "ssh_key_type": [ "ecdsa", "rsa" ], "touch_policy": "always" }, "mfa_required_for_all_apps": false, "name": "Widget Corps Internal Applications", "session_duration": "24h", "ui_read_only_toggle_reason": "Temporarily turn off the UI read only lock to make a change via the UI", "updated_at": "2014-01-01T05:20:00.12345Z", "user_seat_expiration_inactive_time": "730h", "warp_auth_session_duration": "24h" } } ```