Okta

Pulumi Official
Package maintained by Pulumi
v3.14.0 published on Thursday, Aug 4, 2022 by Pulumi

Authenticator

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.

NOTE: An authenticator can only be deleted if it’s not in use by any policy.

Example Usage

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

class MyStack : Stack
{
    public MyStack()
    {
        var test = new Okta.Authenticator("test", new Okta.AuthenticatorArgs
        {
            Key = "security_question",
            Settings = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                { "allowedFor", "recovery" },
            }),
        });
    }

}
package main

import (
	"encoding/json"

	"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 {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"allowedFor": "recovery",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = okta.NewAuthenticator(ctx, "test", &okta.AuthenticatorArgs{
			Key:      pulumi.String("security_question"),
			Settings: pulumi.String(json0),
		})
		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.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()        
            .key("security_question")
            .settings(serializeJson(
                jsonObject(
                    jsonProperty("allowedFor", "recovery")
                )))
            .build());

    }
}
import pulumi
import json
import pulumi_okta as okta

test = okta.Authenticator("test",
    key="security_question",
    settings=json.dumps({
        "allowedFor": "recovery",
    }))
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const test = new okta.Authenticator("test", {
    key: "security_question",
    settings: JSON.stringify({
        allowedFor: "recovery",
    }),
});
resources:
  test:
    type: okta:Authenticator
    properties:
      key: security_question
      settings:
        Fn::ToJSON:
          allowedFor: recovery

Create a Authenticator Resource

new Authenticator(name: string, args: AuthenticatorArgs, opts?: CustomResourceOptions);
@overload
def Authenticator(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  key: Optional[str] = None,
                  name: Optional[str] = None,
                  provider_auth_port: Optional[int] = None,
                  provider_hostname: Optional[str] = None,
                  provider_shared_secret: Optional[str] = None,
                  provider_user_name_template: Optional[str] = None,
                  settings: Optional[str] = None,
                  status: Optional[str] = None)
