Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta Provider
  3. API Docs
  4. Authenticator
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

okta.Authenticator

Explore with Pulumi AI

okta logo
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

    WARNING: This feature is only available as a part of the Identity Engine. Contact support for further information.

    This resource allows you to configure different authenticators.

    Create: The Okta API has an odd notion of create for authenticators. If the authenticator doesn’t exist then a one time ‘POST /api/v1/authenticators’ to create the authenticator (hard create) will be performed. Thereafter, that authenticator is never deleted, it is only deactivated (soft delete). Therefore, if the authenticator already exists create is just a soft import of an existing authenticator. This does not apply to custom_otp authenticator. There can be multiple custom_otp authenticator. To create new custom_otp authenticator, a new name and key = custom_otp is required. If an old name is used, it will simply reactivate the old custom_otp authenticator

    Update: custom_otp authenticator cannot be updated

    Delete: Authenticators can not be truly deleted therefore delete is soft. Delete will attempt to deativate the authenticator. An authenticator can only be deactivated if it’s not in use by any other policy.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const test = new okta.Authenticator("test", {
    name: "Security Question",
    key: "security_question",
    settings: JSON.stringify({
        allowedFor: "recovery",
    }),
});
const otp = new okta.Authenticator("otp", {
    name: "Custom OTP",
    key: "custom_otp",
    status: "ACTIVE",
    settings: JSON.stringify({
        protocol: "TOTP",
        acceptableAdjacentIntervals: 3,
        timeIntervalInSeconds: 30,
        encoding: "base32",
        algorithm: "HMacSHA256",
        passCodeLength: 6,
    }),
    legacyIgnoreName: false,
});

    import pulumi
import json
import pulumi_okta as okta

test = okta.Authenticator("test",
    name="Security Question",
    key="security_question",
    settings=json.dumps({
        "allowedFor": "recovery",
    }))
otp = okta.Authenticator("otp",
    name="Custom OTP",
    key="custom_otp",
    status="ACTIVE",
    settings=json.dumps({
        "protocol": "TOTP",
        "acceptableAdjacentIntervals": 3,
        "timeIntervalInSeconds": 30,
        "encoding": "base32",
        "algorithm": "HMacSHA256",
        "passCodeLength": 6,
    }),
    legacy_ignore_name=False)

    package main

