okta.Brand
Import
An Okta Brand can be imported via the ID.
$ pulumi import okta:index/brand:Brand example <brand id>
Example Usage
using System.Collections.Generic;
using Pulumi;
using Okta = Pulumi.Okta;
return await Deployment.RunAsync(() =>
{
// resource has been imported into current state
// $ terraform import okta_brand.example <brand id>
var example = new Okta.Brand("example", new()
{
AgreeToCustomPrivacyPolicy = true,
CustomPrivacyPolicyUrl = "https://example.com/privacy-policy",
RemovePoweredByOkta = true,
});
});
package main
import (
"github.com/pulumi/pulumi-okta/sdk/v3/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{
AgreeToCustomPrivacyPolicy: pulumi.Bool(true),
CustomPrivacyPolicyUrl: pulumi.String("https://example.com/privacy-policy"),
RemovePoweredByOkta: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
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()
.agreeToCustomPrivacyPolicy(true)
.customPrivacyPolicyUrl("https://example.com/privacy-policy")
.removePoweredByOkta(true)
.build());
}
}
import pulumi
import pulumi_okta as okta
# resource has been imported into current state
# $ terraform import okta_brand.example <brand id>
example = okta.Brand("example",
agree_to_custom_privacy_policy=True,
custom_privacy_policy_url="https://example.com/privacy-policy",
remove_powered_by_okta=True)
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";
// resource has been imported into current state
// $ terraform import okta_brand.example <brand id>
const example = new okta.Brand("example", {
agreeToCustomPrivacyPolicy: true,
customPrivacyPolicyUrl: "https://example.com/privacy-policy",
removePoweredByOkta: true,
});
resources:
# resource has been imported into current state
# // $ terraform import okta_brand.example <brand id>
example:
type: okta:Brand
properties:
agreeToCustomPrivacyPolicy: true
customPrivacyPolicyUrl: https://example.com/privacy-policy
removePoweredByOkta: true
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,
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 Brand ID, used for read (faux-create)
- Custom
Privacy stringPolicy Url (Optional) Custom privacy policy URL
- Remove
Powered boolBy Okta (Optional) 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 Brand ID, used for read (faux-create)
- Custom
Privacy stringPolicy Url (Optional) Custom privacy policy URL
- Remove
Powered boolBy Okta (Optional) 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 Brand ID, used for read (faux-create)
- custom
Privacy StringPolicy Url (Optional) Custom privacy policy URL
- remove
Powered BooleanBy Okta (Optional) 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 Brand ID, used for read (faux-create)
- custom
Privacy stringPolicy Url (Optional) Custom privacy policy URL
- remove
Powered booleanBy Okta (Optional) 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 Brand ID, used for read (faux-create)
- custom_
privacy_ strpolicy_ url (Optional) Custom privacy policy URL
- remove_
powered_ boolby_ okta (Optional) 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 Brand ID, used for read (faux-create)
- custom
Privacy StringPolicy Url (Optional) Custom privacy policy URL
- remove
Powered BooleanBy Okta (Optional) 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:
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,
links: 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 Brand ID, used for read (faux-create)
- Custom
Privacy stringPolicy Url (Optional) Custom privacy policy URL
- Links string
(Read-only) Link relations for this object - JSON HAL - Discoverable resources related to the brand
- Remove
Powered boolBy Okta (Optional) 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 Brand ID, used for read (faux-create)
- Custom
Privacy stringPolicy Url (Optional) Custom privacy policy URL
- Links string
(Read-only) Link relations for this object - JSON HAL - Discoverable resources related to the brand
- Remove
Powered boolBy Okta (Optional) 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 Brand ID, used for read (faux-create)
- custom
Privacy StringPolicy Url (Optional) Custom privacy policy URL
- links String
(Read-only) Link relations for this object - JSON HAL - Discoverable resources related to the brand
- remove
Powered BooleanBy Okta (Optional) 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 Brand ID, used for read (faux-create)
- custom
Privacy stringPolicy Url (Optional) Custom privacy policy URL
- links string
(Read-only) Link relations for this object - JSON HAL - Discoverable resources related to the brand
- remove
Powered booleanBy Okta (Optional) 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 Brand ID, used for read (faux-create)
- custom_
privacy_ strpolicy_ url (Optional) Custom privacy policy URL
- links str
(Read-only) Link relations for this object - JSON HAL - Discoverable resources related to the brand
- remove_
powered_ boolby_ okta (Optional) 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 Brand ID, used for read (faux-create)
- custom
Privacy StringPolicy Url (Optional) Custom privacy policy URL
- links String
(Read-only) Link relations for this object - JSON HAL - Discoverable resources related to the brand
- remove
Powered BooleanBy Okta (Optional) Removes "Powered by Okta" from the Okta-hosted sign-in page, and "© 2021 Okta, Inc." from the Okta End-User Dashboard
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
okta
Terraform Provider.