cloudflare logo
Cloudflare v4.15.0, Jan 10 23

cloudflare.AccessOrganization

A Zero Trust organization defines the user login experience.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var example = new Cloudflare.AccessOrganization("example", new()
    {
        AccountId = "f037e56e89293a057740de681ac9abbe",
        AuthDomain = "example.cloudflareaccess.com",
        IsUiReadOnly = false,
        LoginDesigns = new[]
        {
            new Cloudflare.Inputs.AccessOrganizationLoginDesignArgs
            {
                BackgroundColor = "#ffffff",
                FooterText = "My footer text",
                HeaderText = "My header text",
                LogoPath = "https://example.com/logo.png",
                TextColor = "#000000",
            },
        },
        Name = "example.cloudflareaccess.com",
    });

});
package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v4/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.NewAccessOrganization(ctx, "example", &cloudflare.AccessOrganizationArgs{
			AccountId:    pulumi.String("f037e56e89293a057740de681ac9abbe"),
			AuthDomain:   pulumi.String("example.cloudflareaccess.com"),
			IsUiReadOnly: pulumi.Bool(false),
			LoginDesigns: cloudflare.AccessOrganizationLoginDesignArray{
				&cloudflare.AccessOrganizationLoginDesignArgs{
					BackgroundColor: pulumi.String("#ffffff"),
					FooterText:      pulumi.String("My footer text"),
					HeaderText:      pulumi.String("My header text"),
					LogoPath:        pulumi.String("https://example.com/logo.png"),
					TextColor:       pulumi.String("#000000"),
				},
			},
			Name: pulumi.String("example.cloudflareaccess.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.AccessOrganization;
import com.pulumi.cloudflare.AccessOrganizationArgs;
import com.pulumi.cloudflare.inputs.AccessOrganizationLoginDesignArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new AccessOrganization("example", AccessOrganizationArgs.builder()        
            .accountId("f037e56e89293a057740de681ac9abbe")
            .authDomain("example.cloudflareaccess.com")
            .isUiReadOnly(false)
            .loginDesigns(AccessOrganizationLoginDesignArgs.builder()
                .backgroundColor("#ffffff")
                .footerText("My footer text")
                .headerText("My header text")
                .logoPath("https://example.com/logo.png")
                .textColor("#000000")
                .build())
            .name("example.cloudflareaccess.com")
            .build());

    }
}
import pulumi
import pulumi_cloudflare as cloudflare

example = cloudflare.AccessOrganization("example",
    account_id="f037e56e89293a057740de681ac9abbe",
    auth_domain="example.cloudflareaccess.com",
    is_ui_read_only=False,
    login_designs=[cloudflare.AccessOrganizationLoginDesignArgs(
        background_color="#ffffff",
        footer_text="My footer text",
        header_text="My header text",
        logo_path="https://example.com/logo.png",
        text_color="#000000",
    )],
    name="example.cloudflareaccess.com")
import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const example = new cloudflare.AccessOrganization("example", {
    accountId: "f037e56e89293a057740de681ac9abbe",
    authDomain: "example.cloudflareaccess.com",
    isUiReadOnly: false,
    loginDesigns: [{
        backgroundColor: "#ffffff",
        footerText: "My footer text",
        headerText: "My header text",
        logoPath: "https://example.com/logo.png",
        textColor: "#000000",
    }],
    name: "example.cloudflareaccess.com",
});
resources:
  example:
    type: cloudflare:AccessOrganization
    properties:
      accountId: f037e56e89293a057740de681ac9abbe
      authDomain: example.cloudflareaccess.com
      isUiReadOnly: false
      loginDesigns:
        - backgroundColor: '#ffffff'
          footerText: My footer text
          headerText: My header text
          logoPath: https://example.com/logo.png
          textColor: '#000000'
      name: example.cloudflareaccess.com

Create AccessOrganization Resource

new AccessOrganization(name: string, args: AccessOrganizationArgs, opts?: CustomResourceOptions);
@overload
def AccessOrganization(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       account_id: Optional[str] = None,
                       auth_domain: Optional[str] = None,
                       is_ui_read_only: Optional[bool] = None,
                       login_designs: Optional[Sequence[AccessOrganizationLoginDesignArgs]] = None,
                       name: Optional[str] = None,
                       zone_id: Optional[str] = None)
@overload
def AccessOrganization(resource_name: str,
                       args: AccessOrganizationArgs,
                       opts: Optional[ResourceOptions] = None)
func NewAccessOrganization(ctx *Context, name string, args AccessOrganizationArgs, opts ...ResourceOption) (*AccessOrganization, error)
public AccessOrganization(string name, AccessOrganizationArgs args, CustomResourceOptions? opts = null)
public AccessOrganization(String name, AccessOrganizationArgs args)
public AccessOrganization(String name, AccessOrganizationArgs args, CustomResourceOptions options)
type: cloudflare:AccessOrganization
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AccessOrganizationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args AccessOrganizationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AccessOrganizationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AccessOrganizationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AccessOrganizationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AccessOrganization Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The AccessOrganization resource accepts the following input properties:

AuthDomain string

The unique subdomain assigned to your Zero Trust organization.

AccountId string

The account identifier to target for the resource. Conflicts with zone_id.

IsUiReadOnly bool

When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.

LoginDesigns List<AccessOrganizationLoginDesignArgs>
Name string

The name of your Zero Trust organization.

ZoneId string

The zone identifier to target for the resource. Conflicts with account_id.

AuthDomain string

The unique subdomain assigned to your Zero Trust organization.

AccountId string

The account identifier to target for the resource. Conflicts with zone_id.

IsUiReadOnly bool

When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.

LoginDesigns []AccessOrganizationLoginDesignArgs
Name string

The name of your Zero Trust organization.

ZoneId string

The zone identifier to target for the resource. Conflicts with account_id.

authDomain String

The unique subdomain assigned to your Zero Trust organization.

accountId String

The account identifier to target for the resource. Conflicts with zone_id.

isUiReadOnly Boolean

When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.

loginDesigns List<AccessOrganizationLoginDesignArgs>
name String

The name of your Zero Trust organization.

zoneId String

The zone identifier to target for the resource. Conflicts with account_id.

authDomain string

The unique subdomain assigned to your Zero Trust organization.

accountId string

The account identifier to target for the resource. Conflicts with zone_id.

isUiReadOnly boolean

When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.

loginDesigns AccessOrganizationLoginDesignArgs[]
name string

The name of your Zero Trust organization.

zoneId string

The zone identifier to target for the resource. Conflicts with account_id.

auth_domain str

The unique subdomain assigned to your Zero Trust organization.

account_id str

The account identifier to target for the resource. Conflicts with zone_id.

is_ui_read_only bool

When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.

login_designs Sequence[AccessOrganizationLoginDesignArgs]
name str

The name of your Zero Trust organization.

zone_id str

The zone identifier to target for the resource. Conflicts with account_id.

authDomain String

The unique subdomain assigned to your Zero Trust organization.

accountId String

The account identifier to target for the resource. Conflicts with zone_id.

isUiReadOnly Boolean

When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.

loginDesigns List<Property Map>
name String

The name of your Zero Trust organization.

zoneId String

The zone identifier to target for the resource. Conflicts with account_id.

Outputs

All input properties are implicitly available as output properties. Additionally, the AccessOrganization resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing AccessOrganization Resource

Get an existing AccessOrganization resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AccessOrganizationState, opts?: CustomResourceOptions): AccessOrganization
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        auth_domain: Optional[str] = None,
        is_ui_read_only: Optional[bool] = None,
        login_designs: Optional[Sequence[AccessOrganizationLoginDesignArgs]] = None,
        name: Optional[str] = None,
        zone_id: Optional[str] = None) -> AccessOrganization
