getConnection

Auth0 v2.24.3 (2.x), Mar 9 26

Viewing docs for Auth0 v2.24.3 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-auth0

Viewing docs for Auth0 v2.24.3 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-auth0

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var some_connection_by_name = Auth0.GetConnection.Invoke(new()
    {
        Name = "Acceptance-Test-Connection-{{.testName}}",
    });

    var some_connection_by_id = Auth0.GetConnection.Invoke(new()
    {
        ConnectionId = "con_abcdefghkijklmnopqrstuvwxyz0123456789",
    });

});

package main

import (
	"github.com/pulumi/pulumi-auth0/sdk/v2/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth0.LookupConnection(ctx, &auth0.LookupConnectionArgs{
			Name: pulumi.StringRef("Acceptance-Test-Connection-{{.testName}}"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = auth0.LookupConnection(ctx, &auth0.LookupConnectionArgs{
			ConnectionId: pulumi.StringRef("con_abcdefghkijklmnopqrstuvwxyz0123456789"),
		}, 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.auth0.Auth0Functions;
import com.pulumi.auth0.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 some-connection-by-name = Auth0Functions.getConnection(GetConnectionArgs.builder()
            .name("Acceptance-Test-Connection-{{.testName}}")
            .build());

        final var some-connection-by-id = Auth0Functions.getConnection(GetConnectionArgs.builder()
            .connectionId("con_abcdefghkijklmnopqrstuvwxyz0123456789")
            .build());

    }
}

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

const some-connection-by-name = auth0.getConnection({
    name: "Acceptance-Test-Connection-{{.testName}}",
});
const some-connection-by-id = auth0.getConnection({
    connectionId: "con_abcdefghkijklmnopqrstuvwxyz0123456789",
});

import pulumi
import pulumi_auth0 as auth0

some_connection_by_name = auth0.get_connection(name="Acceptance-Test-Connection-{{.testName}}")
some_connection_by_id = auth0.get_connection(connection_id="con_abcdefghkijklmnopqrstuvwxyz0123456789")

variables:
  some-connection-by-name:
    fn::invoke:
      Function: auth0:getConnection
      Arguments:
        name: Acceptance-Test-Connection-{{.testName}}
  some-connection-by-id:
    fn::invoke:
      Function: auth0:getConnection
      Arguments:
        connectionId: con_abcdefghkijklmnopqrstuvwxyz0123456789

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(connection_id: Optional[str] = None,
                   name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(connection_id: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = 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: auth0:index/getConnection:getConnection
  arguments:
    # arguments dictionary

The following arguments are supported:

ConnectionId string: The ID of the connection. If not provided, name must be set.
Name string: The name of the connection. If not provided, connection_id must be set.

ConnectionId string: The ID of the connection. If not provided, name must be set.
Name string: The name of the connection. If not provided, connection_id must be set.

connectionId String: The ID of the connection. If not provided, name must be set.
name String: The name of the connection. If not provided, connection_id must be set.

connectionId string: The ID of the connection. If not provided, name must be set.
name string: The name of the connection. If not provided, connection_id must be set.

connection_id str: The ID of the connection. If not provided, name must be set.
name str: The name of the connection. If not provided, connection_id must be set.

connectionId String: The ID of the connection. If not provided, name must be set.
name String: The name of the connection. If not provided, connection_id must be set.

getConnection Result

The following output properties are available:

DisplayName string: Name used in login screen.
EnabledClients List<string>: IDs of the clients for which the connection is enabled.
Id string: The provider-assigned unique ID for this managed resource.
IsDomainConnection bool: Indicates whether the connection is domain level.
Metadata Dictionary<string, string>: Metadata associated with the connection, in the form of a map of string values (max 255 chars).
Options List<GetConnectionOption>: Configuration settings for connection options.
Realms List<string>: Defines the realms for which the connection will be used (e.g., email domains). If not specified, the connection name is added as the realm.
ShowAsButton bool: Display connection as a button. Only available on enterprise connections.
Strategy string: Type of the connection, which indicates the identity provider.
ConnectionId string: The ID of the connection. If not provided, name must be set.
Name string: The name of the connection. If not provided, connection_id must be set.

DisplayName string: Name used in login screen.
EnabledClients []string: IDs of the clients for which the connection is enabled.
Id string: The provider-assigned unique ID for this managed resource.
IsDomainConnection bool: Indicates whether the connection is domain level.
Metadata map[string]string: Metadata associated with the connection, in the form of a map of string values (max 255 chars).
Options []GetConnectionOption: Configuration settings for connection options.
Realms []string: Defines the realms for which the connection will be used (e.g., email domains). If not specified, the connection name is added as the realm.
ShowAsButton bool: Display connection as a button. Only available on enterprise connections.
Strategy string: Type of the connection, which indicates the identity provider.
ConnectionId string: The ID of the connection. If not provided, name must be set.
Name string: The name of the connection. If not provided, connection_id must be set.

displayName String: Name used in login screen.
enabledClients List<String>: IDs of the clients for which the connection is enabled.
id String: The provider-assigned unique ID for this managed resource.
isDomainConnection Boolean: Indicates whether the connection is domain level.
metadata Map<String,String>: Metadata associated with the connection, in the form of a map of string values (max 255 chars).
options List<GetConnectionOption>: Configuration settings for connection options.
realms List<String>: Defines the realms for which the connection will be used (e.g., email domains). If not specified, the connection name is added as the realm.
showAsButton Boolean: Display connection as a button. Only available on enterprise connections.
strategy String: Type of the connection, which indicates the identity provider.
connectionId String: The ID of the connection. If not provided, name must be set.
name String: The name of the connection. If not provided, connection_id must be set.

displayName string: Name used in login screen.
enabledClients string[]: IDs of the clients for which the connection is enabled.
id string: The provider-assigned unique ID for this managed resource.
isDomainConnection boolean: Indicates whether the connection is domain level.
metadata {[key: string]: string}: Metadata associated with the connection, in the form of a map of string values (max 255 chars).
options GetConnectionOption[]: Configuration settings for connection options.
realms string[]: Defines the realms for which the connection will be used (e.g., email domains). If not specified, the connection name is added as the realm.
showAsButton boolean: Display connection as a button. Only available on enterprise connections.
strategy string: Type of the connection, which indicates the identity provider.
connectionId string: The ID of the connection. If not provided, name must be set.
name string: The name of the connection. If not provided, connection_id must be set.

display_name str: Name used in login screen.
enabled_clients Sequence[str]: IDs of the clients for which the connection is enabled.
id str: The provider-assigned unique ID for this managed resource.
is_domain_connection bool: Indicates whether the connection is domain level.
metadata Mapping[str, str]: Metadata associated with the connection, in the form of a map of string values (max 255 chars).
options Sequence[GetConnectionOption]: Configuration settings for connection options.
realms Sequence[str]: Defines the realms for which the connection will be used (e.g., email domains). If not specified, the connection name is added as the realm.
show_as_button bool: Display connection as a button. Only available on enterprise connections.
strategy str: Type of the connection, which indicates the identity provider.
connection_id str: The ID of the connection. If not provided, name must be set.
name str: The name of the connection. If not provided, connection_id must be set.

displayName String: Name used in login screen.
enabledClients List<String>: IDs of the clients for which the connection is enabled.
id String: The provider-assigned unique ID for this managed resource.
isDomainConnection Boolean: Indicates whether the connection is domain level.
metadata Map<String>: Metadata associated with the connection, in the form of a map of string values (max 255 chars).
options List<Property Map>: Configuration settings for connection options.
realms List<String>: Defines the realms for which the connection will be used (e.g., email domains). If not specified, the connection name is added as the realm.
showAsButton Boolean: Display connection as a button. Only available on enterprise connections.
strategy String: Type of the connection, which indicates the identity provider.
connectionId String: The ID of the connection. If not provided, name must be set.
name String: The name of the connection. If not provided, connection_id must be set.