Okta

Pulumi Official
Package maintained by Pulumi
v3.11.0 published on Monday, Jun 13, 2022 by Pulumi

Brand

This resource allows you to get and update an Okta Brand.

Brands are can only be updated through the Okta API. Therefore this resource only gets and updates a brand.

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        // resource has been imported into current state
        // $ terraform import okta_brand.example <brand id>
        var example = new Okta.Brand("example", new Okta.BrandArgs
        {
            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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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:
  example:
    type: okta:Brand
    properties:
      agreeToCustomPrivacyPolicy: true
      customPrivacyPolicyUrl: https://example.com/privacy-policy
      removePoweredByOkta: true

Create a 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)
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

Brand ID, used for read (faux-create)

CustomPrivacyPolicyUrl string

(Optional) Custom privacy policy URL

RemovePoweredByOkta bool

(Optional) 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

Brand ID, used for read (faux-create)

CustomPrivacyPolicyUrl string

(Optional) Custom privacy policy URL

RemovePoweredByOkta bool

(Optional) 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

Brand ID, used for read (faux-create)

customPrivacyPolicyUrl String

(Optional) Custom privacy policy URL

removePoweredByOkta Boolean

(Optional) 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

Brand ID, used for read (faux-create)

customPrivacyPolicyUrl string

(Optional) Custom privacy policy URL

removePoweredByOkta boolean

(Optional) 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

Brand ID, used for read (faux-create)

custom_privacy_policy_url str

(Optional) Custom privacy policy URL

remove_powered_by_okta bool

(Optional) 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

Brand ID, used for read (faux-create)

customPrivacyPolicyUrl String

(Optional) Custom privacy policy URL

removePoweredByOkta Boolean

(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:

Id string

The provider-assigned unique ID for this managed resource.

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.

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.

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.

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.

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.

links String

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

Look up an 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.
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

Brand ID, used for read (faux-create)

CustomPrivacyPolicyUrl string

(Optional) Custom privacy policy URL

Links string

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

RemovePoweredByOkta bool

(Optional) 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

Brand ID, used for read (faux-create)

CustomPrivacyPolicyUrl string

(Optional) Custom privacy policy URL

Links string

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

RemovePoweredByOkta bool

(Optional) 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

Brand ID, used for read (faux-create)

customPrivacyPolicyUrl String

(Optional) Custom privacy policy URL

links String

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

removePoweredByOkta Boolean

(Optional) 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

Brand ID, used for read (faux-create)

customPrivacyPolicyUrl string

(Optional) Custom privacy policy URL

links string

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

removePoweredByOkta boolean

(Optional) 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

Brand ID, used for read (faux-create)

custom_privacy_policy_url str

(Optional) Custom privacy policy URL

links str

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

remove_powered_by_okta bool

(Optional) 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

Brand ID, used for read (faux-create)

customPrivacyPolicyUrl String

(Optional) Custom privacy policy URL

links String

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

removePoweredByOkta Boolean

(Optional) 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
https://github.com/pulumi/pulumi-okta
License
Apache-2.0
Notes

This Pulumi package is based on the okta Terraform Provider.