Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
  3. API Docs
  4. Organization
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
pulumi/pulumi-auth0

auth0.Organization

Explore with Pulumi AI

auth0 logo
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
pulumi/pulumi-auth0

    The Organizations feature represents a broad update to the Auth0 platform that allows our business-to-business (B2B) customers to better manage their partners and customers, and to customize the ways that end-users access their applications. Auth0 customers can use Organizations to:

    • Represent their business customers and partners in Auth0 and manage their membership.
    • Configure branded, federated login flows for each business.
    • Build administration capabilities into their products, using Organizations APIs, so that those businesses can manage their own organizations.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";

const myOrganization = new auth0.Organization("my_organization", {
    name: "auth0-inc",
    displayName: "Auth0 Inc.",
    branding: {
        logoUrl: "https://example.com/assets/icons/icon.png",
        colors: {
            primary: "#f2f2f2",
            page_background: "#e1e1e1",
        },
    },
});

    import pulumi
import pulumi_auth0 as auth0

my_organization = auth0.Organization("my_organization",
    name="auth0-inc",
    display_name="Auth0 Inc.",
    branding={
        "logo_url": "https://example.com/assets/icons/icon.png",
        "colors": {
            "primary": "#f2f2f2",
            "page_background": "#e1e1e1",
        },
    })

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth0.NewOrganization(ctx, "my_organization", &auth0.OrganizationArgs{
			Name:        pulumi.String("auth0-inc"),
			DisplayName: pulumi.String("Auth0 Inc."),
			Branding: &auth0.OrganizationBrandingArgs{
				LogoUrl: pulumi.String("https://example.com/assets/icons/icon.png"),
				Colors: pulumi.StringMap{
					"primary":         pulumi.String("#f2f2f2"),
					"page_background": pulumi.String("#e1e1e1"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    var myOrganization = new Auth0.Organization("my_organization", new()
    {
        Name = "auth0-inc",
        DisplayName = "Auth0 Inc.",
        Branding = new Auth0.Inputs.OrganizationBrandingArgs
        {
            LogoUrl = "https://example.com/assets/icons/icon.png",
            Colors = 
            {
                { "primary", "#f2f2f2" },
                { "page_background", "#e1e1e1" },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.Organization;
import com.pulumi.auth0.OrganizationArgs;
import com.pulumi.auth0.inputs.OrganizationBrandingArgs;
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 myOrganization = new Organization("myOrganization", OrganizationArgs.builder()
            .name("auth0-inc")
            .displayName("Auth0 Inc.")
            .branding(OrganizationBrandingArgs.builder()
                .logoUrl("https://example.com/assets/icons/icon.png")
                .colors(Map.ofEntries(
                    Map.entry("primary", "#f2f2f2"),
                    Map.entry("page_background", "#e1e1e1")
                ))
                .build())
            .build());

    }
}

    resources:
  myOrganization:
    type: auth0:Organization
    name: my_organization
    properties:
      name: auth0-inc
      displayName: Auth0 Inc.
      branding:
        logoUrl: https://example.com/assets/icons/icon.png
        colors:
          primary: '#f2f2f2'
          page_background: '#e1e1e1'

    Create Organization Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Organization(name: string, args?: OrganizationArgs, opts?: CustomResourceOptions);
    @overload
def Organization(resource_name: str,
                 args: Optional[OrganizationArgs] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def Organization(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 branding: Optional[OrganizationBrandingArgs] = None,
                 display_name: Optional[str] = None,
                 metadata: Optional[Mapping[str, str]] = None,
                 name: Optional[str] = None)
    func NewOrganization(ctx *Context, name string, args *OrganizationArgs, opts ...ResourceOption) (*Organization, error)
    public Organization(string name, OrganizationArgs? args = null, CustomResourceOptions? opts = null)
    public Organization(String name, OrganizationArgs args)
public Organization(String name, OrganizationArgs args, CustomResourceOptions options)

    type: auth0:Organization
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OrganizationArgs
    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 OrganizationArgs
    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 OrganizationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var organizationResource = new Auth0.Organization("organizationResource", new()
{
    Branding = new Auth0.Inputs.OrganizationBrandingArgs
    {
        Colors = 
        {
            { "string", "string" },
        },
        LogoUrl = "string",
    },
    DisplayName = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
});

    example, err := auth0.NewOrganization(ctx, "organizationResource", &auth0.OrganizationArgs{
	Branding: &auth0.OrganizationBrandingArgs{
		Colors: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		LogoUrl: pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var organizationResource = new Organization("organizationResource", OrganizationArgs.builder()
    .branding(OrganizationBrandingArgs.builder()
        .colors(Map.of("string", "string"))
        .logoUrl("string")
        .build())
    .displayName("string")
    .metadata(Map.of("string", "string"))
    .name("string")
    .build());

    organization_resource = auth0.Organization("organizationResource",
    branding={
        "colors": {
            "string": "string",
        },
        "logo_url": "string",
    },
    display_name="string",
    metadata={
        "string": "string",
    },
    name="string")

    const organizationResource = new auth0.Organization("organizationResource", {
    branding: {
        colors: {
            string: "string",
        },
        logoUrl: "string",
    },
    displayName: "string",
    metadata: {
        string: "string",
    },
    name: "string",
});

    type: auth0:Organization
properties:
    branding:
        colors:
            string: string
        logoUrl: string
    displayName: string
    metadata:
        string: string
    name: string

    Organization Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Organization resource accepts the following input properties:

    Branding OrganizationBranding
    Defines how to style the login pages.
    DisplayName string
    Friendly name of this organization.
    Metadata Dictionary<string, string>
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    Name string
    The name of this organization.
    Branding OrganizationBrandingArgs
    Defines how to style the login pages.
    DisplayName string
    Friendly name of this organization.
    Metadata map[string]string
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    Name string
    The name of this organization.
    branding OrganizationBranding
    Defines how to style the login pages.
    displayName String
    Friendly name of this organization.
    metadata Map<String,String>
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    name String
    The name of this organization.
    branding OrganizationBranding
    Defines how to style the login pages.
    displayName string
    Friendly name of this organization.
    metadata {[key: string]: string}
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    name string
    The name of this organization.
    branding OrganizationBrandingArgs
    Defines how to style the login pages.
    display_name str
    Friendly name of this organization.
    metadata Mapping[str, str]
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    name str
    The name of this organization.
    branding Property Map
    Defines how to style the login pages.
    displayName String
    Friendly name of this organization.
    metadata Map<String>
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    name String
    The name of this organization.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Organization 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 Organization Resource

    Get an existing Organization 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?: OrganizationState, opts?: CustomResourceOptions): Organization
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        branding: Optional[OrganizationBrandingArgs] = None,
        display_name: Optional[str] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None) -> Organization
    func GetOrganization(ctx *Context, name string, id IDInput, state *OrganizationState, opts ...ResourceOption) (*Organization, error)
    public static Organization Get(string name, Input<string> id, OrganizationState? state, CustomResourceOptions? opts = null)
    public static Organization get(String name, Output<String> id, OrganizationState 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:
    Branding OrganizationBranding
    Defines how to style the login pages.
    DisplayName string
    Friendly name of this organization.
    Metadata Dictionary<string, string>
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    Name string
    The name of this organization.
    Branding OrganizationBrandingArgs
    Defines how to style the login pages.
    DisplayName string
    Friendly name of this organization.
    Metadata map[string]string
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    Name string
    The name of this organization.
    branding OrganizationBranding
    Defines how to style the login pages.
    displayName String
    Friendly name of this organization.
    metadata Map<String,String>
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    name String
    The name of this organization.
    branding OrganizationBranding
    Defines how to style the login pages.
    displayName string
    Friendly name of this organization.
    metadata {[key: string]: string}
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    name string
    The name of this organization.
    branding OrganizationBrandingArgs
    Defines how to style the login pages.
    display_name str
    Friendly name of this organization.
    metadata Mapping[str, str]
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    name str
    The name of this organization.
    branding Property Map
    Defines how to style the login pages.
    displayName String
    Friendly name of this organization.
    metadata Map<String>
    Metadata associated with the organization. Maximum of 10 metadata properties allowed.
    name String
    The name of this organization.

    Supporting Types

    OrganizationBranding, OrganizationBrandingArgs

    Colors Dictionary<string, string>
    Color scheme used to customize the login pages.
    LogoUrl string
    URL of logo to display on login page.
    Colors map[string]string
    Color scheme used to customize the login pages.
    LogoUrl string
    URL of logo to display on login page.
    colors Map<String,String>
    Color scheme used to customize the login pages.
    logoUrl String
    URL of logo to display on login page.
    colors {[key: string]: string}
    Color scheme used to customize the login pages.
    logoUrl string
    URL of logo to display on login page.
    colors Mapping[str, str]
    Color scheme used to customize the login pages.
    logo_url str
    URL of logo to display on login page.
    colors Map<String>
    Color scheme used to customize the login pages.
    logoUrl String
    URL of logo to display on login page.

    Import

    This resource can be imported by specifying the organization ID.

    Example:

    $ pulumi import auth0:index/organization:Organization my_organization "org_XXXXXXXXXXXXXX"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo
    Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
    pulumi/pulumi-auth0