Viewing docs for Okta v6.3.1
published on Thursday, Mar 12, 2026 by Pulumi
published on Thursday, Mar 12, 2026 by Pulumi
Viewing docs for Okta v6.3.1
published on Thursday, Mar 12, 2026 by Pulumi
published on Thursday, Mar 12, 2026 by Pulumi
Get a domain from Okta.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";
const example = new okta.Domain("example", {name: "www.example.com"});
const by_name = okta.getDomain({
domainIdOrName: "www.example.com",
});
const by_id = okta.getDomainOutput({
domainIdOrName: example.id,
});
import pulumi
import pulumi_okta as okta
example = okta.Domain("example", name="www.example.com")
by_name = okta.get_domain(domain_id_or_name="www.example.com")
by_id = okta.get_domain_output(domain_id_or_name=example.id)
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 {
example, err := okta.NewDomain(ctx, "example", &okta.DomainArgs{
Name: pulumi.String("www.example.com"),
})
if err != nil {
return err
}
_, err = okta.LookupDomain(ctx, &okta.LookupDomainArgs{
DomainIdOrName: "www.example.com",
}, nil)
if err != nil {
return err
}
_ = okta.LookupDomainOutput(ctx, okta.GetDomainOutputArgs{
DomainIdOrName: example.ID(),
}, nil)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;
return await Deployment.RunAsync(() =>
{
var example = new Okta.Domain("example", new()
{
Name = "www.example.com",
});
var by_name = Okta.GetDomain.Invoke(new()
{
DomainIdOrName = "www.example.com",
});
var by_id = Okta.GetDomain.Invoke(new()
{
DomainIdOrName = example.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.Domain;
import com.pulumi.okta.DomainArgs;
import com.pulumi.okta.OktaFunctions;
import com.pulumi.okta.inputs.GetDomainArgs;
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 Domain("example", DomainArgs.builder()
.name("www.example.com")
.build());
final var by-name = OktaFunctions.getDomain(GetDomainArgs.builder()
.domainIdOrName("www.example.com")
.build());
final var by-id = OktaFunctions.getDomain(GetDomainArgs.builder()
.domainIdOrName(example.id())
.build());
}
}
resources:
example:
type: okta:Domain
properties:
name: www.example.com
variables:
by-name:
fn::invoke:
function: okta:getDomain
arguments:
domainIdOrName: www.example.com
by-id:
fn::invoke:
function: okta:getDomain
arguments:
domainIdOrName: ${example.id}
Using getDomain
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 getDomain(args: GetDomainArgs, opts?: InvokeOptions): Promise<GetDomainResult>
function getDomainOutput(args: GetDomainOutputArgs, opts?: InvokeOptions): Output<GetDomainResult>def get_domain(domain_id_or_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDomainResult
def get_domain_output(domain_id_or_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDomainResult]func LookupDomain(ctx *Context, args *LookupDomainArgs, opts ...InvokeOption) (*LookupDomainResult, error)
func LookupDomainOutput(ctx *Context, args *LookupDomainOutputArgs, opts ...InvokeOption) LookupDomainResultOutput> Note: This function is named LookupDomain in the Go SDK.
public static class GetDomain
{
public static Task<GetDomainResult> InvokeAsync(GetDomainArgs args, InvokeOptions? opts = null)
public static Output<GetDomainResult> Invoke(GetDomainInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
public static Output<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
fn::invoke:
function: okta:index/getDomain:getDomain
arguments:
# arguments dictionaryThe following arguments are supported:
- Domain
Id stringOr Name - Brand ID
- Domain
Id stringOr Name - Brand ID
- domain
Id StringOr Name - Brand ID
- domain
Id stringOr Name - Brand ID
- domain_
id_ stror_ name - Brand ID
- domain
Id StringOr Name - Brand ID
getDomain Result
The following output properties are available:
- Certificate
Source stringType - Certificate source type that indicates whether the certificate is provided by the user or Okta. Values: MANUAL, OKTA_MANAGED
- Dns
Records List<GetDomain Dns Record> - TXT and CNAME records to be registered for the Domain
- Domain string
- Domain name
- Domain
Id stringOr Name - Brand ID
- Id string
- The ID of the Domain
- Public
Certificate Dictionary<string, string> - Certificate metadata for the Domain
- Validation
Status string - Status of the domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED
- Certificate
Source stringType - Certificate source type that indicates whether the certificate is provided by the user or Okta. Values: MANUAL, OKTA_MANAGED
- Dns
Records []GetDomain Dns Record - TXT and CNAME records to be registered for the Domain
- Domain string
- Domain name
- Domain
Id stringOr Name - Brand ID
- Id string
- The ID of the Domain
- Public
Certificate map[string]string - Certificate metadata for the Domain
- Validation
Status string - Status of the domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED
- certificate
Source StringType - Certificate source type that indicates whether the certificate is provided by the user or Okta. Values: MANUAL, OKTA_MANAGED
- dns
Records List<GetDomain Dns Record> - TXT and CNAME records to be registered for the Domain
- domain String
- Domain name
- domain
Id StringOr Name - Brand ID
- id String
- The ID of the Domain
- public
Certificate Map<String,String> - Certificate metadata for the Domain
- validation
Status String - Status of the domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED
- certificate
Source stringType - Certificate source type that indicates whether the certificate is provided by the user or Okta. Values: MANUAL, OKTA_MANAGED
- dns
Records GetDomain Dns Record[] - TXT and CNAME records to be registered for the Domain
- domain string
- Domain name
- domain
Id stringOr Name - Brand ID
- id string
- The ID of the Domain
- public
Certificate {[key: string]: string} - Certificate metadata for the Domain
- validation
Status string - Status of the domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED
- certificate_
source_ strtype - Certificate source type that indicates whether the certificate is provided by the user or Okta. Values: MANUAL, OKTA_MANAGED
- dns_
records Sequence[GetDomain Dns Record] - TXT and CNAME records to be registered for the Domain
- domain str
- Domain name
- domain_
id_ stror_ name - Brand ID
- id str
- The ID of the Domain
- public_
certificate Mapping[str, str] - Certificate metadata for the Domain
- validation_
status str - Status of the domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED
- certificate
Source StringType - Certificate source type that indicates whether the certificate is provided by the user or Okta. Values: MANUAL, OKTA_MANAGED
- dns
Records List<Property Map> - TXT and CNAME records to be registered for the Domain
- domain String
- Domain name
- domain
Id StringOr Name - Brand ID
- id String
- The ID of the Domain
- public
Certificate Map<String> - Certificate metadata for the Domain
- validation
Status String - Status of the domain. Values: NOTSTARTED, INPROGRESS, VERIFIED, COMPLETED
Supporting Types
GetDomainDnsRecord
- Expiration string
- TXT record expiration
- Fqdn string
- DNS record name
- Record
Type string - Record type can be TXT or CNAME
- Values List<string>
- DNS verification value
- Expiration string
- TXT record expiration
- Fqdn string
- DNS record name
- Record
Type string - Record type can be TXT or CNAME
- Values []string
- DNS verification value
- expiration String
- TXT record expiration
- fqdn String
- DNS record name
- record
Type String - Record type can be TXT or CNAME
- values List<String>
- DNS verification value
- expiration string
- TXT record expiration
- fqdn string
- DNS record name
- record
Type string - Record type can be TXT or CNAME
- values string[]
- DNS verification value
- expiration str
- TXT record expiration
- fqdn str
- DNS record name
- record_
type str - Record type can be TXT or CNAME
- values Sequence[str]
- DNS verification value
- expiration String
- TXT record expiration
- fqdn String
- DNS record name
- record
Type String - Record type can be TXT or CNAME
- values List<String>
- DNS verification value
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oktaTerraform Provider.
Viewing docs for Okta v6.3.1
published on Thursday, Mar 12, 2026 by Pulumi
published on Thursday, Mar 12, 2026 by Pulumi
