Docs Packages
  1. Packages
  2. Zitadel
  3. API Docs
  4. LabelPolicy
zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse
pulumiverse/pulumi-zitadel

zitadel.LabelPolicy

Explore with Pulumi AI

zitadel logo
zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse
pulumiverse/pulumi-zitadel

    Resource representing the custom label policy of an organization.

    Create LabelPolicy Resource

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

    Constructor syntax

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

@overload
def LabelPolicy(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                background_color: Optional[str] = None,
                background_color_dark: Optional[str] = None,
                disable_watermark: Optional[bool] = None,
                font_color: Optional[str] = None,
                font_color_dark: Optional[str] = None,
                warn_color_dark: Optional[str] = None,
                warn_color: Optional[str] = None,
                hide_login_name_suffix: Optional[bool] = None,
                primary_color_dark: Optional[str] = None,
                primary_color: Optional[str] = None,
                icon_hash: Optional[str] = None,
                icon_path: Optional[str] = None,
                logo_dark_hash: Optional[str] = None,
                logo_dark_path: Optional[str] = None,
                logo_hash: Optional[str] = None,
                logo_path: Optional[str] = None,
                org_id: Optional[str] = None,
                icon_dark_path: Optional[str] = None,
                icon_dark_hash: Optional[str] = None,
                set_active: Optional[bool] = None,
                font_path: Optional[str] = None,
                font_hash: Optional[str] = None)
    func NewLabelPolicy(ctx *Context, name string, args LabelPolicyArgs, opts ...ResourceOption) (*LabelPolicy, error)
    public LabelPolicy(string name, LabelPolicyArgs args, CustomResourceOptions? opts = null)
    public LabelPolicy(String name, LabelPolicyArgs args)
public LabelPolicy(String name, LabelPolicyArgs args, CustomResourceOptions options)

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

    Example

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

    var labelPolicyResource = new Zitadel.LabelPolicy("labelPolicyResource", new()
{
    BackgroundColor = "string",
    BackgroundColorDark = "string",
    DisableWatermark = false,
    FontColor = "string",
    FontColorDark = "string",
    WarnColorDark = "string",
    WarnColor = "string",
    HideLoginNameSuffix = false,
    PrimaryColorDark = "string",
    PrimaryColor = "string",
    IconHash = "string",
    IconPath = "string",
    LogoDarkHash = "string",
    LogoDarkPath = "string",
    LogoHash = "string",
    LogoPath = "string",
    OrgId = "string",
    IconDarkPath = "string",
    IconDarkHash = "string",
    SetActive = false,
    FontPath = "string",
    FontHash = "string",
});

    example, err := zitadel.NewLabelPolicy(ctx, "labelPolicyResource", &zitadel.LabelPolicyArgs{
	BackgroundColor:     pulumi.String("string"),
	BackgroundColorDark: pulumi.String("string"),
	DisableWatermark:    pulumi.Bool(false),
	FontColor:           pulumi.String("string"),
	FontColorDark:       pulumi.String("string"),
	WarnColorDark:       pulumi.String("string"),
	WarnColor:           pulumi.String("string"),
	HideLoginNameSuffix: pulumi.Bool(false),
	PrimaryColorDark:    pulumi.String("string"),
	PrimaryColor:        pulumi.String("string"),
	IconHash:            pulumi.String("string"),
	IconPath:            pulumi.String("string"),
	LogoDarkHash:        pulumi.String("string"),
	LogoDarkPath:        pulumi.String("string"),
	LogoHash:            pulumi.String("string"),
	LogoPath:            pulumi.String("string"),
	OrgId:               pulumi.String("string"),
	IconDarkPath:        pulumi.String("string"),
	IconDarkHash:        pulumi.String("string"),
	SetActive:           pulumi.Bool(false),
	FontPath:            pulumi.String("string"),
	FontHash:            pulumi.String("string"),
})

    var labelPolicyResource = new LabelPolicy("labelPolicyResource", LabelPolicyArgs.builder()
    .backgroundColor("string")
    .backgroundColorDark("string")
    .disableWatermark(false)
    .fontColor("string")
    .fontColorDark("string")
    .warnColorDark("string")
    .warnColor("string")
    .hideLoginNameSuffix(false)
    .primaryColorDark("string")
    .primaryColor("string")
    .iconHash("string")
    .iconPath("string")
    .logoDarkHash("string")
    .logoDarkPath("string")
    .logoHash("string")
    .logoPath("string")
    .orgId("string")
    .iconDarkPath("string")
    .iconDarkHash("string")
    .setActive(false)
    .fontPath("string")
    .fontHash("string")
    .build());

    label_policy_resource = zitadel.LabelPolicy("labelPolicyResource",
    background_color="string",
    background_color_dark="string",
    disable_watermark=False,
    font_color="string",
    font_color_dark="string",
    warn_color_dark="string",
    warn_color="string",
    hide_login_name_suffix=False,
    primary_color_dark="string",
    primary_color="string",
    icon_hash="string",
    icon_path="string",
    logo_dark_hash="string",
    logo_dark_path="string",
    logo_hash="string",
    logo_path="string",
    org_id="string",
    icon_dark_path="string",
    icon_dark_hash="string",
    set_active=False,
    font_path="string",
    font_hash="string")

    const labelPolicyResource = new zitadel.LabelPolicy("labelPolicyResource", {
    backgroundColor: "string",
    backgroundColorDark: "string",
    disableWatermark: false,
    fontColor: "string",
    fontColorDark: "string",
    warnColorDark: "string",
    warnColor: "string",
    hideLoginNameSuffix: false,
    primaryColorDark: "string",
    primaryColor: "string",
    iconHash: "string",
    iconPath: "string",
    logoDarkHash: "string",
    logoDarkPath: "string",
    logoHash: "string",
    logoPath: "string",
    orgId: "string",
    iconDarkPath: "string",
    iconDarkHash: "string",
    setActive: false,
    fontPath: "string",
    fontHash: "string",
});

    type: zitadel:LabelPolicy
