Okta

Pulumi Official
Package maintained by Pulumi
v3.15.0 published on Tuesday, Aug 16, 2022 by Pulumi

Domain

Manages custom domain for your organization.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Okta = Pulumi.Okta;

return await Deployment.RunAsync(() => 
{
    var example = new Okta.Domain("example");

});
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.NewDomain(ctx, "example", nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.Domain;
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");

    }
}
import pulumi
import pulumi_okta as okta

example = okta.Domain("example")
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = new okta.Domain("example", {});
resources:
  example:
    type: okta:Domain

Create a Domain Resource

new Domain(name: string, args?: DomainArgs, opts?: CustomResourceOptions);
@overload
def Domain(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           certificate_source_type: Optional[str] = None,
           name: Optional[str] = None,
           verify: Optional[bool] = None)
@overload
def Domain(resource_name: str,
           args: Optional[DomainArgs] = None,
           opts: Optional[ResourceOptions] = None)
func NewDomain(ctx *Context, name string, args *DomainArgs, opts ...ResourceOption) (*Domain, error)
public Domain(string name, DomainArgs? args = null, CustomResourceOptions? opts = null)
public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)
type: okta:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DomainArgs
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 DomainArgs
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 DomainArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DomainArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Domain 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 Domain resource accepts the following input properties:

CertificateSourceType string

Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values: MANUAL, OKTA_MANAGED. Default value = MANUAL

Name string

Custom Domain name.

Verify bool

Indicates whether the domain should be verified.

  • DEPRECATED: Please use okta.DomainVerification resource instead.

Deprecated:

The direct validation for the domain resource is deprecated, please use the okta_domain_verification resource for this functionality.

CertificateSourceType string

Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values: MANUAL, OKTA_MANAGED. Default value = MANUAL

Name string

Custom Domain name.

Verify bool

Indicates whether the domain should be verified.

  • DEPRECATED: Please use okta.DomainVerification resource instead.

Deprecated:

The direct validation for the domain resource is deprecated, please use the okta_domain_verification resource for this functionality.

certificateSourceType String

Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values: MANUAL, OKTA_MANAGED. Default value = MANUAL

name String

Custom Domain name.

verify Boolean

Indicates whether the domain should be verified.

  • DEPRECATED: Please use okta.DomainVerification resource instead.

Deprecated:

The direct validation for the domain resource is deprecated, please use the okta_domain_verification resource for this functionality.

certificateSourceType string

Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values: MANUAL, OKTA_MANAGED. Default value = MANUAL

name string

Custom Domain name.

verify boolean

Indicates whether the domain should be verified.

  • DEPRECATED: Please use okta.DomainVerification resource instead.

Deprecated:

The direct validation for the domain resource is deprecated, please use the okta_domain_verification resource for this functionality.

certificate_source_type str

Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values: MANUAL, OKTA_MANAGED. Default value = MANUAL

name str

Custom Domain name.

verify bool

Indicates whether the domain should be verified.

  • DEPRECATED: Please use okta.DomainVerification resource instead.

Deprecated:

The direct validation for the domain resource is deprecated, please use the okta_domain_verification resource for this functionality.

certificateSourceType String

Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values: MANUAL, OKTA_MANAGED. Default value = MANUAL

name String

Custom Domain name.

verify Boolean

Indicates whether the domain should be verified.

  • DEPRECATED: Please use okta.DomainVerification resource instead.

Deprecated:

The direct validation for the domain resource is deprecated, please use the okta_domain_verification resource for this functionality.

Outputs

All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:

DnsRecords List<DomainDnsRecord>

TXT and CNAME records to be registered for the Domain.

Id string

The provider-assigned unique ID for this managed resource.

ValidationStatus string

Status of the domain.

DnsRecords []DomainDnsRecord

TXT and CNAME records to be registered for the Domain.

Id string

The provider-assigned unique ID for this managed resource.

ValidationStatus string

Status of the domain.

dnsRecords List<DomainDnsRecord>

TXT and CNAME records to be registered for the Domain.

id String

The provider-assigned unique ID for this managed resource.

validationStatus String

Status of the domain.

dnsRecords DomainDnsRecord[]

TXT and CNAME records to be registered for the Domain.

id string

The provider-assigned unique ID for this managed resource.

validationStatus string

Status of the domain.

dns_records Sequence[DomainDnsRecord]

TXT and CNAME records to be registered for the Domain.

id str

The provider-assigned unique ID for this managed resource.

validation_status str

Status of the domain.