import (
	"encoding/json"

	"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 {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"allowedFor": "recovery",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = okta.NewAuthenticator(ctx, "test", &okta.AuthenticatorArgs{
			Name:     pulumi.String("Security Question"),
			Key:      pulumi.String("security_question"),
			Settings: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		tmpJSON1, err := json.Marshal(map[string]interface{}{
			"protocol":                    "TOTP",
			"acceptableAdjacentIntervals": 3,
			"timeIntervalInSeconds":       30,
			"encoding":                    "base32",
			"algorithm":                   "HMacSHA256",
			"passCodeLength":              6,
		})
		if err != nil {
			return err
		}
		json1 := string(tmpJSON1)
		_, err = okta.NewAuthenticator(ctx, "otp", &okta.AuthenticatorArgs{
			Name:             pulumi.String("Custom OTP"),
			Key:              pulumi.String("custom_otp"),
			Status:           pulumi.String("ACTIVE"),
			Settings:         pulumi.String(json1),
			LegacyIgnoreName: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Okta = Pulumi.Okta;

return await Deployment.RunAsync(() => 
{
    var test = new Okta.Authenticator("test", new()
    {
        Name = "Security Question",
        Key = "security_question",
        Settings = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["allowedFor"] = "recovery",
        }),
    });

    var otp = new Okta.Authenticator("otp", new()
    {
        Name = "Custom OTP",
        Key = "custom_otp",
        Status = "ACTIVE",
        Settings = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["protocol"] = "TOTP",
            ["acceptableAdjacentIntervals"] = 3,
            ["timeIntervalInSeconds"] = 30,
            ["encoding"] = "base32",
            ["algorithm"] = "HMacSHA256",
            ["passCodeLength"] = 6,
        }),
        LegacyIgnoreName = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.Authenticator;
import com.pulumi.okta.AuthenticatorArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 test = new Authenticator("test", AuthenticatorArgs.builder()
            .name("Security Question")
            .key("security_question")
            .settings(serializeJson(
                jsonObject(
                    jsonProperty("allowedFor", "recovery")
                )))
            .build());

        var otp = new Authenticator("otp", AuthenticatorArgs.builder()
            .name("Custom OTP")
            .key("custom_otp")
            .status("ACTIVE")
            .settings(serializeJson(
                jsonObject(
                    jsonProperty("protocol", "TOTP"),
                    jsonProperty("acceptableAdjacentIntervals", 3),
                    jsonProperty("timeIntervalInSeconds", 30),
                    jsonProperty("encoding", "base32"),
                    jsonProperty("algorithm", "HMacSHA256"),
                    jsonProperty("passCodeLength", 6)
                )))
            .legacyIgnoreName(false)
            .build());

    }
}

    resources:
  test:
    type: okta:Authenticator
    properties:
      name: Security Question
      key: security_question
      settings:
        fn::toJSON:
          allowedFor: recovery
  otp:
    type: okta:Authenticator
    properties:
      name: Custom OTP
      key: custom_otp
      status: ACTIVE
      settings:
        fn::toJSON:
          protocol: TOTP
          acceptableAdjacentIntervals: 3
          timeIntervalInSeconds: 30
          encoding: base32
          algorithm: HMacSHA256
          passCodeLength: 6
      legacyIgnoreName: false

    Create Authenticator Resource

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

    Constructor syntax

    new Authenticator(name: string, args: AuthenticatorArgs, opts?: CustomResourceOptions);
    @overload
def Authenticator(resource_name: str,
                  args: AuthenticatorArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def Authenticator(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  key: Optional[str] = None,
                  legacy_ignore_name: Optional[bool] = None,
                  name: Optional[str] = None,
                  provider_auth_port: Optional[int] = None,
                  provider_host: Optional[str] = None,
                  provider_hostname: Optional[str] = None,
                  provider_integration_key: Optional[str] = None,
                  provider_json: Optional[str] = None,
                  provider_secret_key: Optional[str] = None,
                  provider_shared_secret: Optional[str] = None,
                  provider_user_name_template: Optional[str] = None,
                  settings: Optional[str] = None,
                  status: Optional[str] = None)
    func NewAuthenticator(ctx *Context, name string, args AuthenticatorArgs, opts ...ResourceOption) (*Authenticator, error)
    public Authenticator(string name, AuthenticatorArgs args, CustomResourceOptions? opts = null)
    public Authenticator(String name, AuthenticatorArgs args)
public Authenticator(String name, AuthenticatorArgs args, CustomResourceOptions options)

    type: okta:Authenticator
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 AuthenticatorArgs
    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 AuthenticatorArgs
    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 AuthenticatorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthenticatorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthenticatorArgs
    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 authenticatorResource = new Okta.Authenticator("authenticatorResource", new()
{
    Key = "string",
    LegacyIgnoreName = false,
    Name = "string",
    ProviderAuthPort = 0,
    ProviderHost = "string",
    ProviderHostname = "string",
    ProviderIntegrationKey = "string",
    ProviderJson = "string",
    ProviderSecretKey = "string",
    ProviderSharedSecret = "string",
    ProviderUserNameTemplate = "string",
    Settings = "string",
    Status = "string",
});

    example, err := okta.NewAuthenticator(ctx, "authenticatorResource", &okta.AuthenticatorArgs{
	Key:                      pulumi.String("string"),
	LegacyIgnoreName:         pulumi.Bool(false),
	Name:                     pulumi.String("string"),
	ProviderAuthPort:         pulumi.Int(0),
	ProviderHost:             pulumi.String("string"),
	ProviderHostname:         pulumi.String("string"),
	ProviderIntegrationKey:   pulumi.String("string"),
	ProviderJson:             pulumi.String("string"),
	ProviderSecretKey:        pulumi.String("string"),
	ProviderSharedSecret:     pulumi.String("string"),
	ProviderUserNameTemplate: pulumi.String("string"),
	Settings:                 pulumi.String("string"),
	Status:                   pulumi.String("string"),
})

    var authenticatorResource = new Authenticator("authenticatorResource", AuthenticatorArgs.builder()
    .key("string")
    .legacyIgnoreName(false)
    .name("string")
    .providerAuthPort(0)
    .providerHost("string")
    .providerHostname("string")
    .providerIntegrationKey("string")
    .providerJson("string")
    .providerSecretKey("string")
    .providerSharedSecret("string")
    .providerUserNameTemplate("string")
    .settings("string")
    .status("string")
    .build());

    authenticator_resource = okta.Authenticator("authenticatorResource",
    key="string",
    legacy_ignore_name=False,
    name="string",
    provider_auth_port=0,
    provider_host="string",
    provider_hostname="string",
    provider_integration_key="string",
    provider_json="string",
    provider_secret_key="string",
    provider_shared_secret="string",
    provider_user_name_template="string",
    settings="string",
    status="string")

    const authenticatorResource = new okta.Authenticator("authenticatorResource", {
    key: "string",
    legacyIgnoreName: false,
    name: "string",
    providerAuthPort: 0,
    providerHost: "string",
    providerHostname: "string",
    providerIntegrationKey: "string",
    providerJson: "string",
    providerSecretKey: "string",
    providerSharedSecret: "string",
    providerUserNameTemplate: "string",
    settings: "string",
    status: "string",
});

    type: okta:Authenticator
properties:
    key: string
    legacyIgnoreName: false
    name: string
    providerAuthPort: 0
    providerHost: string
    providerHostname: string
    providerIntegrationKey: string
    providerJson: string
    providerSecretKey: string
    providerSharedSecret: string
    providerUserNameTemplate: string
    settings: string
    status: string

    Authenticator Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Authenticator resource accepts the following input properties:

    Key string
    A human-readable string that identifies the authenticator. Some authenticators are available by feature flag on the organization. Possible values inclue: duo, external_idp, google_otp, okta_email, okta_password, okta_verify, onprem_mfa, phone_number, rsa_token, security_question, webauthn
    LegacyIgnoreName bool
    Name does not trigger change detection (legacy behavior)
    Name string
    Display name of the Authenticator
    ProviderAuthPort int
    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    ProviderHost string
    (DUO specific) - The Duo Security API hostname. Conflicts with provider_json argument.
    ProviderHostname string
    Server host name or IP address. Default is localhost. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    ProviderIntegrationKey string
    (DUO specific) - The Duo Security integration key. Conflicts with provider_json argument.
    ProviderJson string
    Provider JSON allows for expressive providervalues. This argument conflicts with the other 'provider_xxx' arguments. The CreateProvider illustrates detailed provider values for a Duo authenticator. Provider valuesare listed in Okta API.
    ProviderSecretKey string
    (DUO specific) - The Duo Security secret key. Conflicts with provider_json argument.
    ProviderSharedSecret string
    An authentication key that must be defined when the RADIUS server is configured, and must be the same on both the RADIUS client and server. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    ProviderUserNameTemplate string
    Username template expected by the provider. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    Settings string
    Settings for the authenticator. The settings JSON contains values based on Authenticator key. It is not used for authenticators with type security_key
    Status string
    Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE
    Key string
    A human-readable string that identifies the authenticator. Some authenticators are available by feature flag on the organization. Possible values inclue: duo, external_idp, google_otp, okta_email, okta_password, okta_verify, onprem_mfa, phone_number, rsa_token, security_question, webauthn
    LegacyIgnoreName bool
    Name does not trigger change detection (legacy behavior)
    Name string
    Display name of the Authenticator
    ProviderAuthPort int
    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    ProviderHost string
    (DUO specific) - The Duo Security API hostname. Conflicts with provider_json argument.
    ProviderHostname string
    Server host name or IP address. Default is localhost. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    ProviderIntegrationKey string
    (DUO specific) - The Duo Security integration key. Conflicts with provider_json argument.
    ProviderJson string
    Provider JSON allows for expressive providervalues. This argument conflicts with the other 'provider_xxx' arguments. The CreateProvider illustrates detailed provider values for a Duo authenticator. Provider valuesare listed in Okta API.
    ProviderSecretKey string
    (DUO specific) - The Duo Security secret key. Conflicts with provider_json argument.
    ProviderSharedSecret string
    An authentication key that must be defined when the RADIUS server is configured, and must be the same on both the RADIUS client and server. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    ProviderUserNameTemplate string
    Username template expected by the provider. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    Settings string
    Settings for the authenticator. The settings JSON contains values based on Authenticator key. It is not used for authenticators with type security_key
    Status string
    Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE
    key String
    A human-readable string that identifies the authenticator. Some authenticators are available by feature flag on the organization. Possible values inclue: duo, external_idp, google_otp, okta_email, okta_password, okta_verify, onprem_mfa, phone_number, rsa_token, security_question, webauthn
    legacyIgnoreName Boolean
    Name does not trigger change detection (legacy behavior)
    name String
    Display name of the Authenticator
    providerAuthPort Integer
    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerHost String
    (DUO specific) - The Duo Security API hostname. Conflicts with provider_json argument.
    providerHostname String
    Server host name or IP address. Default is localhost. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerIntegrationKey String
    (DUO specific) - The Duo Security integration key. Conflicts with provider_json argument.
    providerJson String
    Provider JSON allows for expressive providervalues. This argument conflicts with the other 'provider_xxx' arguments. The CreateProvider illustrates detailed provider values for a Duo authenticator. Provider valuesare listed in Okta API.
    providerSecretKey String
    (DUO specific) - The Duo Security secret key. Conflicts with provider_json argument.
    providerSharedSecret String
    An authentication key that must be defined when the RADIUS server is configured, and must be the same on both the RADIUS client and server. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerUserNameTemplate String
    Username template expected by the provider. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    settings String
    Settings for the authenticator. The settings JSON contains values based on Authenticator key. It is not used for authenticators with type security_key
    status String
    Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE
    key string
    A human-readable string that identifies the authenticator. Some authenticators are available by feature flag on the organization. Possible values inclue: duo, external_idp, google_otp, okta_email, okta_password, okta_verify, onprem_mfa, phone_number, rsa_token, security_question, webauthn
    legacyIgnoreName boolean
    Name does not trigger change detection (legacy behavior)
    name string
    Display name of the Authenticator
    providerAuthPort number
    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerHost string
    (DUO specific) - The Duo Security API hostname. Conflicts with provider_json argument.
    providerHostname string
    Server host name or IP address. Default is localhost. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerIntegrationKey string
    (DUO specific) - The Duo Security integration key. Conflicts with provider_json argument.
    providerJson string
    Provider JSON allows for expressive providervalues. This argument conflicts with the other 'provider_xxx' arguments. The CreateProvider illustrates detailed provider values for a Duo authenticator. Provider valuesare listed in Okta API.
    providerSecretKey string
    (DUO specific) - The Duo Security secret key. Conflicts with provider_json argument.
    providerSharedSecret string
    An authentication key that must be defined when the RADIUS server is configured, and must be the same on both the RADIUS client and server. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerUserNameTemplate string
    Username template expected by the provider. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    settings string
    Settings for the authenticator. The settings JSON contains values based on Authenticator key. It is not used for authenticators with type security_key
    status string
    Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE
    key str
    A human-readable string that identifies the authenticator. Some authenticators are available by feature flag on the organization. Possible values inclue: duo, external_idp, google_otp, okta_email, okta_password, okta_verify, onprem_mfa, phone_number, rsa_token, security_question, webauthn
    legacy_ignore_name bool
    Name does not trigger change detection (legacy behavior)
    name str
    Display name of the Authenticator
    provider_auth_port int
    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    provider_host str
    (DUO specific) - The Duo Security API hostname. Conflicts with provider_json argument.
    provider_hostname str
    Server host name or IP address. Default is localhost. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    provider_integration_key str
    (DUO specific) - The Duo Security integration key. Conflicts with provider_json argument.
    provider_json str
    Provider JSON allows for expressive providervalues. This argument conflicts with the other 'provider_xxx' arguments. The CreateProvider illustrates detailed provider values for a Duo authenticator. Provider valuesare listed in Okta API.
    provider_secret_key str
    (DUO specific) - The Duo Security secret key. Conflicts with provider_json argument.
    provider_shared_secret str
    An authentication key that must be defined when the RADIUS server is configured, and must be the same on both the RADIUS client and server. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    provider_user_name_template str
    Username template expected by the provider. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    settings str
    Settings for the authenticator. The settings JSON contains values based on Authenticator key. It is not used for authenticators with type security_key
    status str
    Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE
    key String
    A human-readable string that identifies the authenticator. Some authenticators are available by feature flag on the organization. Possible values inclue: duo, external_idp, google_otp, okta_email, okta_password, okta_verify, onprem_mfa, phone_number, rsa_token, security_question, webauthn
    legacyIgnoreName Boolean
    Name does not trigger change detection (legacy behavior)
    name String
    Display name of the Authenticator
    providerAuthPort Number
    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerHost String
    (DUO specific) - The Duo Security API hostname. Conflicts with provider_json argument.
    providerHostname String
    Server host name or IP address. Default is localhost. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerIntegrationKey String
    (DUO specific) - The Duo Security integration key. Conflicts with provider_json argument.
    providerJson String
    Provider JSON allows for expressive providervalues. This argument conflicts with the other 'provider_xxx' arguments. The CreateProvider illustrates detailed provider values for a Duo authenticator. Provider valuesare listed in Okta API.
    providerSecretKey String
    (DUO specific) - The Duo Security secret key. Conflicts with provider_json argument.
    providerSharedSecret String
    An authentication key that must be defined when the RADIUS server is configured, and must be the same on both the RADIUS client and server. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerUserNameTemplate String
    Username template expected by the provider. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    settings String
    Settings for the authenticator. The settings JSON contains values based on Authenticator key. It is not used for authenticators with type security_key
    status String
    Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ProviderInstanceId string
    App Instance ID.
    ProviderType string
    Provider type. Supported value for Duo: DUO. Supported value for Custom App: PUSH
    Type string
    he type of Authenticator. Values include: password, security_question, phone, email, app, federated, and security_key.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProviderInstanceId string
    App Instance ID.
    ProviderType string
    Provider type. Supported value for Duo: DUO. Supported value for Custom App: PUSH
    Type string
    he type of Authenticator. Values include: password, security_question, phone, email, app, federated, and security_key.
    id String
    The provider-assigned unique ID for this managed resource.
    providerInstanceId String
    App Instance ID.
    providerType String
    Provider type. Supported value for Duo: DUO. Supported value for Custom App: PUSH
    type String
    he type of Authenticator. Values include: password, security_question, phone, email, app, federated, and security_key.
    id string
    The provider-assigned unique ID for this managed resource.
    providerInstanceId string
    App Instance ID.
    providerType string
    Provider type. Supported value for Duo: DUO. Supported value for Custom App: PUSH
    type string
    he type of Authenticator. Values include: password, security_question, phone, email, app, federated, and security_key.
    id str
    The provider-assigned unique ID for this managed resource.
    provider_instance_id str
    App Instance ID.
    provider_type str
    Provider type. Supported value for Duo: DUO. Supported value for Custom App: PUSH
    type str
    he type of Authenticator. Values include: password, security_question, phone, email, app, federated, and security_key.
    id String
    The provider-assigned unique ID for this managed resource.
    providerInstanceId String
    App Instance ID.
    providerType String
    Provider type. Supported value for Duo: DUO. Supported value for Custom App: PUSH
    type String
    he type of Authenticator. Values include: password, security_question, phone, email, app, federated, and security_key.

    Look up Existing Authenticator Resource

    Get an existing Authenticator 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?: AuthenticatorState, opts?: CustomResourceOptions): Authenticator
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        key: Optional[str] = None,
        legacy_ignore_name: Optional[bool] = None,
        name: Optional[str] = None,
        provider_auth_port: Optional[int] = None,
        provider_host: Optional[str] = None,
        provider_hostname: Optional[str] = None,
        provider_instance_id: Optional[str] = None,
        provider_integration_key: Optional[str] = None,
        provider_json: Optional[str] = None,
        provider_secret_key: Optional[str] = None,
        provider_shared_secret: Optional[str] = None,
        provider_type: Optional[str] = None,
        provider_user_name_template: Optional[str] = None,
        settings: Optional[str] = None,
        status: Optional[str] = None,
        type: Optional[str] = None) -> Authenticator
    func GetAuthenticator(ctx *Context, name string, id IDInput, state *AuthenticatorState, opts ...ResourceOption) (*Authenticator, error)
    public static Authenticator Get(string name, Input<string> id, AuthenticatorState? state, CustomResourceOptions? opts = null)
    public static Authenticator get(String name, Output<String> id, AuthenticatorState 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:
    Key string
    A human-readable string that identifies the authenticator. Some authenticators are available by feature flag on the organization. Possible values inclue: duo, external_idp, google_otp, okta_email, okta_password, okta_verify, onprem_mfa, phone_number, rsa_token, security_question, webauthn
    LegacyIgnoreName bool
    Name does not trigger change detection (legacy behavior)
    Name string
    Display name of the Authenticator
    ProviderAuthPort int
    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    ProviderHost string
    (DUO specific) - The Duo Security API hostname. Conflicts with provider_json argument.
    ProviderHostname string
    Server host name or IP address. Default is localhost. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    ProviderInstanceId string
    App Instance ID.
    ProviderIntegrationKey string
    (DUO specific) - The Duo Security integration key. Conflicts with provider_json argument.
    ProviderJson string
    Provider JSON allows for expressive providervalues. This argument conflicts with the other 'provider_xxx' arguments. The CreateProvider illustrates detailed provider values for a Duo authenticator. Provider valuesare listed in Okta API.
    ProviderSecretKey string
    (DUO specific) - The Duo Security secret key. Conflicts with provider_json argument.
    ProviderSharedSecret string
    An authentication key that must be defined when the RADIUS server is configured, and must be the same on both the RADIUS client and server. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    ProviderType string
    Provider type. Supported value for Duo: DUO. Supported value for Custom App: PUSH
    ProviderUserNameTemplate string
    Username template expected by the provider. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    Settings string
    Settings for the authenticator. The settings JSON contains values based on Authenticator key. It is not used for authenticators with type security_key
    Status string
    Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE
    Type string
    he type of Authenticator. Values include: password, security_question, phone, email, app, federated, and security_key.
    Key string
    A human-readable string that identifies the authenticator. Some authenticators are available by feature flag on the organization. Possible values inclue: duo, external_idp, google_otp, okta_email, okta_password, okta_verify, onprem_mfa, phone_number, rsa_token, security_question, webauthn
    LegacyIgnoreName bool
    Name does not trigger change detection (legacy behavior)
    Name string
    Display name of the Authenticator
    ProviderAuthPort int
    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    ProviderHost string
    (DUO specific) - The Duo Security API hostname. Conflicts with provider_json argument.
    ProviderHostname string
    Server host name or IP address. Default is localhost. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    ProviderInstanceId string
    App Instance ID.
    ProviderIntegrationKey string
    (DUO specific) - The Duo Security integration key. Conflicts with provider_json argument.
    ProviderJson string
    Provider JSON allows for expressive providervalues. This argument conflicts with the other 'provider_xxx' arguments. The CreateProvider illustrates detailed provider values for a Duo authenticator. Provider valuesare listed in Okta API.
    ProviderSecretKey string
    (DUO specific) - The Duo Security secret key. Conflicts with provider_json argument.
    ProviderSharedSecret string
    An authentication key that must be defined when the RADIUS server is configured, and must be the same on both the RADIUS client and server. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    ProviderType string
    Provider type. Supported value for Duo: DUO. Supported value for Custom App: PUSH
    ProviderUserNameTemplate string
    Username template expected by the provider. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    Settings string
    Settings for the authenticator. The settings JSON contains values based on Authenticator key. It is not used for authenticators with type security_key
    Status string
    Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE
    Type string
    he type of Authenticator. Values include: password, security_question, phone, email, app, federated, and security_key.
    key String
    A human-readable string that identifies the authenticator. Some authenticators are available by feature flag on the organization. Possible values inclue: duo, external_idp, google_otp, okta_email, okta_password, okta_verify, onprem_mfa, phone_number, rsa_token, security_question, webauthn
    legacyIgnoreName Boolean
    Name does not trigger change detection (legacy behavior)
    name String
    Display name of the Authenticator
    providerAuthPort Integer
    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerHost String
    (DUO specific) - The Duo Security API hostname. Conflicts with provider_json argument.
    providerHostname String
    Server host name or IP address. Default is localhost. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerInstanceId String
    App Instance ID.
    providerIntegrationKey String
    (DUO specific) - The Duo Security integration key. Conflicts with provider_json argument.
    providerJson String
    Provider JSON allows for expressive providervalues. This argument conflicts with the other 'provider_xxx' arguments. The CreateProvider illustrates detailed provider values for a Duo authenticator. Provider valuesare listed in Okta API.
    providerSecretKey String
    (DUO specific) - The Duo Security secret key. Conflicts with provider_json argument.
    providerSharedSecret String
    An authentication key that must be defined when the RADIUS server is configured, and must be the same on both the RADIUS client and server. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerType String
    Provider type. Supported value for Duo: DUO. Supported value for Custom App: PUSH
    providerUserNameTemplate String
    Username template expected by the provider. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    settings String
    Settings for the authenticator. The settings JSON contains values based on Authenticator key. It is not used for authenticators with type security_key
    status String
    Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE
    type String
    he type of Authenticator. Values include: password, security_question, phone, email, app, federated, and security_key.
    key string
    A human-readable string that identifies the authenticator. Some authenticators are available by feature flag on the organization. Possible values inclue: duo, external_idp, google_otp, okta_email, okta_password, okta_verify, onprem_mfa, phone_number, rsa_token, security_question, webauthn
    legacyIgnoreName boolean
    Name does not trigger change detection (legacy behavior)
    name string
    Display name of the Authenticator
    providerAuthPort number
    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerHost string
    (DUO specific) - The Duo Security API hostname. Conflicts with provider_json argument.
    providerHostname string
    Server host name or IP address. Default is localhost. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerInstanceId string
    App Instance ID.
    providerIntegrationKey string
    (DUO specific) - The Duo Security integration key. Conflicts with provider_json argument.
    providerJson string
    Provider JSON allows for expressive providervalues. This argument conflicts with the other 'provider_xxx' arguments. The CreateProvider illustrates detailed provider values for a Duo authenticator. Provider valuesare listed in Okta API.
    providerSecretKey string
    (DUO specific) - The Duo Security secret key. Conflicts with provider_json argument.
    providerSharedSecret string
    An authentication key that must be defined when the RADIUS server is configured, and must be the same on both the RADIUS client and server. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerType string
    Provider type. Supported value for Duo: DUO. Supported value for Custom App: PUSH
    providerUserNameTemplate string
    Username template expected by the provider. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    settings string
    Settings for the authenticator. The settings JSON contains values based on Authenticator key. It is not used for authenticators with type security_key
    status string
    Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE
    type string
    he type of Authenticator. Values include: password, security_question, phone, email, app, federated, and security_key.
    key str
    A human-readable string that identifies the authenticator. Some authenticators are available by feature flag on the organization. Possible values inclue: duo, external_idp, google_otp, okta_email, okta_password, okta_verify, onprem_mfa, phone_number, rsa_token, security_question, webauthn
    legacy_ignore_name bool
    Name does not trigger change detection (legacy behavior)
    name str
    Display name of the Authenticator
    provider_auth_port int
    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    provider_host str
    (DUO specific) - The Duo Security API hostname. Conflicts with provider_json argument.
    provider_hostname str
    Server host name or IP address. Default is localhost. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    provider_instance_id str
    App Instance ID.
    provider_integration_key str
    (DUO specific) - The Duo Security integration key. Conflicts with provider_json argument.
    provider_json str
    Provider JSON allows for expressive providervalues. This argument conflicts with the other 'provider_xxx' arguments. The CreateProvider illustrates detailed provider values for a Duo authenticator. Provider valuesare listed in Okta API.
    provider_secret_key str
    (DUO specific) - The Duo Security secret key. Conflicts with provider_json argument.
    provider_shared_secret str
    An authentication key that must be defined when the RADIUS server is configured, and must be the same on both the RADIUS client and server. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    provider_type str
    Provider type. Supported value for Duo: DUO. Supported value for Custom App: PUSH
    provider_user_name_template str
    Username template expected by the provider. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    settings str
    Settings for the authenticator. The settings JSON contains values based on Authenticator key. It is not used for authenticators with type security_key
    status str
    Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE
    type str
    he type of Authenticator. Values include: password, security_question, phone, email, app, federated, and security_key.
    key String
    A human-readable string that identifies the authenticator. Some authenticators are available by feature flag on the organization. Possible values inclue: duo, external_idp, google_otp, okta_email, okta_password, okta_verify, onprem_mfa, phone_number, rsa_token, security_question, webauthn
    legacyIgnoreName Boolean
    Name does not trigger change detection (legacy behavior)
    name String
    Display name of the Authenticator
    providerAuthPort Number
    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerHost String
    (DUO specific) - The Duo Security API hostname. Conflicts with provider_json argument.
    providerHostname String
    Server host name or IP address. Default is localhost. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerInstanceId String
    App Instance ID.
    providerIntegrationKey String
    (DUO specific) - The Duo Security integration key. Conflicts with provider_json argument.
    providerJson String
    Provider JSON allows for expressive providervalues. This argument conflicts with the other 'provider_xxx' arguments. The CreateProvider illustrates detailed provider values for a Duo authenticator. Provider valuesare listed in Okta API.
    providerSecretKey String
    (DUO specific) - The Duo Security secret key. Conflicts with provider_json argument.
    providerSharedSecret String
    An authentication key that must be defined when the RADIUS server is configured, and must be the same on both the RADIUS client and server. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    providerType String
    Provider type. Supported value for Duo: DUO. Supported value for Custom App: PUSH
    providerUserNameTemplate String
    Username template expected by the provider. Used only for authenticators with type security_key. Conflicts with provider_json argument.
    settings String
    Settings for the authenticator. The settings JSON contains values based on Authenticator key. It is not used for authenticators with type security_key
    status String
    Authenticator status: ACTIVE or INACTIVE. Default: ACTIVE
    type String
    he type of Authenticator. Values include: password, security_question, phone, email, app, federated, and security_key.

    Import

    $ pulumi import okta:index/authenticator:Authenticator example <authenticator_id>

    To learn more about importing existing cloud resources, see Importing resources.

    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.3 published on Monday, Oct 21, 2024 by Pulumi
    pulumi/pulumi-okta