properties:
    backgroundColor: string
    backgroundColorDark: string
    disableWatermark: false
    fontColor: string
    fontColorDark: string
    fontHash: string
    fontPath: string
    hideLoginNameSuffix: false
    iconDarkHash: string
    iconDarkPath: string
    iconHash: string
    iconPath: string
    logoDarkHash: string
    logoDarkPath: string
    logoHash: string
    logoPath: string
    orgId: string
    primaryColor: string
    primaryColorDark: string
    setActive: false
    warnColor: string
    warnColorDark: string

    LabelPolicy 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 LabelPolicy resource accepts the following input properties:

    BackgroundColor string
    hex value for background color
    BackgroundColorDark string
    hex value for background color dark theme
    DisableWatermark bool
    disable watermark
    FontColor string
    hex value for font color
    FontColorDark string
    hex value for font color dark theme
    HideLoginNameSuffix bool
    hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set. Details about this scope in https://zitadel.com/docs/apis/openidoauth/scopes#reserved-scopes
    PrimaryColor string
    hex value for primary color
    PrimaryColorDark string
    hex value for primary color dark theme
    WarnColor string
    hex value for warn color
    WarnColorDark string
    hex value for warn color dark theme
    FontHash string
    FontPath string
    IconDarkHash string
    IconDarkPath string
    IconHash string
    IconPath string
    LogoDarkHash string
    LogoDarkPath string
    LogoHash string
    LogoPath string
    OrgId string
    ID of the organization
    SetActive bool
    set the label policy active after creating/updating
    BackgroundColor string
    hex value for background color
    BackgroundColorDark string
    hex value for background color dark theme
    DisableWatermark bool
    disable watermark
    FontColor string
    hex value for font color
    FontColorDark string
    hex value for font color dark theme
    HideLoginNameSuffix bool
    hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set. Details about this scope in https://zitadel.com/docs/apis/openidoauth/scopes#reserved-scopes
    PrimaryColor string
    hex value for primary color
    PrimaryColorDark string
    hex value for primary color dark theme
    WarnColor string
    hex value for warn color
    WarnColorDark string
    hex value for warn color dark theme
    FontHash string
    FontPath string
    IconDarkHash string
    IconDarkPath string
    IconHash string
    IconPath string
    LogoDarkHash string
    LogoDarkPath string
    LogoHash string
    LogoPath string
    OrgId string
    ID of the organization
    SetActive bool
    set the label policy active after creating/updating
    backgroundColor String
    hex value for background color
    backgroundColorDark String
    hex value for background color dark theme
    disableWatermark Boolean
    disable watermark
    fontColor String
    hex value for font color
    fontColorDark String
    hex value for font color dark theme
    hideLoginNameSuffix Boolean
    hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set. Details about this scope in https://zitadel.com/docs/apis/openidoauth/scopes#reserved-scopes
    primaryColor String
    hex value for primary color
    primaryColorDark String
    hex value for primary color dark theme
    warnColor String
    hex value for warn color
    warnColorDark String
    hex value for warn color dark theme
    fontHash String
    fontPath String
    iconDarkHash String
    iconDarkPath String
    iconHash String
    iconPath String
    logoDarkHash String
    logoDarkPath String
    logoHash String
    logoPath String
    orgId String
    ID of the organization
    setActive Boolean
    set the label policy active after creating/updating
    backgroundColor string
    hex value for background color
    backgroundColorDark string
    hex value for background color dark theme
    disableWatermark boolean
    disable watermark
    fontColor string
    hex value for font color
    fontColorDark string
    hex value for font color dark theme
    hideLoginNameSuffix boolean
    hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set. Details about this scope in https://zitadel.com/docs/apis/openidoauth/scopes#reserved-scopes
    primaryColor string
    hex value for primary color
    primaryColorDark string
    hex value for primary color dark theme
    warnColor string
    hex value for warn color
    warnColorDark string
    hex value for warn color dark theme
    fontHash string
    fontPath string
    iconDarkHash string
    iconDarkPath string
    iconHash string
    iconPath string
    logoDarkHash string
    logoDarkPath string
    logoHash string
    logoPath string
    orgId string
    ID of the organization
    setActive boolean
    set the label policy active after creating/updating
    background_color str
    hex value for background color
    background_color_dark str
    hex value for background color dark theme
    disable_watermark bool
    disable watermark
    font_color str
    hex value for font color
    font_color_dark str
    hex value for font color dark theme
    hide_login_name_suffix bool
    hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set. Details about this scope in https://zitadel.com/docs/apis/openidoauth/scopes#reserved-scopes
    primary_color str
    hex value for primary color
    primary_color_dark str
    hex value for primary color dark theme
    warn_color str
    hex value for warn color
    warn_color_dark str
    hex value for warn color dark theme
    font_hash str
    font_path str
    icon_dark_hash str
    icon_dark_path str
    icon_hash str
    icon_path str
    logo_dark_hash str
    logo_dark_path str
    logo_hash str
    logo_path str
    org_id str
    ID of the organization
    set_active bool
    set the label policy active after creating/updating
    backgroundColor String
    hex value for background color
    backgroundColorDark String
    hex value for background color dark theme
    disableWatermark Boolean
    disable watermark
    fontColor String
    hex value for font color
    fontColorDark String
    hex value for font color dark theme
    hideLoginNameSuffix Boolean
    hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set. Details about this scope in https://zitadel.com/docs/apis/openidoauth/scopes#reserved-scopes
    primaryColor String
    hex value for primary color
    primaryColorDark String
    hex value for primary color dark theme
    warnColor String
    hex value for warn color
    warnColorDark String
    hex value for warn color dark theme
    fontHash String
    fontPath String
    iconDarkHash String
    iconDarkPath String
    iconHash String
    iconPath String
    logoDarkHash String
    logoDarkPath String
    logoHash String
    logoPath String
    orgId String
    ID of the organization
    setActive Boolean
    set the label policy active after creating/updating

    Outputs

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

    FontUrl string
    IconUrl string
    IconUrlDark string
    Id string
    The provider-assigned unique ID for this managed resource.
    LogoUrl string
    LogoUrlDark string
    FontUrl string
    IconUrl string
    IconUrlDark string
    Id string
    The provider-assigned unique ID for this managed resource.
    LogoUrl string
    LogoUrlDark string
    fontUrl String
    iconUrl String
    iconUrlDark String
    id String
    The provider-assigned unique ID for this managed resource.
    logoUrl String
    logoUrlDark String
    fontUrl string
    iconUrl string
    iconUrlDark string
    id string
    The provider-assigned unique ID for this managed resource.
    logoUrl string
    logoUrlDark string
    font_url str
    icon_url str
    icon_url_dark str
    id str
    The provider-assigned unique ID for this managed resource.
    logo_url str
    logo_url_dark str
    fontUrl String
    iconUrl String
    iconUrlDark String
    id String
    The provider-assigned unique ID for this managed resource.
    logoUrl String
    logoUrlDark String

    Look up Existing LabelPolicy Resource

    Get an existing LabelPolicy 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?: LabelPolicyState, opts?: CustomResourceOptions): LabelPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        background_color: Optional[str] = None,
        background_color_dark: Optional[str] = None,
        disable_watermark: Optional[bool] = None,
        font_color: Optional[str] = None,
        font_color_dark: Optional[str] = None,
        font_hash: Optional[str] = None,
        font_path: Optional[str] = None,
        font_url: Optional[str] = None,
        hide_login_name_suffix: Optional[bool] = None,
        icon_dark_hash: Optional[str] = None,
        icon_dark_path: Optional[str] = None,
        icon_hash: Optional[str] = None,
        icon_path: Optional[str] = None,
        icon_url: Optional[str] = None,
        icon_url_dark: Optional[str] = None,
        logo_dark_hash: Optional[str] = None,
        logo_dark_path: Optional[str] = None,
        logo_hash: Optional[str] = None,
        logo_path: Optional[str] = None,
        logo_url: Optional[str] = None,
        logo_url_dark: Optional[str] = None,
        org_id: Optional[str] = None,
        primary_color: Optional[str] = None,
        primary_color_dark: Optional[str] = None,
        set_active: Optional[bool] = None,
        warn_color: Optional[str] = None,
        warn_color_dark: Optional[str] = None) -> LabelPolicy
    func GetLabelPolicy(ctx *Context, name string, id IDInput, state *LabelPolicyState, opts ...ResourceOption) (*LabelPolicy, error)
    public static LabelPolicy Get(string name, Input<string> id, LabelPolicyState? state, CustomResourceOptions? opts = null)
    public static LabelPolicy get(String name, Output<String> id, LabelPolicyState 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:
    BackgroundColor string
    hex value for background color
    BackgroundColorDark string
    hex value for background color dark theme
    DisableWatermark bool
    disable watermark
    FontColor string
    hex value for font color
    FontColorDark string
    hex value for font color dark theme
    FontHash string
    FontPath string
    FontUrl string
    HideLoginNameSuffix bool
    hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set. Details about this scope in https://zitadel.com/docs/apis/openidoauth/scopes#reserved-scopes
    IconDarkHash string
    IconDarkPath string
    IconHash string
    IconPath string
    IconUrl string
    IconUrlDark string
    LogoDarkHash string
    LogoDarkPath string
    LogoHash string
    LogoPath string
    LogoUrl string
    LogoUrlDark string
    OrgId string
    ID of the organization
    PrimaryColor string
    hex value for primary color
    PrimaryColorDark string
    hex value for primary color dark theme
    SetActive bool
    set the label policy active after creating/updating
    WarnColor string
    hex value for warn color
    WarnColorDark string
    hex value for warn color dark theme
    BackgroundColor string
    hex value for background color
    BackgroundColorDark string
    hex value for background color dark theme
    DisableWatermark bool
    disable watermark
    FontColor string
    hex value for font color
    FontColorDark string
    hex value for font color dark theme
    FontHash string
    FontPath string
    FontUrl string
    HideLoginNameSuffix bool
    hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set. Details about this scope in https://zitadel.com/docs/apis/openidoauth/scopes#reserved-scopes
    IconDarkHash string
    IconDarkPath string
    IconHash string
    IconPath string
    IconUrl string
    IconUrlDark string
    LogoDarkHash string
    LogoDarkPath string
    LogoHash string
    LogoPath string
    LogoUrl string
    LogoUrlDark string
    OrgId string
    ID of the organization
    PrimaryColor string
    hex value for primary color
    PrimaryColorDark string
    hex value for primary color dark theme
    SetActive bool
    set the label policy active after creating/updating
    WarnColor string
    hex value for warn color
    WarnColorDark string
    hex value for warn color dark theme
    backgroundColor String
    hex value for background color
    backgroundColorDark String
    hex value for background color dark theme
    disableWatermark Boolean
    disable watermark
    fontColor String
    hex value for font color
    fontColorDark String
    hex value for font color dark theme
    fontHash String
    fontPath String
    fontUrl String
    hideLoginNameSuffix Boolean
    hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set. Details about this scope in https://zitadel.com/docs/apis/openidoauth/scopes#reserved-scopes
    iconDarkHash String
    iconDarkPath String
    iconHash String
    iconPath String
    iconUrl String
    iconUrlDark String
    logoDarkHash String
    logoDarkPath String
    logoHash String
    logoPath String
    logoUrl String
    logoUrlDark String
    orgId String
    ID of the organization
    primaryColor String
    hex value for primary color
    primaryColorDark String
    hex value for primary color dark theme
    setActive Boolean
    set the label policy active after creating/updating
    warnColor String
    hex value for warn color
    warnColorDark String
    hex value for warn color dark theme
    backgroundColor string
    hex value for background color
    backgroundColorDark string
    hex value for background color dark theme
    disableWatermark boolean
    disable watermark
    fontColor string
    hex value for font color
    fontColorDark string
    hex value for font color dark theme
    fontHash string
    fontPath string
    fontUrl string
    hideLoginNameSuffix boolean
    hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set. Details about this scope in https://zitadel.com/docs/apis/openidoauth/scopes#reserved-scopes
    iconDarkHash string
    iconDarkPath string
    iconHash string
    iconPath string
    iconUrl string
    iconUrlDark string
    logoDarkHash string
    logoDarkPath string
    logoHash string
    logoPath string
    logoUrl string
    logoUrlDark string
    orgId string
    ID of the organization
    primaryColor string
    hex value for primary color
    primaryColorDark string
    hex value for primary color dark theme
    setActive boolean
    set the label policy active after creating/updating
    warnColor string
    hex value for warn color
    warnColorDark string
    hex value for warn color dark theme
    background_color str
    hex value for background color
    background_color_dark str
    hex value for background color dark theme
    disable_watermark bool
    disable watermark
    font_color str
    hex value for font color
    font_color_dark str
    hex value for font color dark theme
    font_hash str
    font_path str
    font_url str
    hide_login_name_suffix bool
    hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set. Details about this scope in https://zitadel.com/docs/apis/openidoauth/scopes#reserved-scopes
    icon_dark_hash str
    icon_dark_path str
    icon_hash str
    icon_path str
    icon_url str
    icon_url_dark str
    logo_dark_hash str
    logo_dark_path str
    logo_hash str
    logo_path str
    logo_url str
    logo_url_dark str
    org_id str
    ID of the organization
    primary_color str
    hex value for primary color
    primary_color_dark str
    hex value for primary color dark theme
    set_active bool
    set the label policy active after creating/updating
    warn_color str
    hex value for warn color
    warn_color_dark str
    hex value for warn color dark theme
    backgroundColor String
    hex value for background color
    backgroundColorDark String
    hex value for background color dark theme
    disableWatermark Boolean
    disable watermark
    fontColor String
    hex value for font color
    fontColorDark String
    hex value for font color dark theme
    fontHash String
    fontPath String
    fontUrl String
    hideLoginNameSuffix Boolean
    hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set. Details about this scope in https://zitadel.com/docs/apis/openidoauth/scopes#reserved-scopes
    iconDarkHash String
    iconDarkPath String
    iconHash String
    iconPath String
    iconUrl String
    iconUrlDark String
    logoDarkHash String
    logoDarkPath String
    logoHash String
    logoPath String
    logoUrl String
    logoUrlDark String
    orgId String
    ID of the organization
    primaryColor String
    hex value for primary color
    primaryColorDark String
    hex value for primary color dark theme
    setActive Boolean
    set the label policy active after creating/updating
    warnColor String
    hex value for warn color
    warnColorDark String
    hex value for warn color dark theme

    Import

    terraform The resource can be imported using the ID format <[org_id]>, e.g.

     $ pulumi import zitadel:index/labelPolicy:LabelPolicy imported '123456789012345678'

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

    Package Details

    Repository
    zitadel pulumiverse/pulumi-zitadel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the zitadel Terraform Provider.
    zitadel logo
    zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse
    pulumiverse/pulumi-zitadel