1. Packages
  2. Okta Provider
  3. API Docs
  4. getBrand
Okta v6.1.0 published on Wednesday, Oct 29, 2025 by Pulumi

okta.getBrand

Start a Neo task
Explain and create an okta.getBrand resource
okta logo
Okta v6.1.0 published on Wednesday, Oct 29, 2025 by Pulumi

    Get a single Brand from Okta.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const test = okta.getBrands({});
    const testGetBrand = test.then(test => okta.getBrand({
        brandId: test.brands?.[0]?.id,
    }));
    const _default = okta.getBrand({
        brandId: "default",
    });
    
    import pulumi
    import pulumi_okta as okta
    
    test = okta.get_brands()
    test_get_brand = okta.get_brand(brand_id=test.brands[0].id)
    default = okta.get_brand(brand_id="default")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v6/go/okta"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		test, err := okta.GetBrands(ctx, map[string]interface{}{}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = okta.LookupBrand(ctx, &okta.LookupBrandArgs{
    			BrandId: test.Brands[0].Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = okta.LookupBrand(ctx, &okta.LookupBrandArgs{
    			BrandId: "default",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Okta.GetBrands.Invoke();
    
        var testGetBrand = Okta.GetBrand.Invoke(new()
        {
            BrandId = test.Apply(getBrandsResult => getBrandsResult.Brands[0]?.Id),
        });
    
        var @default = Okta.GetBrand.Invoke(new()
        {
            BrandId = "default",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.OktaFunctions;
    import com.pulumi.okta.inputs.GetBrandArgs;
    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) {
            final var test = OktaFunctions.getBrands(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference);
    
            final var testGetBrand = OktaFunctions.getBrand(GetBrandArgs.builder()
                .brandId(test.brands()[0].id())
                .build());
    
            final var default = OktaFunctions.getBrand(GetBrandArgs.builder()
                .brandId("default")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: okta:getBrands
          arguments: {}
      testGetBrand:
        fn::invoke:
          function: okta:getBrand
          arguments:
            brandId: ${test.brands[0].id}
      default:
        fn::invoke:
          function: okta:getBrand
          arguments:
            brandId: default
    

    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>
    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]
    func LookupBrand(ctx *Context, args *LookupBrandArgs, opts ...InvokeOption) (*LookupBrandResult, error)
    func LookupBrandOutput(ctx *Context, args *LookupBrandOutputArgs, opts ...InvokeOption) LookupBrandResultOutput

    > 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)
    }
    public static CompletableFuture<GetBrandResult> getBrand(GetBrandArgs args, InvokeOptions options)
    public static Output<GetBrandResult> getBrand(GetBrandArgs args, InvokeOptions options)
    
    fn::invoke:
      function: okta:index/getBrand:getBrand
      arguments:
        # arguments dictionary

    The following arguments are supported:

    BrandId string
    Brand ID
    BrandId string
    Brand ID
    brandId String
    Brand ID
    brandId string
    Brand ID
    brand_id str
    Brand ID
    brandId 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 logo
    Okta v6.1.0 published on Wednesday, Oct 29, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate