1. Packages
  2. Okta
  3. API Docs
  4. getAuthenticator
Okta v4.6.2 published on Thursday, Nov 30, 2023 by Pulumi

okta.getAuthenticator

Explore with Pulumi AI

okta logo
Okta v4.6.2 published on Thursday, Nov 30, 2023 by Pulumi

    Get an authenticator by key, name of ID.

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

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Okta.GetAuthenticator.Invoke(new()
        {
            Key = "security_question",
        });
    
        var test1 = Okta.GetAuthenticator.Invoke(new()
        {
            Name = "Okta Verify",
        });
    
    });
    
    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("security_question"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = okta.LookupAuthenticator(ctx, &okta.LookupAuthenticatorArgs{
    			Name: pulumi.StringRef("Okta Verify"),
    		}, nil)
    		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.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("security_question")
                .build());
    
            final var test1 = OktaFunctions.getAuthenticator(GetAuthenticatorArgs.builder()
                .name("Okta Verify")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_okta as okta
    
    test = okta.get_authenticator(key="security_question")
    test1 = okta.get_authenticator(name="Okta Verify")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const test = okta.getAuthenticator({
        key: "security_question",
    });
    const test1 = okta.getAuthenticator({
        name: "Okta Verify",
    });
    
    variables:
      test:
        fn::invoke:
          Function: okta:getAuthenticator
          Arguments:
            key: security_question
      test1:
        fn::invoke:
          Function: okta:getAuthenticator
          Arguments:
            name: Okta Verify
    

    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

    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured

    ProviderHostname string

    Server host name or IP address

    ProviderInstanceId string

    (Specific to security_key) App Instance ID.

    ProviderJson string

    Authenticator Provider in JSON format

    ProviderType string

    Provider type.

    ProviderUserNameTemplate string

    Username template expected by the provider.

    Settings string

    Authenticator settings in JSON format

    Status string

    Status of the Authenticator.

    Type string

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

    ProviderAuthPort int

    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured

    ProviderHostname string

    Server host name or IP address

    ProviderInstanceId string

    (Specific to security_key) App Instance ID.

    ProviderJson string

    Authenticator Provider in JSON format

    ProviderType string

    Provider type.

    ProviderUserNameTemplate string

    Username template expected by the provider.

    Settings string

    Authenticator settings in JSON format

    Status string

    Status of the Authenticator.

    Type string

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

    providerAuthPort Integer

    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured

    providerHostname String

    Server host name or IP address

    providerInstanceId String

    (Specific to security_key) App Instance ID.

    providerJson String

    Authenticator Provider in JSON format

    providerType String

    Provider type.

    providerUserNameTemplate String

    Username template expected by the provider.

    settings String

    Authenticator settings in JSON format

    status String

    Status of the Authenticator.

    type String

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

    providerAuthPort number

    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured

    providerHostname string

    Server host name or IP address

    providerInstanceId string

    (Specific to security_key) App Instance ID.

    providerJson string

    Authenticator Provider in JSON format

    providerType string

    Provider type.

    providerUserNameTemplate string

    Username template expected by the provider.

    settings string

    Authenticator settings in JSON format

    status string

    Status of the Authenticator.

    type string

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

    provider_auth_port int

    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured

    provider_hostname str

    Server host name or IP address

    provider_instance_id str

    (Specific to security_key) App Instance ID.

    provider_json str

    Authenticator Provider in JSON format

    provider_type str

    Provider type.

    provider_user_name_template str

    Username template expected by the provider.

    settings str

    Authenticator settings in JSON format

    status str

    Status of the Authenticator.

    type str

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

    providerAuthPort Number

    The RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured

    providerHostname String

    Server host name or IP address

    providerInstanceId String

    (Specific to security_key) App Instance ID.

    providerJson String

    Authenticator Provider in JSON format

    providerType String

    Provider type.

    providerUserNameTemplate String

    Username template expected by the provider.

    settings String

    Authenticator settings in JSON format

    status String

    Status of the Authenticator.

    type String

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

    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.6.2 published on Thursday, Nov 30, 2023 by Pulumi