Docs Packages
  1. Packages
  2. Okta
  3. API Docs
  4. getAuthenticator
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-okta

okta.getAuthenticator

Explore with Pulumi AI

okta logo
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-okta

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

    Use this data source to retrieve an authenticator.

    Example Usage

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

const test = okta.getAuthenticator({
    name: "Security Question",
});

    import pulumi
import pulumi_okta as okta

test = okta.get_authenticator(name="Security Question")

    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.LookupAuthenticator(ctx, &okta.LookupAuthenticatorArgs{
			Name: pulumi.StringRef("Security Question"),
		}, nil)
		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 test = Okta.GetAuthenticator.Invoke(new()
    {
        Name = "Security Question",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.OktaFunctions;
import com.pulumi.okta.inputs.GetAuthenticatorArgs;
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) {
        final var test = OktaFunctions.getAuthenticator(GetAuthenticatorArgs.builder()
            .name("Security Question")
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      Function: okta:getAuthenticator
      Arguments:
        name: Security Question

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

const test = okta.getAuthenticator({
    key: "okta_email",
});

    import pulumi
import pulumi_okta as okta

test = okta.get_authenticator(key="okta_email")

    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.LookupAuthenticator(ctx, &okta.LookupAuthenticatorArgs{
			Key: pulumi.StringRef("okta_email"),
		}, nil)
		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 test = Okta.GetAuthenticator.Invoke(new()
    {
        Key = "okta_email",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.OktaFunctions;
import com.pulumi.okta.inputs.GetAuthenticatorArgs;
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) {
        final var test = OktaFunctions.getAuthenticator(GetAuthenticatorArgs.builder()
            .key("okta_email")
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      Function: okta:getAuthenticator
      Arguments:
        key: okta_email

    Using getAuthenticator

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAuthenticator(args: GetAuthenticatorArgs, opts?: InvokeOptions): Promise<GetAuthenticatorResult>
function getAuthenticatorOutput(args: GetAuthenticatorOutputArgs, opts?: InvokeOptions): Output<GetAuthenticatorResult>
    def get_authenticator(id: Optional[str] = None,
                      key: Optional[str] = None,
                      name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetAuthenticatorResult
def get_authenticator_output(id: Optional[pulumi.Input[str]] = None,
                      key: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetAuthenticatorResult]
    func LookupAuthenticator(ctx *Context, args *LookupAuthenticatorArgs, opts ...InvokeOption) (*LookupAuthenticatorResult, error)
func LookupAuthenticatorOutput(ctx *Context, args *LookupAuthenticatorOutputArgs, opts ...InvokeOption) LookupAuthenticatorResultOutput

    > Note: This function is named LookupAuthenticator in the Go SDK.

    public static class GetAuthenticator 
{
    public static Task<GetAuthenticatorResult> InvokeAsync(GetAuthenticatorArgs args, InvokeOptions? opts = null)
    public static Output<GetAuthenticatorResult> Invoke(GetAuthenticatorInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAuthenticatorResult> getAuthenticator(GetAuthenticatorArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: okta:index/getAuthenticator:getAuthenticator
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    ID of the authenticator.
    Key string
    A human-readable string that identifies the authenticator.
    Name string
    Name of the authenticator.
    Id string
    ID of the authenticator.
    Key string
    A human-readable string that identifies the authenticator.
    Name string
    Name of the authenticator.
    id String
    ID of the authenticator.
    key String
    A human-readable string that identifies the authenticator.
    name String
    Name of the authenticator.
    id string
    ID of the authenticator.
    key string
    A human-readable string that identifies the authenticator.
    name string
    Name of the authenticator.
    id str
    ID of the authenticator.
    key str
    A human-readable string that identifies the authenticator.
    name str
    Name of the authenticator.
    id String
    ID of the authenticator.
    key String
    A human-readable string that identifies the authenticator.
    name String
    Name of the authenticator.

    getAuthenticator Result

    The following output properties are available:

    ProviderAuthPort int
    (Specific to security_key) The provider server port (for example 1812).
    ProviderHostname string
    (Specific to security_key) Server host name or IP address.
    ProviderInstanceId string
    (Specific to security_key) App Instance ID.
    ProviderJson string
    ProviderType string
    Provider type.
    ProviderUserNameTemplate string
    Username template expected by the provider.
    Settings string
    Settings for the authenticator (expressed in JSON).
    Status string
    Status of the Authenticator.
    Type string
    The type of Authenticator.
    Id string
    ID of the authenticator.
    Key string
    Name string
    Name of the authenticator.
    ProviderAuthPort int
    (Specific to security_key) The provider server port (for example 1812).
    ProviderHostname string
    (Specific to security_key) Server host name or IP address.
    ProviderInstanceId string
    (Specific to security_key) App Instance ID.
    ProviderJson string
    ProviderType string
    Provider type.
    ProviderUserNameTemplate string
    Username template expected by the provider.
    Settings string
    Settings for the authenticator (expressed in JSON).
    Status string
    Status of the Authenticator.
    Type string
    The type of Authenticator.
    Id string
    ID of the authenticator.
    Key string
    Name string
    Name of the authenticator.
    providerAuthPort Integer
    (Specific to security_key) The provider server port (for example 1812).
    providerHostname String
    (Specific to security_key) Server host name or IP address.
    providerInstanceId String
    (Specific to security_key) App Instance ID.
    providerJson String
    providerType String
    Provider type.
    providerUserNameTemplate String
    Username template expected by the provider.
    settings String
    Settings for the authenticator (expressed in JSON).
    status String
    Status of the Authenticator.
    type String
    The type of Authenticator.
    id String
    ID of the authenticator.
    key String
    name String
    Name of the authenticator.
    providerAuthPort number
    (Specific to security_key) The provider server port (for example 1812).
    providerHostname string
    (Specific to security_key) Server host name or IP address.
    providerInstanceId string
    (Specific to security_key) App Instance ID.
    providerJson string
    providerType string
    Provider type.
    providerUserNameTemplate string
    Username template expected by the provider.
    settings string
    Settings for the authenticator (expressed in JSON).
    status string
    Status of the Authenticator.
    type string
    The type of Authenticator.
    id string
    ID of the authenticator.
    key string
    name string
    Name of the authenticator.
    provider_auth_port int
    (Specific to security_key) The provider server port (for example 1812).
    provider_hostname str
    (Specific to security_key) Server host name or IP address.
    provider_instance_id str
    (Specific to security_key) App Instance ID.
    provider_json str
    provider_type str
    Provider type.
    provider_user_name_template str
    Username template expected by the provider.
    settings str
    Settings for the authenticator (expressed in JSON).
    status str
    Status of the Authenticator.
    type str
    The type of Authenticator.
    id str
    ID of the authenticator.
    key str
    name str
    Name of the authenticator.
    providerAuthPort Number
    (Specific to security_key) The provider server port (for example 1812).
    providerHostname String
    (Specific to security_key) Server host name or IP address.
    providerInstanceId String
    (Specific to security_key) App Instance ID.
    providerJson String
    providerType String
    Provider type.
    providerUserNameTemplate String
    Username template expected by the provider.
    settings String
    Settings for the authenticator (expressed in JSON).
    status String
    Status of the Authenticator.
    type String
    The type of Authenticator.
    id String
    ID of the authenticator.
    key String
    name String
    Name of the authenticator.

    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.8.1 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-okta