Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta Provider
  3. API Docs
  4. Brand
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

okta.Brand

Explore with Pulumi AI

okta logo
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

    Example Usage

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

const example = new okta.Brand("example", {name: "example"});

    import pulumi
import pulumi_okta as okta

example = okta.Brand("example", name="example")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewBrand(ctx, "example", &okta.BrandArgs{
			Name: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Okta.Brand("example", new()
    {
        Name = "example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.Brand;
import com.pulumi.okta.BrandArgs;
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 Brand("example", BrandArgs.builder()
            .name("example")
            .build());

    }
}

    resources:
  example:
    type: okta:Brand
    properties:
      name: example

    Create Brand Resource

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

    Constructor syntax

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

@overload
def Brand(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          agree_to_custom_privacy_policy: Optional[bool] = None,
          brand_id: Optional[str] = None,
          custom_privacy_policy_url: Optional[str] = None,
          default_app_app_instance_id: Optional[str] = None,
          default_app_app_link_name: Optional[str] = None,
          default_app_classic_application_uri: Optional[str] = None,
          locale: Optional[str] = None,
          name: Optional[str] = None,
          remove_powered_by_okta: Optional[bool] = None)
    func NewBrand(ctx *Context, name string, args *BrandArgs, opts ...ResourceOption) (*Brand, error)
    public Brand(string name, BrandArgs? args = null, CustomResourceOptions? opts = null)
    public Brand(String name, BrandArgs args)
public Brand(String name, BrandArgs args, CustomResourceOptions options)

    type: okta:Brand
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 BrandArgs
    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 BrandArgs
    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 BrandArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BrandArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BrandArgs
    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 brandResource = new Okta.Brand("brandResource", new()
{
    AgreeToCustomPrivacyPolicy = false,
    CustomPrivacyPolicyUrl = "string",
    DefaultAppAppInstanceId = "string",
    DefaultAppAppLinkName = "string",
    DefaultAppClassicApplicationUri = "string",
    Locale = "string",
    Name = "string",
    RemovePoweredByOkta = false,
});

    example, err := okta.NewBrand(ctx, "brandResource", &okta.BrandArgs{
	AgreeToCustomPrivacyPolicy:      pulumi.Bool(false),
	CustomPrivacyPolicyUrl:          pulumi.String("string"),
	DefaultAppAppInstanceId:         pulumi.String("string"),
	DefaultAppAppLinkName:           pulumi.String("string"),
	DefaultAppClassicApplicationUri: pulumi.String("string"),
	Locale:                          pulumi.String("string"),
	Name:                            pulumi.String("string"),
	RemovePoweredByOkta:             pulumi.Bool(false),
})

    var brandResource = new Brand("brandResource", BrandArgs.builder()
    .agreeToCustomPrivacyPolicy(false)
    .customPrivacyPolicyUrl("string")
    .defaultAppAppInstanceId("string")
    .defaultAppAppLinkName("string")
    .defaultAppClassicApplicationUri("string")
    .locale("string")
    .name("string")
    .removePoweredByOkta(false)
    .build());

    brand_resource = okta.Brand("brandResource",
    agree_to_custom_privacy_policy=False,
    custom_privacy_policy_url="string",
    default_app_app_instance_id="string",
    default_app_app_link_name="string",
    default_app_classic_application_uri="string",
    locale="string",
    name="string",
    remove_powered_by_okta=False)

    const brandResource = new okta.Brand("brandResource", {
    agreeToCustomPrivacyPolicy: false,
    customPrivacyPolicyUrl: "string",
    defaultAppAppInstanceId: "string",
    defaultAppAppLinkName: "string",
    defaultAppClassicApplicationUri: "string",
    locale: "string",
    name: "string",
    removePoweredByOkta: false,
});

    type: okta:Brand
properties:
    agreeToCustomPrivacyPolicy: false
    customPrivacyPolicyUrl: string
    defaultAppAppInstanceId: string
    defaultAppAppLinkName: string
    defaultAppClassicApplicationUri: string
    locale: string
    name: string
    removePoweredByOkta: false

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

    AgreeToCustomPrivacyPolicy bool
    Is a required input flag with when changing customprivacyurl, shouldn't be considered as a readable property
    BrandId string
    Brand ID - Note: Okta API for brands only reads and updates therefore the oktabrand resource needs to act as a quasi data source. Do this by setting brandid. DEPRECATED: Okta has fully support brand creation, this attribute is a no op and will be removed

    Deprecated: Okta has fully support brand creation, this attribute is a no op and will be removed

    CustomPrivacyPolicyUrl string
    Custom privacy policy URL
    DefaultAppAppInstanceId string
    Default app app instance id
    DefaultAppAppLinkName string
    Default app app link name
    DefaultAppClassicApplicationUri string
    Default app classic application uri
    Locale string
    The language specified as an IETF BCP 47 language tag
    Name string
    Name of the brand
    RemovePoweredByOkta bool
    Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard
    AgreeToCustomPrivacyPolicy bool
    Is a required input flag with when changing customprivacyurl, shouldn't be considered as a readable property
    BrandId string
    Brand ID - Note: Okta API for brands only reads and updates therefore the oktabrand resource needs to act as a quasi data source. Do this by setting brandid. DEPRECATED: Okta has fully support brand creation, this attribute is a no op and will be removed

    Deprecated: Okta has fully support brand creation, this attribute is a no op and will be removed

    CustomPrivacyPolicyUrl string
    Custom privacy policy URL
    DefaultAppAppInstanceId string
    Default app app instance id
    DefaultAppAppLinkName string
    Default app app link name
    DefaultAppClassicApplicationUri string
    Default app classic application uri
    Locale string
    The language specified as an IETF BCP 47 language tag
    Name string
    Name of the brand
    RemovePoweredByOkta bool
    Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard
    agreeToCustomPrivacyPolicy Boolean
    Is a required input flag with when changing customprivacyurl, shouldn't be considered as a readable property
    brandId String
    Brand ID - Note: Okta API for brands only reads and updates therefore the oktabrand resource needs to act as a quasi data source. Do this by setting brandid. DEPRECATED: Okta has fully support brand creation, this attribute is a no op and will be removed

    Deprecated: Okta has fully support brand creation, this attribute is a no op and will be removed

    customPrivacyPolicyUrl String
    Custom privacy policy URL
    defaultAppAppInstanceId String
    Default app app instance id
    defaultAppAppLinkName String
    Default app app link name
    defaultAppClassicApplicationUri String
    Default app classic application uri
    locale String
    The language specified as an IETF BCP 47 language tag
    name String
    Name of the brand
    removePoweredByOkta Boolean
    Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard
    agreeToCustomPrivacyPolicy boolean
    Is a required input flag with when changing customprivacyurl, shouldn't be considered as a readable property
    brandId string
    Brand ID - Note: Okta API for brands only reads and updates therefore the oktabrand resource needs to act as a quasi data source. Do this by setting brandid. DEPRECATED: Okta has fully support brand creation, this attribute is a no op and will be removed

    Deprecated: Okta has fully support brand creation, this attribute is a no op and will be removed

    customPrivacyPolicyUrl string
    Custom privacy policy URL
    defaultAppAppInstanceId string
    Default app app instance id
    defaultAppAppLinkName string
    Default app app link name
    defaultAppClassicApplicationUri string
    Default app classic application uri
    locale string
    The language specified as an IETF BCP 47 language tag
    name string
    Name of the brand
    removePoweredByOkta boolean
    Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard
    agree_to_custom_privacy_policy bool
    Is a required input flag with when changing customprivacyurl, shouldn't be considered as a readable property
    brand_id str
    Brand ID - Note: Okta API for brands only reads and updates therefore the oktabrand resource needs to act as a quasi data source. Do this by setting brandid. DEPRECATED: Okta has fully support brand creation, this attribute is a no op and will be removed

    Deprecated: Okta has fully support brand creation, this attribute is a no op and will be removed

    custom_privacy_policy_url str
    Custom privacy policy URL
    default_app_app_instance_id str
    Default app app instance id
    default_app_app_link_name str
    Default app app link name
    default_app_classic_application_uri str
    Default app classic application uri
    locale str
    The language specified as an IETF BCP 47 language tag
    name str
    Name of the brand
    remove_powered_by_okta bool
    Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard
    agreeToCustomPrivacyPolicy Boolean
    Is a required input flag with when changing customprivacyurl, shouldn't be considered as a readable property
    brandId String
    Brand ID - Note: Okta API for brands only reads and updates therefore the oktabrand resource needs to act as a quasi data source. Do this by setting brandid. DEPRECATED: Okta has fully support brand creation, this attribute is a no op and will be removed

    Deprecated: Okta has fully support brand creation, this attribute is a no op and will be removed

    customPrivacyPolicyUrl String
    Custom privacy policy URL
    defaultAppAppInstanceId String
    Default app app instance id
    defaultAppAppLinkName String
    Default app app link name
    defaultAppClassicApplicationUri String
    Default app classic application uri
    locale String
    The language specified as an IETF BCP 47 language tag
    name String
    Name of the brand
    removePoweredByOkta Boolean
    Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard

    Outputs

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

    EmailDomainId string
    Email Domain ID tied to this brand
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Is this the default brand
    Links string
    Link relations for this object - JSON HAL - Discoverable resources related to the brand
    EmailDomainId string
    Email Domain ID tied to this brand
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Is this the default brand
    Links string
    Link relations for this object - JSON HAL - Discoverable resources related to the brand
    emailDomainId String
    Email Domain ID tied to this brand
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Is this the default brand
    links String
    Link relations for this object - JSON HAL - Discoverable resources related to the brand
    emailDomainId string
    Email Domain ID tied to this brand
    id string
    The provider-assigned unique ID for this managed resource.
    isDefault boolean
    Is this the default brand
    links string
    Link relations for this object - JSON HAL - Discoverable resources related to the brand
    email_domain_id str
    Email Domain ID tied to this brand
    id str
    The provider-assigned unique ID for this managed resource.
    is_default bool
    Is this the default brand
    links str
    Link relations for this object - JSON HAL - Discoverable resources related to the brand
    emailDomainId String
    Email Domain ID tied to this brand
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Is this the default brand
    links String
    Link relations for this object - JSON HAL - Discoverable resources related to the brand

    Look up Existing Brand Resource

    Get an existing Brand 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?: BrandState, opts?: CustomResourceOptions): Brand
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agree_to_custom_privacy_policy: Optional[bool] = None,
        brand_id: Optional[str] = None,
        custom_privacy_policy_url: Optional[str] = None,
        default_app_app_instance_id: Optional[str] = None,
        default_app_app_link_name: Optional[str] = None,
        default_app_classic_application_uri: Optional[str] = None,
        email_domain_id: Optional[str] = None,
        is_default: Optional[bool] = None,
        links: Optional[str] = None,
        locale: Optional[str] = None,
        name: Optional[str] = None,
        remove_powered_by_okta: Optional[bool] = None) -> Brand
    func GetBrand(ctx *Context, name string, id IDInput, state *BrandState, opts ...ResourceOption) (*Brand, error)
    public static Brand Get(string name, Input<string> id, BrandState? state, CustomResourceOptions? opts = null)
    public static Brand get(String name, Output<String> id, BrandState 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:
    AgreeToCustomPrivacyPolicy bool
    Is a required input flag with when changing customprivacyurl, shouldn't be considered as a readable property
    BrandId string
    Brand ID - Note: Okta API for brands only reads and updates therefore the oktabrand resource needs to act as a quasi data source. Do this by setting brandid. DEPRECATED: Okta has fully support brand creation, this attribute is a no op and will be removed

    Deprecated: Okta has fully support brand creation, this attribute is a no op and will be removed

    CustomPrivacyPolicyUrl string
    Custom privacy policy URL
    DefaultAppAppInstanceId string
    Default app app instance id
    DefaultAppAppLinkName string
    Default app app link name
    DefaultAppClassicApplicationUri string
    Default app classic application uri
    EmailDomainId string
    Email Domain ID tied to this brand
    IsDefault bool
    Is this the default brand
    Links string
    Link relations for this object - JSON HAL - Discoverable resources related to the brand
    Locale string
    The language specified as an IETF BCP 47 language tag
    Name string
    Name of the brand
    RemovePoweredByOkta bool
    Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard
    AgreeToCustomPrivacyPolicy bool
    Is a required input flag with when changing customprivacyurl, shouldn't be considered as a readable property
    BrandId string
    Brand ID - Note: Okta API for brands only reads and updates therefore the oktabrand resource needs to act as a quasi data source. Do this by setting brandid. DEPRECATED: Okta has fully support brand creation, this attribute is a no op and will be removed

    Deprecated: Okta has fully support brand creation, this attribute is a no op and will be removed

    CustomPrivacyPolicyUrl string
    Custom privacy policy URL
    DefaultAppAppInstanceId string
    Default app app instance id
    DefaultAppAppLinkName string
    Default app app link name
    DefaultAppClassicApplicationUri string
    Default app classic application uri
    EmailDomainId string
    Email Domain ID tied to this brand
    IsDefault bool
    Is this the default brand
    Links string
    Link relations for this object - JSON HAL - Discoverable resources related to the brand
    Locale string
    The language specified as an IETF BCP 47 language tag
    Name string
    Name of the brand
    RemovePoweredByOkta bool
    Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard
    agreeToCustomPrivacyPolicy Boolean
    Is a required input flag with when changing customprivacyurl, shouldn't be considered as a readable property
    brandId String
    Brand ID - Note: Okta API for brands only reads and updates therefore the oktabrand resource needs to act as a quasi data source. Do this by setting brandid. DEPRECATED: Okta has fully support brand creation, this attribute is a no op and will be removed

    Deprecated: Okta has fully support brand creation, this attribute is a no op and will be removed

    customPrivacyPolicyUrl String
    Custom privacy policy URL
    defaultAppAppInstanceId String
    Default app app instance id
    defaultAppAppLinkName String
    Default app app link name
    defaultAppClassicApplicationUri String
    Default app classic application uri
    emailDomainId String
    Email Domain ID tied to this brand
    isDefault Boolean
    Is this the default brand
    links String
    Link relations for this object - JSON HAL - Discoverable resources related to the brand
    locale String
    The language specified as an IETF BCP 47 language tag
    name String
    Name of the brand
    removePoweredByOkta Boolean
    Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard
    agreeToCustomPrivacyPolicy boolean
    Is a required input flag with when changing customprivacyurl, shouldn't be considered as a readable property
    brandId string
    Brand ID - Note: Okta API for brands only reads and updates therefore the oktabrand resource needs to act as a quasi data source. Do this by setting brandid. DEPRECATED: Okta has fully support brand creation, this attribute is a no op and will be removed

    Deprecated: Okta has fully support brand creation, this attribute is a no op and will be removed

    customPrivacyPolicyUrl string
    Custom privacy policy URL
    defaultAppAppInstanceId string
    Default app app instance id
    defaultAppAppLinkName string
    Default app app link name
    defaultAppClassicApplicationUri string
    Default app classic application uri
    emailDomainId string
    Email Domain ID tied to this brand
    isDefault boolean
    Is this the default brand
    links string
    Link relations for this object - JSON HAL - Discoverable resources related to the brand
    locale string
    The language specified as an IETF BCP 47 language tag
    name string
    Name of the brand
    removePoweredByOkta boolean
    Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard
    agree_to_custom_privacy_policy bool
    Is a required input flag with when changing customprivacyurl, shouldn't be considered as a readable property
    brand_id str
    Brand ID - Note: Okta API for brands only reads and updates therefore the oktabrand resource needs to act as a quasi data source. Do this by setting brandid. DEPRECATED: Okta has fully support brand creation, this attribute is a no op and will be removed

    Deprecated: Okta has fully support brand creation, this attribute is a no op and will be removed

    custom_privacy_policy_url str
    Custom privacy policy URL
    default_app_app_instance_id str
    Default app app instance id
    default_app_app_link_name str
    Default app app link name
    default_app_classic_application_uri str
    Default app classic application uri
    email_domain_id str
    Email Domain ID tied to this brand
    is_default bool
    Is this the default brand
    links str
    Link relations for this object - JSON HAL - Discoverable resources related to the brand
    locale str
    The language specified as an IETF BCP 47 language tag
    name str
    Name of the brand
    remove_powered_by_okta bool
    Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard
    agreeToCustomPrivacyPolicy Boolean
    Is a required input flag with when changing customprivacyurl, shouldn't be considered as a readable property
    brandId String
    Brand ID - Note: Okta API for brands only reads and updates therefore the oktabrand resource needs to act as a quasi data source. Do this by setting brandid. DEPRECATED: Okta has fully support brand creation, this attribute is a no op and will be removed

    Deprecated: Okta has fully support brand creation, this attribute is a no op and will be removed

    customPrivacyPolicyUrl String
    Custom privacy policy URL
    defaultAppAppInstanceId String
    Default app app instance id
    defaultAppAppLinkName String
    Default app app link name
    defaultAppClassicApplicationUri String
    Default app classic application uri
    emailDomainId String
    Email Domain ID tied to this brand
    isDefault Boolean
    Is this the default brand
    links String
    Link relations for this object - JSON HAL - Discoverable resources related to the brand
    locale String
    The language specified as an IETF BCP 47 language tag
    name String
    Name of the brand
    removePoweredByOkta Boolean
    Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard

    Import

    $ pulumi import okta:index/brand:Brand example <brand_id>

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

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
    pulumi/pulumi-okta