zitadel.LabelPolicy
Explore with Pulumi AI
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.
Constructor 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The LabelPolicy resource accepts the following input properties:
- Background
Color string - hex value for background color
- Background
Color stringDark - hex value for background color dark theme
- Disable
Watermark bool - disable watermark
- Font
Color string - hex value for font color
- Font
Color stringDark - hex value for font color dark theme
- Hide
Login boolName Suffix - 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 string - hex value for primary color
- Primary
Color stringDark - hex value for primary color dark theme
- Warn
Color string - hex value for warn color
- Warn
Color stringDark - hex value for warn color dark theme
- Font
Hash string - Font
Path string - Icon
Dark stringHash - Icon
Dark stringPath - Icon
Hash string - Icon
Path string - Logo
Dark stringHash - Logo
Dark stringPath - Logo
Hash string - Logo
Path string - Org
Id string - ID of the organization
- Set
Active bool - set the label policy active after creating/updating
- Background
Color string - hex value for background color
- Background
Color stringDark - hex value for background color dark theme
- Disable
Watermark bool - disable watermark
- Font
Color string - hex value for font color
- Font
Color stringDark - hex value for font color dark theme
- Hide
Login boolName Suffix - 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 string - hex value for primary color
- Primary
Color stringDark - hex value for primary color dark theme
- Warn
Color string - hex value for warn color
- Warn
Color stringDark - hex value for warn color dark theme
- Font
Hash string - Font
Path string - Icon
Dark stringHash - Icon
Dark stringPath - Icon
Hash string - Icon
Path string - Logo
Dark stringHash - Logo
Dark stringPath - Logo
Hash string - Logo
Path string - Org
Id string - ID of the organization
- Set
Active bool - set the label policy active after creating/updating
- background
Color String - hex value for background color
- background
Color StringDark - hex value for background color dark theme
- disable
Watermark Boolean - disable watermark
- font
Color String - hex value for font color
- font
Color StringDark - hex value for font color dark theme
- hide
Login BooleanName Suffix - 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 String - hex value for primary color
- primary
Color StringDark - hex value for primary color dark theme
- warn
Color String - hex value for warn color
- warn
Color StringDark - hex value for warn color dark theme
- font
Hash String - font
Path String - icon
Dark StringHash - icon
Dark StringPath - icon
Hash String - icon
Path String - logo
Dark StringHash - logo
Dark StringPath - logo
Hash String - logo
Path String - org
Id String - ID of the organization
- set
Active Boolean - set the label policy active after creating/updating
- background
Color string - hex value for background color
- background
Color stringDark - hex value for background color dark theme
- disable
Watermark boolean - disable watermark
- font
Color string - hex value for font color
- font
Color stringDark - hex value for font color dark theme
- hide
Login booleanName Suffix - 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 string - hex value for primary color
- primary
Color stringDark - hex value for primary color dark theme
- warn
Color string - hex value for warn color
- warn
Color stringDark - hex value for warn color dark theme
- font
Hash string - font
Path string - icon
Dark stringHash - icon
Dark stringPath - icon
Hash string - icon
Path string - logo
Dark stringHash - logo
Dark stringPath - logo
Hash string - logo
Path string - org
Id string - ID of the organization
- set
Active boolean - set the label policy active after creating/updating
- background_
color str - hex value for background color
- background_
color_ strdark - hex value for background color dark theme
- disable_
watermark bool - disable watermark
- font_
color str - hex value for font color
- font_
color_ strdark - hex value for font color dark theme
- hide_
login_ boolname_ suffix - 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_ strdark - hex value for primary color dark theme
- warn_
color str - hex value for warn color
- warn_
color_ strdark - hex value for warn color dark theme
- font_
hash str - font_
path str - icon_
dark_ strhash - icon_
dark_ strpath - icon_
hash str - icon_
path str - logo_
dark_ strhash - logo_
dark_ strpath - logo_
hash str - logo_
path str - org_
id str - ID of the organization
- set_
active bool - set the label policy active after creating/updating
- background
Color String - hex value for background color
- background
Color StringDark - hex value for background color dark theme
- disable
Watermark Boolean - disable watermark
- font
Color String - hex value for font color
- font
Color StringDark - hex value for font color dark theme
- hide
Login BooleanName Suffix - 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 String - hex value for primary color
- primary
Color StringDark - hex value for primary color dark theme
- warn
Color String - hex value for warn color
- warn
Color StringDark - hex value for warn color dark theme
- font
Hash String - font
Path String - icon
Dark StringHash - icon
Dark StringPath - icon
Hash String - icon
Path String - logo
Dark StringHash - logo
Dark StringPath - logo
Hash String - logo
Path String - org
Id String - ID of the organization
- set
Active 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:
- Font
Url string - Icon
Url string - Icon
Url stringDark - Id string
- The provider-assigned unique ID for this managed resource.
- Logo
Url string - Logo
Url stringDark
- Font
Url string - Icon
Url string - Icon
Url stringDark - Id string
- The provider-assigned unique ID for this managed resource.
- Logo
Url string - Logo
Url stringDark
- font
Url String - icon
Url String - icon
Url StringDark - id String
- The provider-assigned unique ID for this managed resource.
- logo
Url String - logo
Url StringDark
- font
Url string - icon
Url string - icon
Url stringDark - id string
- The provider-assigned unique ID for this managed resource.
- logo
Url string - logo
Url stringDark
- font_
url str - icon_
url str - icon_
url_ strdark - id str
- The provider-assigned unique ID for this managed resource.
- logo_
url str - logo_
url_ strdark
- font
Url String - icon
Url String - icon
Url StringDark - id String
- The provider-assigned unique ID for this managed resource.
- logo
Url String - logo
Url StringDark
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.
- Background
Color string - hex value for background color
- Background
Color stringDark - hex value for background color dark theme
- Disable
Watermark bool - disable watermark
- Font
Color string - hex value for font color
- Font
Color stringDark - hex value for font color dark theme
- Font
Hash string - Font
Path string - Font
Url string - Hide
Login boolName Suffix - 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 stringHash - Icon
Dark stringPath - Icon
Hash string - Icon
Path string - Icon
Url string - Icon
Url stringDark - Logo
Dark stringHash - Logo
Dark stringPath - Logo
Hash string - Logo
Path string - Logo
Url string - Logo
Url stringDark - Org
Id string - ID of the organization
- Primary
Color string - hex value for primary color
- Primary
Color stringDark - hex value for primary color dark theme
- Set
Active bool - set the label policy active after creating/updating
- Warn
Color string - hex value for warn color
- Warn
Color stringDark - hex value for warn color dark theme
- Background
Color string - hex value for background color
- Background
Color stringDark - hex value for background color dark theme
- Disable
Watermark bool - disable watermark
- Font
Color string - hex value for font color
- Font
Color stringDark - hex value for font color dark theme
- Font
Hash string - Font
Path string - Font
Url string - Hide
Login boolName Suffix - 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 stringHash - Icon
Dark stringPath - Icon
Hash string - Icon
Path string - Icon
Url string - Icon
Url stringDark - Logo
Dark stringHash - Logo
Dark stringPath - Logo
Hash string - Logo
Path string - Logo
Url string - Logo
Url stringDark - Org
Id string - ID of the organization
- Primary
Color string - hex value for primary color
- Primary
Color stringDark - hex value for primary color dark theme
- Set
Active bool - set the label policy active after creating/updating
- Warn
Color string - hex value for warn color
- Warn
Color stringDark - hex value for warn color dark theme
- background
Color String - hex value for background color
- background
Color StringDark - hex value for background color dark theme
- disable
Watermark Boolean - disable watermark
- font
Color String - hex value for font color
- font
Color StringDark - hex value for font color dark theme
- font
Hash String - font
Path String - font
Url String - hide
Login BooleanName Suffix - 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 StringHash - icon
Dark StringPath - icon
Hash String - icon
Path String - icon
Url String - icon
Url StringDark - logo
Dark StringHash - logo
Dark StringPath - logo
Hash String - logo
Path String - logo
Url String - logo
Url StringDark - org
Id String - ID of the organization
- primary
Color String - hex value for primary color
- primary
Color StringDark - hex value for primary color dark theme
- set
Active Boolean - set the label policy active after creating/updating
- warn
Color String - hex value for warn color
- warn
Color StringDark - hex value for warn color dark theme
- background
Color string - hex value for background color
- background
Color stringDark - hex value for background color dark theme
- disable
Watermark boolean - disable watermark
- font
Color string - hex value for font color
- font
Color stringDark - hex value for font color dark theme
- font
Hash string - font
Path string - font
Url string - hide
Login booleanName Suffix - 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 stringHash - icon
Dark stringPath - icon
Hash string - icon
Path string - icon
Url string - icon
Url stringDark - logo
Dark stringHash - logo
Dark stringPath - logo
Hash string - logo
Path string - logo
Url string - logo
Url stringDark - org
Id string - ID of the organization
- primary
Color string - hex value for primary color
- primary
Color stringDark - hex value for primary color dark theme
- set
Active boolean - set the label policy active after creating/updating
- warn
Color string - hex value for warn color
- warn
Color stringDark - hex value for warn color dark theme
- background_
color str - hex value for background color
- background_
color_ strdark - hex value for background color dark theme
- disable_
watermark bool - disable watermark
- font_
color str - hex value for font color
- font_
color_ strdark - hex value for font color dark theme
- font_
hash str - font_
path str - font_
url str - hide_
login_ boolname_ suffix - 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_ strhash - icon_
dark_ strpath - icon_
hash str - icon_
path str - icon_
url str - icon_
url_ strdark - logo_
dark_ strhash - logo_
dark_ strpath - logo_
hash str - logo_
path str - logo_
url str - logo_
url_ strdark - org_
id str - ID of the organization
- primary_
color str - hex value for primary color
- primary_
color_ strdark - 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_ strdark - hex value for warn color dark theme
- background
Color String - hex value for background color
- background
Color StringDark - hex value for background color dark theme
- disable
Watermark Boolean - disable watermark
- font
Color String - hex value for font color
- font
Color StringDark - hex value for font color dark theme
- font
Hash String - font
Path String - font
Url String - hide
Login BooleanName Suffix - 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 StringHash - icon
Dark StringPath - icon
Hash String - icon
Path String - icon
Url String - icon
Url StringDark - logo
Dark StringHash - logo
Dark StringPath - logo
Hash String - logo
Path String - logo
Url String - logo
Url StringDark - org
Id String - ID of the organization
- primary
Color String - hex value for primary color
- primary
Color StringDark - hex value for primary color dark theme
- set
Active Boolean - set the label policy active after creating/updating
- warn
Color String - hex value for warn color
- warn
Color StringDark - 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.