Docs Packages
  1. Packages
  2. Okta
  3. API Docs
  4. Brand
Okta v4.4.0 published on Monday, Sep 18, 2023 by Pulumi
pulumi/pulumi-okta

okta.Brand

Explore with Pulumi AI

okta logo
Okta v4.4.0 published on Monday, Sep 18, 2023 by Pulumi
pulumi/pulumi-okta

    This resource allows you to create and configure an Okta Brand.

    Create Brand Resource

    new Brand(name: string, args?: BrandArgs, opts?: CustomResourceOptions);
    @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,
          email_domain_id: Optional[str] = None,
          locale: Optional[str] = None,
          name: Optional[str] = None,
          remove_powered_by_okta: Optional[bool] = None)
@overload
def Brand(resource_name: str,
          args: Optional[BrandArgs] = None,
          opts: Optional[ResourceOptions] = 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.
    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.

    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

    The Brand resource accepts the following input properties:

    AgreeToCustomPrivacyPolicy bool

    Is a required input flag with when changing custom_privacy_url, shouldn't be considered as a readable property

    BrandId string

    (Read-only) Brand ID, used for read (faux-create). Setting brand_id to default is equivalent to importing the default brand by its ID.

    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

    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 custom_privacy_url, shouldn't be considered as a readable property

    BrandId string

    (Read-only) Brand ID, used for read (faux-create). Setting brand_id to default is equivalent to importing the default brand by its ID.

    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

    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 custom_privacy_url, shouldn't be considered as a readable property

    brandId String

    (Read-only) Brand ID, used for read (faux-create). Setting brand_id to default is equivalent to importing the default brand by its ID.

    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

    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 custom_privacy_url, shouldn't be considered as a readable property

    brandId string

    (Read-only) Brand ID, used for read (faux-create). Setting brand_id to default is equivalent to importing the default brand by its ID.

    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

    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 custom_privacy_url, shouldn't be considered as a readable property

    brand_id str

    (Read-only) Brand ID, used for read (faux-create). Setting brand_id to default is equivalent to importing the default brand by its ID.

    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

    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 custom_privacy_url, shouldn't be considered as a readable property

    brandId String

    (Read-only) Brand ID, used for read (faux-create). Setting brand_id to default is equivalent to importing the default brand by its ID.

    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

    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:

    Id string

    The provider-assigned unique ID for this managed resource.

    IsDefault bool

    (Read-only) Is this the default brand

    Links string

    (Read-only) Link relations for this object - JSON HAL - Discoverable resources related to the brand

    Id string

    The provider-assigned unique ID for this managed resource.

    IsDefault bool

    (Read-only) Is this the default brand

    Links string

    (Read-only) Link relations for this object - JSON HAL - Discoverable resources related to the brand

    id String

    The provider-assigned unique ID for this managed resource.

    isDefault Boolean

    (Read-only) Is this the default brand

    links String

    (Read-only) Link relations for this object - JSON HAL - Discoverable resources related to the brand

    id string

    The provider-assigned unique ID for this managed resource.

    isDefault boolean

    (Read-only) Is this the default brand

    links string

    (Read-only) Link relations for this object - JSON HAL - Discoverable resources related to the brand

    id str

    The provider-assigned unique ID for this managed resource.

    is_default bool

    (Read-only) Is this the default brand

    links str

    (Read-only) Link relations for this object - JSON HAL - Discoverable resources related to the brand

    id String

    The provider-assigned unique ID for this managed resource.

    isDefault Boolean

    (Read-only) Is this the default brand

    links String

    (Read-only) 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 custom_privacy_url, shouldn't be considered as a readable property

    BrandId string

    (Read-only) Brand ID, used for read (faux-create). Setting brand_id to default is equivalent to importing the default brand by its ID.

    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

    (Read-only) Is this the default brand

    Links string

    (Read-only) 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 custom_privacy_url, shouldn't be considered as a readable property

    BrandId string

    (Read-only) Brand ID, used for read (faux-create). Setting brand_id to default is equivalent to importing the default brand by its ID.

    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

    (Read-only) Is this the default brand

    Links string

    (Read-only) 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 custom_privacy_url, shouldn't be considered as a readable property

    brandId String

    (Read-only) Brand ID, used for read (faux-create). Setting brand_id to default is equivalent to importing the default brand by its ID.

    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

    (Read-only) Is this the default brand

    links String

    (Read-only) 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 custom_privacy_url, shouldn't be considered as a readable property

    brandId string

    (Read-only) Brand ID, used for read (faux-create). Setting brand_id to default is equivalent to importing the default brand by its ID.

    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

    (Read-only) Is this the default brand

    links string

    (Read-only) 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 custom_privacy_url, shouldn't be considered as a readable property

    brand_id str

    (Read-only) Brand ID, used for read (faux-create). Setting brand_id to default is equivalent to importing the default brand by its ID.

    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

    (Read-only) Is this the default brand

    links str

    (Read-only) 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 custom_privacy_url, shouldn't be considered as a readable property

    brandId String

    (Read-only) Brand ID, used for read (faux-create). Setting brand_id to default is equivalent to importing the default brand by its ID.

    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

    (Read-only) Is this the default brand

    links String

    (Read-only) 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

    An Okta Brand can be imported via the ID.

     $ pulumi import okta:index/brand:Brand example &#60;brand id&#62;

    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.4.0 published on Monday, Sep 18, 2023 by Pulumi
    pulumi/pulumi-okta