1. Packages
  2. Okta
  3. API Docs
  4. getBrands
Okta v4.11.0 published on Tuesday, Sep 17, 2024 by Pulumi

okta.getBrands

Explore with Pulumi AI

okta logo
Okta v4.11.0 published on Tuesday, Sep 17, 2024 by Pulumi

    Get the brands belonging to an Okta organization.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const test = okta.getBrands({});
    
    import pulumi
    import pulumi_okta as okta
    
    test = okta.get_brands()
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := okta.GetBrands(ctx, nil, 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();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.OktaFunctions;
    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();
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          Function: okta:getBrands
          Arguments: {}
    

    Using getBrands

    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 getBrands(opts?: InvokeOptions): Promise<GetBrandsResult>
    function getBrandsOutput(opts?: InvokeOptions): Output<GetBrandsResult>
    def get_brands(opts: Optional[InvokeOptions] = None) -> GetBrandsResult
    def get_brands_output(opts: Optional[InvokeOptions] = None) -> Output[GetBrandsResult]
    func GetBrands(ctx *Context, opts ...InvokeOption) (*GetBrandsResult, error)
    func GetBrandsOutput(ctx *Context, opts ...InvokeOption) GetBrandsResultOutput

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

    public static class GetBrands 
    {
        public static Task<GetBrandsResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetBrandsResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBrandsResult> getBrands(InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: okta:index/getBrands:getBrands
      arguments:
        # arguments dictionary

    getBrands Result

    The following output properties are available:

    Brands List<GetBrandsBrand>
    List of okta.Brand belonging to the organization
    Id string
    The provider-assigned unique ID for this managed resource.
    Brands []GetBrandsBrand
    List of okta.Brand belonging to the organization
    Id string
    The provider-assigned unique ID for this managed resource.
    brands List<GetBrandsBrand>
    List of okta.Brand belonging to the organization
    id String
    The provider-assigned unique ID for this managed resource.
    brands GetBrandsBrand[]
    List of okta.Brand belonging to the organization
    id string
    The provider-assigned unique ID for this managed resource.
    brands Sequence[GetBrandsBrand]
    List of okta.Brand belonging to the organization
    id str
    The provider-assigned unique ID for this managed resource.
    brands List<Property Map>
    List of okta.Brand belonging to the organization
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GetBrandsBrand

    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
    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
    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
    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
    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
    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 v4.11.0 published on Tuesday, Sep 17, 2024 by Pulumi