Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta Provider
  3. API Docs
  4. getBrand
Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-okta

okta.getBrand

Explore with Pulumi AI

Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-okta

Get a single Brand from Okta.

Using getBrand

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getBrand(args: GetBrandArgs, opts?: InvokeOptions): Promise<GetBrandResult>
function getBrandOutput(args: GetBrandOutputArgs, opts?: InvokeOptions): Output<GetBrandResult>
Copy
def get_brand(brand_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetBrandResult
def get_brand_output(brand_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetBrandResult]
Copy
func LookupBrand(ctx *Context, args *LookupBrandArgs, opts ...InvokeOption) (*LookupBrandResult, error)
func LookupBrandOutput(ctx *Context, args *LookupBrandOutputArgs, opts ...InvokeOption) LookupBrandResultOutput
Copy

> Note: This function is named LookupBrand in the Go SDK.

public static class GetBrand 
{
    public static Task<GetBrandResult> InvokeAsync(GetBrandArgs args, InvokeOptions? opts = null)
    public static Output<GetBrandResult> Invoke(GetBrandInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBrandResult> getBrand(GetBrandArgs args, InvokeOptions options)
public static Output<GetBrandResult> getBrand(GetBrandArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: okta:index/getBrand:getBrand
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BrandId This property is required. string
Brand ID
BrandId This property is required. string
Brand ID
brandId This property is required. String
Brand ID
brandId This property is required. string
Brand ID
brand_id This property is required. str
Brand ID
brandId This property is required. String
Brand ID

getBrand Result

The following output properties are available:

BrandId string
Brand ID
CustomPrivacyPolicyUrl string
Custom privacy policy URL
Id string
The ID of the Brand
Links string
Link relations for this object - JSON HAL - Discoverable resources related to the brand
Name string
Brand name
RemovePoweredByOkta bool
Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard
BrandId string
Brand ID
CustomPrivacyPolicyUrl string
Custom privacy policy URL
Id string
The ID of the Brand
Links string
Link relations for this object - JSON HAL - Discoverable resources related to the brand
Name string
Brand name
RemovePoweredByOkta bool
Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard
brandId String
Brand ID
customPrivacyPolicyUrl String
Custom privacy policy URL
id String
The ID of the Brand
links String
Link relations for this object - JSON HAL - Discoverable resources related to the brand
name String
Brand name
removePoweredByOkta Boolean
Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard
brandId string
Brand ID
customPrivacyPolicyUrl string
Custom privacy policy URL
id string
The ID of the Brand
links string
Link relations for this object - JSON HAL - Discoverable resources related to the brand
name string
Brand name
removePoweredByOkta boolean
Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard
brand_id str
Brand ID
custom_privacy_policy_url str
Custom privacy policy URL
id str
The ID of the Brand
links str
Link relations for this object - JSON HAL - Discoverable resources related to the brand
name str
Brand name
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
brandId String
Brand ID
customPrivacyPolicyUrl String
Custom privacy policy URL
id String
The ID of the Brand
links String
Link relations for this object - JSON HAL - Discoverable resources related to the brand
name String
Brand name
removePoweredByOkta Boolean
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.
Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-okta