func GetAccessOrganization(ctx *Context, name string, id IDInput, state *AccessOrganizationState, opts ...ResourceOption) (*AccessOrganization, error)
public static AccessOrganization Get(string name, Input<string> id, AccessOrganizationState? state, CustomResourceOptions? opts = null)
public static AccessOrganization get(String name, Output<String> id, AccessOrganizationState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccountId string

The account identifier to target for the resource. Conflicts with zone_id.

AuthDomain string

The unique subdomain assigned to your Zero Trust organization.

IsUiReadOnly bool

When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.

LoginDesigns List<AccessOrganizationLoginDesignArgs>
Name string

The name of your Zero Trust organization.

ZoneId string

The zone identifier to target for the resource. Conflicts with account_id.

AccountId string

The account identifier to target for the resource. Conflicts with zone_id.

AuthDomain string

The unique subdomain assigned to your Zero Trust organization.

IsUiReadOnly bool

When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.

LoginDesigns []AccessOrganizationLoginDesignArgs
Name string

The name of your Zero Trust organization.

ZoneId string

The zone identifier to target for the resource. Conflicts with account_id.

accountId String

The account identifier to target for the resource. Conflicts with zone_id.

authDomain String

The unique subdomain assigned to your Zero Trust organization.

isUiReadOnly Boolean

When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.

loginDesigns List<AccessOrganizationLoginDesignArgs>
name String

The name of your Zero Trust organization.

zoneId String

The zone identifier to target for the resource. Conflicts with account_id.

accountId string

The account identifier to target for the resource. Conflicts with zone_id.

authDomain string

The unique subdomain assigned to your Zero Trust organization.

isUiReadOnly boolean

When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.

loginDesigns AccessOrganizationLoginDesignArgs[]
name string

The name of your Zero Trust organization.

zoneId string

The zone identifier to target for the resource. Conflicts with account_id.

account_id str

The account identifier to target for the resource. Conflicts with zone_id.

auth_domain str

The unique subdomain assigned to your Zero Trust organization.

is_ui_read_only bool

When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.

login_designs Sequence[AccessOrganizationLoginDesignArgs]
name str

The name of your Zero Trust organization.

zone_id str

The zone identifier to target for the resource. Conflicts with account_id.

accountId String

The account identifier to target for the resource. Conflicts with zone_id.

authDomain String

The unique subdomain assigned to your Zero Trust organization.

isUiReadOnly Boolean

When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.

loginDesigns List<Property Map>
name String

The name of your Zero Trust organization.

zoneId String

The zone identifier to target for the resource. Conflicts with account_id.

Supporting Types

AccessOrganizationLoginDesign

BackgroundColor string

The background color on the login page.

FooterText string

The text at the bottom of the login page.

HeaderText string

The text at the top of the login page.

LogoPath string

The URL of the logo on the login page.

TextColor string

The text color on the login page.

BackgroundColor string

The background color on the login page.

FooterText string

The text at the bottom of the login page.

HeaderText string

The text at the top of the login page.

LogoPath string

The URL of the logo on the login page.

TextColor string

The text color on the login page.

backgroundColor String

The background color on the login page.

footerText String

The text at the bottom of the login page.

headerText String

The text at the top of the login page.

logoPath String

The URL of the logo on the login page.

textColor String

The text color on the login page.

backgroundColor string

The background color on the login page.

footerText string

The text at the bottom of the login page.

headerText string

The text at the top of the login page.

logoPath string

The URL of the logo on the login page.

textColor string

The text color on the login page.

background_color str

The background color on the login page.

footer_text str

The text at the bottom of the login page.

header_text str

The text at the top of the login page.

logo_path str

The URL of the logo on the login page.

text_color str

The text color on the login page.

backgroundColor String

The background color on the login page.

footerText String

The text at the bottom of the login page.

headerText String

The text at the top of the login page.

logoPath String

The URL of the logo on the login page.

textColor String

The text color on the login page.

Import

 $ pulumi import cloudflare:index/accessOrganization:AccessOrganization example <account_id>

Package Details

Repository
Cloudflare pulumi/pulumi-cloudflare
License
Apache-2.0
Notes

This Pulumi package is based on the cloudflare Terraform Provider.