@overload
def Authenticator(resource_name: str,
                  args: AuthenticatorArgs,
                  opts: Optional[ResourceOptions] = 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.

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.

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

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

Name string

Name of the authenticator.

ProviderAuthPort int

The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Default is 9000. Used only for authenticators with type "security_key".

ProviderHostname string

Server host name or IP address. Default is "localhost". Used only for authenticators with type "security_key".

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

ProviderUserNameTemplate string

Username template expected by the provider. Used only for authenticators with type "security_key".

Settings string

Settings for the authenticator. Settings object contains values based on Authenticator key. It is not used for authenticators with type "security_key".

Status string

Status of the authenticator. Default is 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

Name string

Name of the authenticator.

ProviderAuthPort int

The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Default is 9000. Used only for authenticators with type "security_key".

ProviderHostname string

Server host name or IP address. Default is "localhost". Used only for authenticators with type "security_key".

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

ProviderUserNameTemplate string

Username template expected by the provider. Used only for authenticators with type "security_key".

Settings string

Settings for the authenticator. Settings object contains values based on Authenticator key. It is not used for authenticators with type "security_key".

Status string

Status of the authenticator. Default is 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

name String

Name of the authenticator.

providerAuthPort Integer

The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Default is 9000. Used only for authenticators with type "security_key".

providerHostname String

Server host name or IP address. Default is "localhost". Used only for authenticators with type "security_key".

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

providerUserNameTemplate String

Username template expected by the provider. Used only for authenticators with type "security_key".

settings String

Settings for the authenticator. Settings object contains values based on Authenticator key. It is not used for authenticators with type "security_key".

status String

Status of the authenticator. Default is 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

name string

Name of the authenticator.

providerAuthPort number

The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Default is 9000. Used only for authenticators with type "security_key".

providerHostname string

Server host name or IP address. Default is "localhost". Used only for authenticators with type "security_key".

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

providerUserNameTemplate string

Username template expected by the provider. Used only for authenticators with type "security_key".

settings string

Settings for the authenticator. Settings object contains values based on Authenticator key. It is not used for authenticators with type "security_key".

status string

Status of the authenticator. Default is 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

name str

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. Default is 9000. Used only for authenticators with type "security_key".

provider_hostname str

Server host name or IP address. Default is "localhost". Used only for authenticators with type "security_key".

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

provider_user_name_template str

Username template expected by the provider. Used only for authenticators with type "security_key".

settings str

Settings for the authenticator. Settings object contains values based on Authenticator key. It is not used for authenticators with type "security_key".

status str

Status of the authenticator. Default is 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

name String

Name of the authenticator.

providerAuthPort Number

The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Default is 9000. Used only for authenticators with type "security_key".

providerHostname String

Server host name or IP address. Default is "localhost". Used only for authenticators with type "security_key".

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

providerUserNameTemplate String

Username template expected by the provider. Used only for authenticators with type "security_key".

settings String

Settings for the authenticator. Settings object contains values based on Authenticator key. It is not used for authenticators with type "security_key".

status String

Status of the authenticator. Default is 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

The type of Authenticator. Values include: "password", "security_question", "phone", "email", "app", "federated", and "security_key".

Type string

Type of the Authenticator.

Id string

The provider-assigned unique ID for this managed resource.

ProviderInstanceId string

App Instance ID.

ProviderType string

The type of Authenticator. Values include: "password", "security_question", "phone", "email", "app", "federated", and "security_key".

Type string

Type of the Authenticator.

id String

The provider-assigned unique ID for this managed resource.

providerInstanceId String

App Instance ID.

providerType String

The type of Authenticator. Values include: "password", "security_question", "phone", "email", "app", "federated", and "security_key".

type String

Type of the Authenticator.

id string

The provider-assigned unique ID for this managed resource.

providerInstanceId string

App Instance ID.

providerType string

The type of Authenticator. Values include: "password", "security_question", "phone", "email", "app", "federated", and "security_key".

type string

Type of the Authenticator.

id str

The provider-assigned unique ID for this managed resource.

provider_instance_id str

App Instance ID.

provider_type str

The type of Authenticator. Values include: "password", "security_question", "phone", "email", "app", "federated", and "security_key".

type str

Type of the Authenticator.

id String

The provider-assigned unique ID for this managed resource.

providerInstanceId String

App Instance ID.

providerType String

The type of Authenticator. Values include: "password", "security_question", "phone", "email", "app", "federated", and "security_key".

type String

Type of the Authenticator.

Look up an 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,
        name: Optional[str] = None,
        provider_auth_port: Optional[int] = None,
        provider_hostname: Optional[str] = None,
        provider_instance_id: 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

Name string

Name of the authenticator.

ProviderAuthPort int

The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Default is 9000. Used only for authenticators with type "security_key".

ProviderHostname string

Server host name or IP address. Default is "localhost". Used only for authenticators with type "security_key".

ProviderInstanceId string

App Instance ID.

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

ProviderType string

The type of Authenticator. Values include: "password", "security_question", "phone", "email", "app", "federated", and "security_key".

ProviderUserNameTemplate string

Username template expected by the provider. Used only for authenticators with type "security_key".

Settings string

Settings for the authenticator. Settings object contains values based on Authenticator key. It is not used for authenticators with type "security_key".

Status string

Status of the authenticator. Default is ACTIVE.

Type string

Type of the Authenticator.

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

Name string

Name of the authenticator.

ProviderAuthPort int

The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Default is 9000. Used only for authenticators with type "security_key".

ProviderHostname string

Server host name or IP address. Default is "localhost". Used only for authenticators with type "security_key".

ProviderInstanceId string

App Instance ID.

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

ProviderType string

The type of Authenticator. Values include: "password", "security_question", "phone", "email", "app", "federated", and "security_key".

ProviderUserNameTemplate string

Username template expected by the provider. Used only for authenticators with type "security_key".

Settings string

Settings for the authenticator. Settings object contains values based on Authenticator key. It is not used for authenticators with type "security_key".

Status string

Status of the authenticator. Default is ACTIVE.

Type string

Type of the Authenticator.

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

name String

Name of the authenticator.

providerAuthPort Integer

The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Default is 9000. Used only for authenticators with type "security_key".

providerHostname String

Server host name or IP address. Default is "localhost". Used only for authenticators with type "security_key".

providerInstanceId String

App Instance ID.

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

providerType String

The type of Authenticator. Values include: "password", "security_question", "phone", "email", "app", "federated", and "security_key".

providerUserNameTemplate String

Username template expected by the provider. Used only for authenticators with type "security_key".

settings String

Settings for the authenticator. Settings object contains values based on Authenticator key. It is not used for authenticators with type "security_key".

status String

Status of the authenticator. Default is ACTIVE.

type String

Type of the Authenticator.

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

name string

Name of the authenticator.

providerAuthPort number

The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Default is 9000. Used only for authenticators with type "security_key".

providerHostname string

Server host name or IP address. Default is "localhost". Used only for authenticators with type "security_key".

providerInstanceId string

App Instance ID.

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

providerType string

The type of Authenticator. Values include: "password", "security_question", "phone", "email", "app", "federated", and "security_key".

providerUserNameTemplate string

Username template expected by the provider. Used only for authenticators with type "security_key".

settings string

Settings for the authenticator. Settings object contains values based on Authenticator key. It is not used for authenticators with type "security_key".

status string

Status of the authenticator. Default is ACTIVE.

type string

Type of the Authenticator.

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

name str

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. Default is 9000. Used only for authenticators with type "security_key".

provider_hostname str

Server host name or IP address. Default is "localhost". Used only for authenticators with type "security_key".

provider_instance_id str

App Instance ID.

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

provider_type str

The type of Authenticator. Values include: "password", "security_question", "phone", "email", "app", "federated", and "security_key".

provider_user_name_template str

Username template expected by the provider. Used only for authenticators with type "security_key".

settings str

Settings for the authenticator. Settings object contains values based on Authenticator key. It is not used for authenticators with type "security_key".

status str

Status of the authenticator. Default is ACTIVE.

type str

Type of the Authenticator.

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

name String

Name of the authenticator.

providerAuthPort Number

The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured. Default is 9000. Used only for authenticators with type "security_key".

providerHostname String

Server host name or IP address. Default is "localhost". Used only for authenticators with type "security_key".

providerInstanceId String

App Instance ID.

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

providerType String

The type of Authenticator. Values include: "password", "security_question", "phone", "email", "app", "federated", and "security_key".

providerUserNameTemplate String

Username template expected by the provider. Used only for authenticators with type "security_key".

settings String

Settings for the authenticator. Settings object contains values based on Authenticator key. It is not used for authenticators with type "security_key".

status String

Status of the authenticator. Default is ACTIVE.

type String

Type of the Authenticator.

Import

Okta authenticator can be imported via the Okta ID.

 $ pulumi import okta:index/authenticator:Authenticator example &#60;authenticator_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.