okta.Brand
Explore with Pulumi AI
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)
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:
- Agree
To boolCustom Privacy Policy Is a required input flag with when changing custom_privacy_url, shouldn't be considered as a readable property
- Brand
Id string (Read-only) Brand ID, used for read (faux-create). Setting
brand_id
todefault
is equivalent to importing the default brand by its ID.Okta has fully support brand creation, this attribute is a no op and will be removed
- Custom
Privacy stringPolicy Url Custom privacy policy URL
- Default
App stringApp Instance Id Default app app instance id
- Default
App stringApp Link Name Default app app link name
- Default
App stringClassic Application Uri Default app classic application uri
- Email
Domain stringId 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
- Remove
Powered boolBy Okta Removes "Powered by Okta" from the Okta-hosted sign-in page, and "© 2021 Okta, Inc." from the Okta End-User Dashboard
- Agree
To boolCustom Privacy Policy Is a required input flag with when changing custom_privacy_url, shouldn't be considered as a readable property
- Brand
Id string (Read-only) Brand ID, used for read (faux-create). Setting
brand_id
todefault
is equivalent to importing the default brand by its ID.Okta has fully support brand creation, this attribute is a no op and will be removed
- Custom
Privacy stringPolicy Url Custom privacy policy URL
- Default
App stringApp Instance Id Default app app instance id
- Default
App stringApp Link Name Default app app link name
- Default
App stringClassic Application Uri Default app classic application uri
- Email
Domain stringId 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
- Remove
Powered boolBy Okta Removes "Powered by Okta" from the Okta-hosted sign-in page, and "© 2021 Okta, Inc." from the Okta End-User Dashboard
- agree
To BooleanCustom Privacy Policy Is a required input flag with when changing custom_privacy_url, shouldn't be considered as a readable property
- brand
Id String (Read-only) Brand ID, used for read (faux-create). Setting
brand_id
todefault
is equivalent to importing the default brand by its ID.Okta has fully support brand creation, this attribute is a no op and will be removed
- custom
Privacy StringPolicy Url Custom privacy policy URL
- default
App StringApp Instance Id Default app app instance id
- default
App StringApp Link Name Default app app link name
- default
App StringClassic Application Uri Default app classic application uri
- email
Domain StringId 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
- remove
Powered BooleanBy Okta Removes "Powered by Okta" from the Okta-hosted sign-in page, and "© 2021 Okta, Inc." from the Okta End-User Dashboard
- agree
To booleanCustom Privacy Policy Is a required input flag with when changing custom_privacy_url, shouldn't be considered as a readable property
- brand
Id string (Read-only) Brand ID, used for read (faux-create). Setting
brand_id
todefault
is equivalent to importing the default brand by its ID.Okta has fully support brand creation, this attribute is a no op and will be removed
- custom
Privacy stringPolicy Url Custom privacy policy URL
- default
App stringApp Instance Id Default app app instance id
- default
App stringApp Link Name Default app app link name
- default
App stringClassic Application Uri Default app classic application uri
- email
Domain stringId 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
- remove
Powered booleanBy Okta Removes "Powered by Okta" from the Okta-hosted sign-in page, and "© 2021 Okta, Inc." from the Okta End-User Dashboard
- agree_
to_ boolcustom_ privacy_ policy 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
todefault
is equivalent to importing the default brand by its ID.Okta has fully support brand creation, this attribute is a no op and will be removed
- custom_
privacy_ strpolicy_ url Custom privacy policy URL
- default_
app_ strapp_ instance_ id Default app app instance id
- default_
app_ strapp_ link_ name Default app app link name
- default_
app_ strclassic_ application_ uri Default app classic application uri
- email_
domain_ strid 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_ boolby_ okta Removes "Powered by Okta" from the Okta-hosted sign-in page, and "© 2021 Okta, Inc." from the Okta End-User Dashboard
- agree
To BooleanCustom Privacy Policy Is a required input flag with when changing custom_privacy_url, shouldn't be considered as a readable property
- brand
Id String (Read-only) Brand ID, used for read (faux-create). Setting
brand_id
todefault
is equivalent to importing the default brand by its ID.Okta has fully support brand creation, this attribute is a no op and will be removed
- custom
Privacy StringPolicy Url Custom privacy policy URL
- default
App StringApp Instance Id Default app app instance id
- default
App StringApp Link Name Default app app link name
- default
App StringClassic Application Uri Default app classic application uri
- email
Domain StringId 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
- remove
Powered BooleanBy Okta 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 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
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.
- Agree
To boolCustom Privacy Policy Is a required input flag with when changing custom_privacy_url, shouldn't be considered as a readable property
- Brand
Id string (Read-only) Brand ID, used for read (faux-create). Setting
brand_id
todefault
is equivalent to importing the default brand by its ID.Okta has fully support brand creation, this attribute is a no op and will be removed
- Custom
Privacy stringPolicy Url Custom privacy policy URL
- Default
App stringApp Instance Id Default app app instance id
- Default
App stringApp Link Name Default app app link name
- Default
App stringClassic Application Uri Default app classic application uri
- Email
Domain stringId Email Domain ID tied to this brand
- Is
Default 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
- Remove
Powered boolBy Okta Removes "Powered by Okta" from the Okta-hosted sign-in page, and "© 2021 Okta, Inc." from the Okta End-User Dashboard
- Agree
To boolCustom Privacy Policy Is a required input flag with when changing custom_privacy_url, shouldn't be considered as a readable property
- Brand
Id string (Read-only) Brand ID, used for read (faux-create). Setting
brand_id
todefault
is equivalent to importing the default brand by its ID.Okta has fully support brand creation, this attribute is a no op and will be removed
- Custom
Privacy stringPolicy Url Custom privacy policy URL
- Default
App stringApp Instance Id Default app app instance id
- Default
App stringApp Link Name Default app app link name
- Default
App stringClassic Application Uri Default app classic application uri
- Email
Domain stringId Email Domain ID tied to this brand
- Is
Default 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
- Remove
Powered boolBy Okta Removes "Powered by Okta" from the Okta-hosted sign-in page, and "© 2021 Okta, Inc." from the Okta End-User Dashboard
- agree
To BooleanCustom Privacy Policy Is a required input flag with when changing custom_privacy_url, shouldn't be considered as a readable property
- brand
Id String (Read-only) Brand ID, used for read (faux-create). Setting
brand_id
todefault
is equivalent to importing the default brand by its ID.Okta has fully support brand creation, this attribute is a no op and will be removed
- custom
Privacy StringPolicy Url Custom privacy policy URL
- default
App StringApp Instance Id Default app app instance id
- default
App StringApp Link Name Default app app link name
- default
App StringClassic Application Uri Default app classic application uri
- email
Domain StringId Email Domain ID tied to this brand
- is
Default 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
- remove
Powered BooleanBy Okta Removes "Powered by Okta" from the Okta-hosted sign-in page, and "© 2021 Okta, Inc." from the Okta End-User Dashboard
- agree
To booleanCustom Privacy Policy Is a required input flag with when changing custom_privacy_url, shouldn't be considered as a readable property
- brand
Id string (Read-only) Brand ID, used for read (faux-create). Setting
brand_id
todefault
is equivalent to importing the default brand by its ID.Okta has fully support brand creation, this attribute is a no op and will be removed
- custom
Privacy stringPolicy Url Custom privacy policy URL
- default
App stringApp Instance Id Default app app instance id
- default
App stringApp Link Name Default app app link name
- default
App stringClassic Application Uri Default app classic application uri
- email
Domain stringId Email Domain ID tied to this brand
- is
Default 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
- remove
Powered booleanBy Okta Removes "Powered by Okta" from the Okta-hosted sign-in page, and "© 2021 Okta, Inc." from the Okta End-User Dashboard
- agree_
to_ boolcustom_ privacy_ policy 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
todefault
is equivalent to importing the default brand by its ID.Okta has fully support brand creation, this attribute is a no op and will be removed
- custom_
privacy_ strpolicy_ url Custom privacy policy URL
- default_
app_ strapp_ instance_ id Default app app instance id
- default_
app_ strapp_ link_ name Default app app link name
- default_
app_ strclassic_ application_ uri Default app classic application uri
- email_
domain_ strid 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_ boolby_ okta Removes "Powered by Okta" from the Okta-hosted sign-in page, and "© 2021 Okta, Inc." from the Okta End-User Dashboard
- agree
To BooleanCustom Privacy Policy Is a required input flag with when changing custom_privacy_url, shouldn't be considered as a readable property
- brand
Id String (Read-only) Brand ID, used for read (faux-create). Setting
brand_id
todefault
is equivalent to importing the default brand by its ID.Okta has fully support brand creation, this attribute is a no op and will be removed
- custom
Privacy StringPolicy Url Custom privacy policy URL
- default
App StringApp Instance Id Default app app instance id
- default
App StringApp Link Name Default app app link name
- default
App StringClassic Application Uri Default app classic application uri
- email
Domain StringId Email Domain ID tied to this brand
- is
Default 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
- remove
Powered BooleanBy Okta 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 <brand id>
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
okta
Terraform Provider.