1. Packages
  2. HashiCorp Vault
  3. API Docs
  4. identity
  5. MfaOkta
HashiCorp Vault v5.15.0 published on Friday, Sep 8, 2023 by Pulumi

vault.identity.MfaOkta

Explore with Pulumi AI

vault logo
HashiCorp Vault v5.15.0 published on Friday, Sep 8, 2023 by Pulumi

    Resource for configuring the okta MFA method.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Vault = Pulumi.Vault;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Vault.Identity.MfaOkta("example", new()
        {
            ApiToken = "token1",
            BaseUrl = "qux.baz.com",
            OrgName = "org1",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-vault/sdk/v5/go/vault/identity"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := identity.NewMfaOkta(ctx, "example", &identity.MfaOktaArgs{
    			ApiToken: pulumi.String("token1"),
    			BaseUrl:  pulumi.String("qux.baz.com"),
    			OrgName:  pulumi.String("org1"),
    		})
    		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.vault.identity.MfaOkta;
    import com.pulumi.vault.identity.MfaOktaArgs;
    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 MfaOkta("example", MfaOktaArgs.builder()        
                .apiToken("token1")
                .baseUrl("qux.baz.com")
                .orgName("org1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_vault as vault
    
    example = vault.identity.MfaOkta("example",
        api_token="token1",
        base_url="qux.baz.com",
        org_name="org1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as vault from "@pulumi/vault";
    
    const example = new vault.identity.MfaOkta("example", {
        apiToken: "token1",
        baseUrl: "qux.baz.com",
        orgName: "org1",
    });
    
    resources:
      example:
        type: vault:identity:MfaOkta
        properties:
          apiToken: token1
          baseUrl: qux.baz.com
          orgName: org1
    

    Create MfaOkta Resource

    new MfaOkta(name: string, args: MfaOktaArgs, opts?: CustomResourceOptions);
    @overload
    def MfaOkta(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                api_token: Optional[str] = None,
                base_url: Optional[str] = None,
                namespace: Optional[str] = None,
                org_name: Optional[str] = None,
                primary_email: Optional[bool] = None,
                username_format: Optional[str] = None)
    @overload
    def MfaOkta(resource_name: str,
                args: MfaOktaArgs,
                opts: Optional[ResourceOptions] = None)
    func NewMfaOkta(ctx *Context, name string, args MfaOktaArgs, opts ...ResourceOption) (*MfaOkta, error)
    public MfaOkta(string name, MfaOktaArgs args, CustomResourceOptions? opts = null)
    public MfaOkta(String name, MfaOktaArgs args)
    public MfaOkta(String name, MfaOktaArgs args, CustomResourceOptions options)
    
    type: vault:identity:MfaOkta
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args MfaOktaArgs
    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 MfaOktaArgs
    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 MfaOktaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MfaOktaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MfaOktaArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ApiToken string

    Okta API token.

    OrgName string

    Name of the organization to be used in the Okta API.

    BaseUrl string

    The base domain to use for API requests.

    Namespace string

    Target namespace. (requires Enterprise)

    PrimaryEmail bool

    Only match the primary email for the account.

    UsernameFormat string

    A template string for mapping Identity names to MFA methods.

    ApiToken string

    Okta API token.

    OrgName string

    Name of the organization to be used in the Okta API.

    BaseUrl string

    The base domain to use for API requests.

    Namespace string

    Target namespace. (requires Enterprise)

    PrimaryEmail bool

    Only match the primary email for the account.

    UsernameFormat string

    A template string for mapping Identity names to MFA methods.

    apiToken String

    Okta API token.

    orgName String

    Name of the organization to be used in the Okta API.

    baseUrl String

    The base domain to use for API requests.

    namespace String

    Target namespace. (requires Enterprise)

    primaryEmail Boolean

    Only match the primary email for the account.

    usernameFormat String

    A template string for mapping Identity names to MFA methods.

    apiToken string

    Okta API token.

    orgName string

    Name of the organization to be used in the Okta API.

    baseUrl string

    The base domain to use for API requests.

    namespace string

    Target namespace. (requires Enterprise)

    primaryEmail boolean

    Only match the primary email for the account.

    usernameFormat string

    A template string for mapping Identity names to MFA methods.

    api_token str

    Okta API token.

    org_name str

    Name of the organization to be used in the Okta API.

    base_url str

    The base domain to use for API requests.

    namespace str

    Target namespace. (requires Enterprise)

    primary_email bool

    Only match the primary email for the account.

    username_format str

    A template string for mapping Identity names to MFA methods.

    apiToken String

    Okta API token.

    orgName String

    Name of the organization to be used in the Okta API.

    baseUrl String

    The base domain to use for API requests.

    namespace String

    Target namespace. (requires Enterprise)

    primaryEmail Boolean

    Only match the primary email for the account.

    usernameFormat String

    A template string for mapping Identity names to MFA methods.

    Outputs

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

    Id string

    The provider-assigned unique ID for this managed resource.

    MethodId string

    Method ID.

    MountAccessor string

    Mount accessor.

    Name string

    Method name.

    NamespaceId string

    Method's namespace ID.

    NamespacePath string

    Method's namespace path.

    Type string

    MFA type.

    Uuid string

    Resource UUID.

    Id string

    The provider-assigned unique ID for this managed resource.

    MethodId string

    Method ID.

    MountAccessor string

    Mount accessor.

    Name string

    Method name.

    NamespaceId string

    Method's namespace ID.

    NamespacePath string

    Method's namespace path.

    Type string

    MFA type.

    Uuid string

    Resource UUID.

    id String

    The provider-assigned unique ID for this managed resource.

    methodId String

    Method ID.

    mountAccessor String

    Mount accessor.

    name String

    Method name.

    namespaceId String

    Method's namespace ID.

    namespacePath String

    Method's namespace path.

    type String

    MFA type.

    uuid String

    Resource UUID.

    id string

    The provider-assigned unique ID for this managed resource.

    methodId string

    Method ID.

    mountAccessor string

    Mount accessor.

    name string

    Method name.

    namespaceId string

    Method's namespace ID.

    namespacePath string

    Method's namespace path.

    type string

    MFA type.

    uuid string

    Resource UUID.

    id str

    The provider-assigned unique ID for this managed resource.

    method_id str

    Method ID.

    mount_accessor str

    Mount accessor.

    name str

    Method name.

    namespace_id str

    Method's namespace ID.

    namespace_path str

    Method's namespace path.

    type str

    MFA type.

    uuid str

    Resource UUID.

    id String

    The provider-assigned unique ID for this managed resource.

    methodId String

    Method ID.

    mountAccessor String

    Mount accessor.

    name String

    Method name.

    namespaceId String

    Method's namespace ID.

    namespacePath String

    Method's namespace path.

    type String

    MFA type.

    uuid String

    Resource UUID.

    Look up Existing MfaOkta Resource

    Get an existing MfaOkta 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?: MfaOktaState, opts?: CustomResourceOptions): MfaOkta
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_token: Optional[str] = None,
            base_url: Optional[str] = None,
            method_id: Optional[str] = None,
            mount_accessor: Optional[str] = None,
            name: Optional[str] = None,
            namespace: Optional[str] = None,
            namespace_id: Optional[str] = None,
            namespace_path: Optional[str] = None,
            org_name: Optional[str] = None,
            primary_email: Optional[bool] = None,
            type: Optional[str] = None,
            username_format: Optional[str] = None,
            uuid: Optional[str] = None) -> MfaOkta
    func GetMfaOkta(ctx *Context, name string, id IDInput, state *MfaOktaState, opts ...ResourceOption) (*MfaOkta, error)
    public static MfaOkta Get(string name, Input<string> id, MfaOktaState? state, CustomResourceOptions? opts = null)
    public static MfaOkta get(String name, Output<String> id, MfaOktaState 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:
    ApiToken string

    Okta API token.

    BaseUrl string

    The base domain to use for API requests.

    MethodId string

    Method ID.

    MountAccessor string

    Mount accessor.

    Name string

    Method name.

    Namespace string

    Target namespace. (requires Enterprise)

    NamespaceId string

    Method's namespace ID.

    NamespacePath string

    Method's namespace path.

    OrgName string

    Name of the organization to be used in the Okta API.

    PrimaryEmail bool

    Only match the primary email for the account.

    Type string

    MFA type.

    UsernameFormat string

    A template string for mapping Identity names to MFA methods.

    Uuid string

    Resource UUID.

    ApiToken string

    Okta API token.

    BaseUrl string

    The base domain to use for API requests.

    MethodId string

    Method ID.

    MountAccessor string

    Mount accessor.

    Name string

    Method name.

    Namespace string

    Target namespace. (requires Enterprise)

    NamespaceId string

    Method's namespace ID.

    NamespacePath string

    Method's namespace path.

    OrgName string

    Name of the organization to be used in the Okta API.

    PrimaryEmail bool

    Only match the primary email for the account.

    Type string

    MFA type.

    UsernameFormat string

    A template string for mapping Identity names to MFA methods.

    Uuid string

    Resource UUID.

    apiToken String

    Okta API token.

    baseUrl String

    The base domain to use for API requests.

    methodId String

    Method ID.

    mountAccessor String

    Mount accessor.

    name String

    Method name.

    namespace String

    Target namespace. (requires Enterprise)

    namespaceId String

    Method's namespace ID.

    namespacePath String

    Method's namespace path.

    orgName String

    Name of the organization to be used in the Okta API.

    primaryEmail Boolean

    Only match the primary email for the account.

    type String

    MFA type.

    usernameFormat String

    A template string for mapping Identity names to MFA methods.

    uuid String

    Resource UUID.

    apiToken string

    Okta API token.

    baseUrl string

    The base domain to use for API requests.

    methodId string

    Method ID.

    mountAccessor string

    Mount accessor.

    name string

    Method name.

    namespace string

    Target namespace. (requires Enterprise)

    namespaceId string

    Method's namespace ID.

    namespacePath string

    Method's namespace path.

    orgName string

    Name of the organization to be used in the Okta API.

    primaryEmail boolean

    Only match the primary email for the account.

    type string

    MFA type.

    usernameFormat string

    A template string for mapping Identity names to MFA methods.

    uuid string

    Resource UUID.

    api_token str

    Okta API token.

    base_url str

    The base domain to use for API requests.

    method_id str

    Method ID.

    mount_accessor str

    Mount accessor.

    name str

    Method name.

    namespace str

    Target namespace. (requires Enterprise)

    namespace_id str

    Method's namespace ID.

    namespace_path str

    Method's namespace path.

    org_name str

    Name of the organization to be used in the Okta API.

    primary_email bool

    Only match the primary email for the account.

    type str

    MFA type.

    username_format str

    A template string for mapping Identity names to MFA methods.

    uuid str

    Resource UUID.

    apiToken String

    Okta API token.

    baseUrl String

    The base domain to use for API requests.

    methodId String

    Method ID.

    mountAccessor String

    Mount accessor.

    name String

    Method name.

    namespace String

    Target namespace. (requires Enterprise)

    namespaceId String

    Method's namespace ID.

    namespacePath String

    Method's namespace path.

    orgName String

    Name of the organization to be used in the Okta API.

    primaryEmail Boolean

    Only match the primary email for the account.

    type String

    MFA type.

    usernameFormat String

    A template string for mapping Identity names to MFA methods.

    uuid String

    Resource UUID.

    Import

    Resource can be imported using its uuid field, e.g.

     $ pulumi import vault:identity/mfaOkta:MfaOkta example 0d89c36a-4ff5-4d70-8749-bb6a5598aeec
    

    Package Details

    Repository
    Vault pulumi/pulumi-vault
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the vault Terraform Provider.

    vault logo
    HashiCorp Vault v5.15.0 published on Friday, Sep 8, 2023 by Pulumi