1. Packages
  2. Okta
  3. API Docs
  4. EmailDomainVerification
Okta v4.9.1 published on Monday, Jan 1, 0001 by Pulumi

okta.EmailDomainVerification

Explore with Pulumi AI

okta logo
Okta v4.9.1 published on Monday, Jan 1, 0001 by Pulumi

    Verifies the email domain. The resource won’t be created if the email domain could not be verified.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = new okta.EmailDomain("example", {
        brandId: "abc123",
        domain: "example.com",
        displayName: "test",
        userName: "paul_atreides",
    });
    const exampleEmailDomainVerification = new okta.EmailDomainVerification("example", {emailDomainId: valid.id});
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.EmailDomain("example",
        brand_id="abc123",
        domain="example.com",
        display_name="test",
        user_name="paul_atreides")
    example_email_domain_verification = okta.EmailDomainVerification("example", email_domain_id=valid["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.NewEmailDomain(ctx, "example", &okta.EmailDomainArgs{
    			BrandId:     pulumi.String("abc123"),
    			Domain:      pulumi.String("example.com"),
    			DisplayName: pulumi.String("test"),
    			UserName:    pulumi.String("paul_atreides"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = okta.NewEmailDomainVerification(ctx, "example", &okta.EmailDomainVerificationArgs{
    			EmailDomainId: pulumi.Any(valid.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.EmailDomain("example", new()
        {
            BrandId = "abc123",
            Domain = "example.com",
            DisplayName = "test",
            UserName = "paul_atreides",
        });
    
        var exampleEmailDomainVerification = new Okta.EmailDomainVerification("example", new()
        {
            EmailDomainId = valid.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.EmailDomain;
    import com.pulumi.okta.EmailDomainArgs;
    import com.pulumi.okta.EmailDomainVerification;
    import com.pulumi.okta.EmailDomainVerificationArgs;
    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 EmailDomain("example", EmailDomainArgs.builder()
                .brandId("abc123")
                .domain("example.com")
                .displayName("test")
                .userName("paul_atreides")
                .build());
    
            var exampleEmailDomainVerification = new EmailDomainVerification("exampleEmailDomainVerification", EmailDomainVerificationArgs.builder()
                .emailDomainId(valid.id())
                .build());
    
        }
    }
    
    resources:
      example:
        type: okta:EmailDomain
        properties:
          brandId: abc123
          domain: example.com
          displayName: test
          userName: paul_atreides
      exampleEmailDomainVerification:
        type: okta:EmailDomainVerification
        name: example
        properties:
          emailDomainId: ${valid.id}
    

    Create EmailDomainVerification Resource

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

    Constructor syntax

    new EmailDomainVerification(name: string, args: EmailDomainVerificationArgs, opts?: CustomResourceOptions);
    @overload
    def EmailDomainVerification(resource_name: str,
                                args: EmailDomainVerificationArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def EmailDomainVerification(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                email_domain_id: Optional[str] = None)
    func NewEmailDomainVerification(ctx *Context, name string, args EmailDomainVerificationArgs, opts ...ResourceOption) (*EmailDomainVerification, error)
    public EmailDomainVerification(string name, EmailDomainVerificationArgs args, CustomResourceOptions? opts = null)
    public EmailDomainVerification(String name, EmailDomainVerificationArgs args)
    public EmailDomainVerification(String name, EmailDomainVerificationArgs args, CustomResourceOptions options)
    
    type: okta:EmailDomainVerification
    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 EmailDomainVerificationArgs
    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 EmailDomainVerificationArgs
    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 EmailDomainVerificationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailDomainVerificationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EmailDomainVerificationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var emailDomainVerificationResource = new Okta.EmailDomainVerification("emailDomainVerificationResource", new()
    {
        EmailDomainId = "string",
    });
    
    example, err := okta.NewEmailDomainVerification(ctx, "emailDomainVerificationResource", &okta.EmailDomainVerificationArgs{
    	EmailDomainId: pulumi.String("string"),
    })
    
    var emailDomainVerificationResource = new EmailDomainVerification("emailDomainVerificationResource", EmailDomainVerificationArgs.builder()
        .emailDomainId("string")
        .build());
    
    email_domain_verification_resource = okta.EmailDomainVerification("emailDomainVerificationResource", email_domain_id="string")
    
    const emailDomainVerificationResource = new okta.EmailDomainVerification("emailDomainVerificationResource", {emailDomainId: "string"});
    
    type: okta:EmailDomainVerification
    properties:
        emailDomainId: string
    

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

    EmailDomainId string
    Email domain ID
    EmailDomainId string
    Email domain ID
    emailDomainId String
    Email domain ID
    emailDomainId string
    Email domain ID
    email_domain_id str
    Email domain ID
    emailDomainId String
    Email domain ID

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EmailDomainVerification 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 EmailDomainVerification Resource

    Get an existing EmailDomainVerification 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?: EmailDomainVerificationState, opts?: CustomResourceOptions): EmailDomainVerification
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            email_domain_id: Optional[str] = None) -> EmailDomainVerification
    func GetEmailDomainVerification(ctx *Context, name string, id IDInput, state *EmailDomainVerificationState, opts ...ResourceOption) (*EmailDomainVerification, error)
    public static EmailDomainVerification Get(string name, Input<string> id, EmailDomainVerificationState? state, CustomResourceOptions? opts = null)
    public static EmailDomainVerification get(String name, Output<String> id, EmailDomainVerificationState 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:
    EmailDomainId string
    Email domain ID
    EmailDomainId string
    Email domain ID
    emailDomainId String
    Email domain ID
    emailDomainId string
    Email domain ID
    email_domain_id str
    Email domain ID
    emailDomainId String
    Email domain 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.9.1 published on Monday, Jan 1, 0001 by Pulumi