1. Packages
  2. Okta Provider
  3. API Docs
  4. app
  5. getConnection
Viewing docs for Okta v6.4.0
published on Saturday, Mar 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

okta.app.getConnection

okta logo
Viewing docs for Okta v6.4.0
published on Saturday, Mar 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

    Retrieves the default provisioning connection for an app.

    Example Usage

    Basic Usage

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

const example = okta.app.getConnection({
    id: "0oa1234567890abcdef",
});
export const connectionStatus = example.then(example => example.status);

    import pulumi
import pulumi_okta as okta

example = okta.app.get_connection(id="0oa1234567890abcdef")
pulumi.export("connectionStatus", example.status)

    package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v6/go/okta/app"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := app.LookupConnection(ctx, &app.LookupConnectionArgs{
			Id: "0oa1234567890abcdef",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("connectionStatus", example.Status)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Okta.App.GetConnection.Invoke(new()
    {
        Id = "0oa1234567890abcdef",
    });

    return new Dictionary<string, object?>
    {
        ["connectionStatus"] = example.Apply(getConnectionResult => getConnectionResult.Status),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.app.AppFunctions;
import com.pulumi.okta.app.inputs.GetConnectionArgs;
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 example = AppFunctions.getConnection(GetConnectionArgs.builder()
            .id("0oa1234567890abcdef")
            .build());

        ctx.export("connectionStatus", example.status());
    }
}

    variables:
  example:
    fn::invoke:
      function: okta:app:getConnection
      arguments:
        id: 0oa1234567890abcdef
outputs:
  # Use the retrieved data
  connectionStatus: ${example.status}

    Using getConnection

    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 getConnection(args: GetConnectionArgs, opts?: InvokeOptions): Promise<GetConnectionResult>
function getConnectionOutput(args: GetConnectionOutputArgs, opts?: InvokeOptions): Output<GetConnectionResult>
    def get_connection(auth_scheme: Optional[str] = None,
                   base_url: Optional[str] = None,
                   id: Optional[str] = None,
                   profile: Optional[GetConnectionProfile] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(auth_scheme: Optional[pulumi.Input[str]] = None,
                   base_url: Optional[pulumi.Input[str]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   profile: Optional[pulumi.Input[GetConnectionProfileArgs]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetConnectionResult]
    func LookupConnection(ctx *Context, args *LookupConnectionArgs, opts ...InvokeOption) (*LookupConnectionResult, error)
func LookupConnectionOutput(ctx *Context, args *LookupConnectionOutputArgs, opts ...InvokeOption) LookupConnectionResultOutput

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

    public static class GetConnection 
{
    public static Task<GetConnectionResult> InvokeAsync(GetConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
public static Output<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)

    fn::invoke:
  function: okta:app/getConnection:getConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The application ID for which to retrieve the provisioning connection information.
    AuthScheme string
    A token is used to authenticate with the app. This property is only returned for the TOKEN authentication scheme.
    BaseUrl string
    The base URL for the provisioning connection.
    Profile GetConnectionProfile
    Profile information for the app connection.
    Id string
    The application ID for which to retrieve the provisioning connection information.
    AuthScheme string
    A token is used to authenticate with the app. This property is only returned for the TOKEN authentication scheme.
    BaseUrl string
    The base URL for the provisioning connection.
    Profile GetConnectionProfile
    Profile information for the app connection.
    id String
    The application ID for which to retrieve the provisioning connection information.
    authScheme String
    A token is used to authenticate with the app. This property is only returned for the TOKEN authentication scheme.
    baseUrl String
    The base URL for the provisioning connection.
    profile GetConnectionProfile
    Profile information for the app connection.
    id string
    The application ID for which to retrieve the provisioning connection information.
    authScheme string
    A token is used to authenticate with the app. This property is only returned for the TOKEN authentication scheme.
    baseUrl string
    The base URL for the provisioning connection.
    profile GetConnectionProfile
    Profile information for the app connection.
    id str
    The application ID for which to retrieve the provisioning connection information.
    auth_scheme str
    A token is used to authenticate with the app. This property is only returned for the TOKEN authentication scheme.
    base_url str
    The base URL for the provisioning connection.
    profile GetConnectionProfile
    Profile information for the app connection.
    id String
    The application ID for which to retrieve the provisioning connection information.
    authScheme String
    A token is used to authenticate with the app. This property is only returned for the TOKEN authentication scheme.
    baseUrl String
    The base URL for the provisioning connection.
    profile Property Map
    Profile information for the app connection.

    getConnection Result

    The following output properties are available:

    AuthScheme string
    A token is used to authenticate with the app. This property is only returned for the TOKEN authentication scheme.
    BaseUrl string
    The base URL for the provisioning connection.
    Id string
    The application ID for which to retrieve the provisioning connection information.
    Status string
    Provisioning connection status.
    Profile GetConnectionProfile
    Profile information for the app connection.
    AuthScheme string
    A token is used to authenticate with the app. This property is only returned for the TOKEN authentication scheme.
    BaseUrl string
    The base URL for the provisioning connection.
    Id string
    The application ID for which to retrieve the provisioning connection information.
    Status string
    Provisioning connection status.
    Profile GetConnectionProfile
    Profile information for the app connection.
    authScheme String
    A token is used to authenticate with the app. This property is only returned for the TOKEN authentication scheme.
    baseUrl String
    The base URL for the provisioning connection.
    id String
    The application ID for which to retrieve the provisioning connection information.
    status String
    Provisioning connection status.
    profile GetConnectionProfile
    Profile information for the app connection.
    authScheme string
    A token is used to authenticate with the app. This property is only returned for the TOKEN authentication scheme.
    baseUrl string
    The base URL for the provisioning connection.
    id string
    The application ID for which to retrieve the provisioning connection information.
    status string
    Provisioning connection status.
    profile GetConnectionProfile
    Profile information for the app connection.
    auth_scheme str
    A token is used to authenticate with the app. This property is only returned for the TOKEN authentication scheme.
    base_url str
    The base URL for the provisioning connection.
    id str
    The application ID for which to retrieve the provisioning connection information.
    status str
    Provisioning connection status.
    profile GetConnectionProfile
    Profile information for the app connection.
    authScheme String
    A token is used to authenticate with the app. This property is only returned for the TOKEN authentication scheme.
    baseUrl String
    The base URL for the provisioning connection.
    id String
    The application ID for which to retrieve the provisioning connection information.
    status String
    Provisioning connection status.
    profile Property Map
    Profile information for the app connection.

    Supporting Types

    GetConnectionProfile

    AuthScheme string
    Defines the method of authentication.
    AuthScheme string
    Defines the method of authentication.
    authScheme String
    Defines the method of authentication.
    authScheme string
    Defines the method of authentication.
    auth_scheme str
    Defines the method of authentication.
    authScheme String
    Defines the method of authentication.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Viewing docs for Okta v6.4.0
    published on Saturday, Mar 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-okta
      Try Pulumi Cloud free. Your team will thank you.