dnsRecords List<Property Map>

TXT and CNAME records to be registered for the Domain.

id String

The provider-assigned unique ID for this managed resource.

validationStatus String

Status of the domain.

Look up an Existing Domain Resource

Get an existing Domain 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?: DomainState, opts?: CustomResourceOptions): Domain
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificate_source_type: Optional[str] = None,
        dns_records: Optional[Sequence[DomainDnsRecordArgs]] = None,
        name: Optional[str] = None,
        validation_status: Optional[str] = None,
        verify: Optional[bool] = None) -> Domain
func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)
public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)
public static Domain get(String name, Output<String> id, DomainState 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:
CertificateSourceType string

Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values: MANUAL, OKTA_MANAGED. Default value = MANUAL

DnsRecords List<DomainDnsRecordArgs>

TXT and CNAME records to be registered for the Domain.

Name string

Custom Domain name.

ValidationStatus string

Status of the domain.

Verify bool

Indicates whether the domain should be verified.

  • DEPRECATED: Please use okta.DomainVerification resource instead.

Deprecated:

The direct validation for the domain resource is deprecated, please use the okta_domain_verification resource for this functionality.

CertificateSourceType string

Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values: MANUAL, OKTA_MANAGED. Default value = MANUAL

DnsRecords []DomainDnsRecordArgs

TXT and CNAME records to be registered for the Domain.

Name string

Custom Domain name.

ValidationStatus string

Status of the domain.

Verify bool

Indicates whether the domain should be verified.

  • DEPRECATED: Please use okta.DomainVerification resource instead.

Deprecated:

The direct validation for the domain resource is deprecated, please use the okta_domain_verification resource for this functionality.

certificateSourceType String

Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values: MANUAL, OKTA_MANAGED. Default value = MANUAL

dnsRecords List<DomainDnsRecordArgs>

TXT and CNAME records to be registered for the Domain.

name String

Custom Domain name.

validationStatus String

Status of the domain.

verify Boolean

Indicates whether the domain should be verified.

  • DEPRECATED: Please use okta.DomainVerification resource instead.

Deprecated:

The direct validation for the domain resource is deprecated, please use the okta_domain_verification resource for this functionality.

certificateSourceType string

Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values: MANUAL, OKTA_MANAGED. Default value = MANUAL

dnsRecords DomainDnsRecordArgs[]

TXT and CNAME records to be registered for the Domain.

name string

Custom Domain name.

validationStatus string

Status of the domain.

verify boolean

Indicates whether the domain should be verified.

  • DEPRECATED: Please use okta.DomainVerification resource instead.

Deprecated:

The direct validation for the domain resource is deprecated, please use the okta_domain_verification resource for this functionality.

certificate_source_type str

Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values: MANUAL, OKTA_MANAGED. Default value = MANUAL

dns_records Sequence[DomainDnsRecordArgs]

TXT and CNAME records to be registered for the Domain.

name str

Custom Domain name.

validation_status str

Status of the domain.

verify bool

Indicates whether the domain should be verified.

  • DEPRECATED: Please use okta.DomainVerification resource instead.

Deprecated:

The direct validation for the domain resource is deprecated, please use the okta_domain_verification resource for this functionality.

certificateSourceType String

Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values: MANUAL, OKTA_MANAGED. Default value = MANUAL

dnsRecords List<Property Map>

TXT and CNAME records to be registered for the Domain.

name String

Custom Domain name.

validationStatus String

Status of the domain.

verify Boolean

Indicates whether the domain should be verified.

  • DEPRECATED: Please use okta.DomainVerification resource instead.

Deprecated:

The direct validation for the domain resource is deprecated, please use the okta_domain_verification resource for this functionality.

Supporting Types

DomainDnsRecord

Expiration string

TXT record expiration.

Fqdn string

DNS record name.

RecordType string

Record type can be TXT or CNAME.

Values List<string>

DNS verification value

Expiration string

TXT record expiration.

Fqdn string

DNS record name.

RecordType string

Record type can be TXT or CNAME.

Values []string

DNS verification value

expiration String

TXT record expiration.

fqdn String

DNS record name.

recordType String

Record type can be TXT or CNAME.

values List<String>

DNS verification value

expiration string

TXT record expiration.

fqdn string

DNS record name.

recordType 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.

recordType String

Record type can be TXT or CNAME.

values List<String>

DNS verification value

Import

Okta Admin Role Targets can be imported via the Okta ID.

 $ pulumi import okta:index/domain:Domain example &#60;domain_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.