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

okta.DomainVerification

Explore with Pulumi AI

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

    Verifies the Domain. This is replacement for the verify field from the okta.Domain resource. The resource won’t be created if the domain could not be verified. The provider will make several requests to verify the domain until the API returns VERIFIED verification status.

    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 exampleDomainVerification = new okta.DomainVerification("example", {domainId: test.id});
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.Domain("example", name="www.example.com")
    example_domain_verification = okta.DomainVerification("example", domain_id=test["id"])
    
    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.NewDomain(ctx, "example", &okta.DomainArgs{
    			Name: pulumi.String("www.example.com"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = okta.NewDomainVerification(ctx, "example", &okta.DomainVerificationArgs{
    			DomainId: pulumi.Any(test.Id),
    		})
    		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 example = new Okta.Domain("example", new()
        {
            Name = "www.example.com",
        });
    
        var exampleDomainVerification = new Okta.DomainVerification("example", new()
        {
            DomainId = test.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.DomainVerification;
    import com.pulumi.okta.DomainVerificationArgs;
    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());
    
            var exampleDomainVerification = new DomainVerification("exampleDomainVerification", DomainVerificationArgs.builder()
                .domainId(test.id())
                .build());
    
        }
    }
    
    resources:
      example:
        type: okta:Domain
        properties:
          name: www.example.com
      exampleDomainVerification:
        type: okta:DomainVerification
        name: example
        properties:
          domainId: ${test.id}
    

    Create DomainVerification Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

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

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var domainVerificationResource = new Okta.DomainVerification("domainVerificationResource", new()
    {
        DomainId = "string",
    });
    
    example, err := okta.NewDomainVerification(ctx, "domainVerificationResource", &okta.DomainVerificationArgs{
    	DomainId: pulumi.String("string"),
    })
    
    var domainVerificationResource = new DomainVerification("domainVerificationResource", DomainVerificationArgs.builder()
        .domainId("string")
        .build());
    
    domain_verification_resource = okta.DomainVerification("domainVerificationResource", domain_id="string")
    
    const domainVerificationResource = new okta.DomainVerification("domainVerificationResource", {domainId: "string"});
    
    type: okta:DomainVerification
    properties:
        domainId: string
    

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

    DomainId string
    Domain's ID
    DomainId string
    Domain's ID
    domainId String
    Domain's ID
    domainId string
    Domain's ID
    domain_id str
    Domain's ID
    domainId String
    Domain's ID

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DomainVerification Resource

    Get an existing DomainVerification 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?: DomainVerificationState, opts?: CustomResourceOptions): DomainVerification
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            domain_id: Optional[str] = None) -> DomainVerification
    func GetDomainVerification(ctx *Context, name string, id IDInput, state *DomainVerificationState, opts ...ResourceOption) (*DomainVerification, error)
    public static DomainVerification Get(string name, Input<string> id, DomainVerificationState? state, CustomResourceOptions? opts = null)
    public static DomainVerification get(String name, Output<String> id, DomainVerificationState 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:
    DomainId string
    Domain's ID
    DomainId string
    Domain's ID
    domainId String
    Domain's ID
    domainId string
    Domain's ID
    domain_id str
    Domain's ID
    domainId String
    Domain's ID

    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