1. Packages
  2. Auth0 Provider
  3. API Docs
  4. getConnectionProfile
Auth0 v3.34.0 published on Thursday, Nov 20, 2025 by Pulumi
auth0 logo
Auth0 v3.34.0 published on Thursday, Nov 20, 2025 by Pulumi

    Retrieve information about an Auth0 connection profile.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as auth0 from "@pulumi/auth0";
    
    const myProfile = new auth0.ConnectionProfile("my_profile", {
        name: "My-Profile",
        organization: {
            showAsButton: "optional",
            assignMembershipOnLogin: "required",
        },
        connectionNamePrefixTemplate: "template1",
        enabledFeatures: [
            "scim",
            "universal_logout",
        ],
    });
    const myProfileDs = auth0.getConnectionProfileOutput({
        id: myProfile.id,
    });
    
    import pulumi
    import pulumi_auth0 as auth0
    
    my_profile = auth0.ConnectionProfile("my_profile",
        name="My-Profile",
        organization={
            "show_as_button": "optional",
            "assign_membership_on_login": "required",
        },
        connection_name_prefix_template="template1",
        enabled_features=[
            "scim",
            "universal_logout",
        ])
    my_profile_ds = auth0.get_connection_profile_output(id=my_profile.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-auth0/sdk/v3/go/auth0"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		myProfile, err := auth0.NewConnectionProfile(ctx, "my_profile", &auth0.ConnectionProfileArgs{
    			Name: pulumi.String("My-Profile"),
    			Organization: &auth0.ConnectionProfileOrganizationArgs{
    				ShowAsButton:            pulumi.String("optional"),
    				AssignMembershipOnLogin: pulumi.String("required"),
    			},
    			ConnectionNamePrefixTemplate: pulumi.String("template1"),
    			EnabledFeatures: pulumi.StringArray{
    				pulumi.String("scim"),
    				pulumi.String("universal_logout"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_ = auth0.LookupConnectionProfileOutput(ctx, auth0.GetConnectionProfileOutputArgs{
    			Id: myProfile.ID(),
    		}, nil)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Auth0 = Pulumi.Auth0;
    
    return await Deployment.RunAsync(() => 
    {
        var myProfile = new Auth0.ConnectionProfile("my_profile", new()
        {
            Name = "My-Profile",
            Organization = new Auth0.Inputs.ConnectionProfileOrganizationArgs
            {
                ShowAsButton = "optional",
                AssignMembershipOnLogin = "required",
            },
            ConnectionNamePrefixTemplate = "template1",
            EnabledFeatures = new[]
            {
                "scim",
                "universal_logout",
            },
        });
    
        var myProfileDs = Auth0.GetConnectionProfile.Invoke(new()
        {
            Id = myProfile.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.auth0.ConnectionProfile;
    import com.pulumi.auth0.ConnectionProfileArgs;
    import com.pulumi.auth0.inputs.ConnectionProfileOrganizationArgs;
    import com.pulumi.auth0.Auth0Functions;
    import com.pulumi.auth0.inputs.GetConnectionProfileArgs;
    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 myProfile = new ConnectionProfile("myProfile", ConnectionProfileArgs.builder()
                .name("My-Profile")
                .organization(ConnectionProfileOrganizationArgs.builder()
                    .showAsButton("optional")
                    .assignMembershipOnLogin("required")
                    .build())
                .connectionNamePrefixTemplate("template1")
                .enabledFeatures(            
                    "scim",
                    "universal_logout")
                .build());
    
            final var myProfileDs = Auth0Functions.getConnectionProfile(GetConnectionProfileArgs.builder()
                .id(myProfile.id())
                .build());
    
        }
    }
    
    resources:
      myProfile:
        type: auth0:ConnectionProfile
        name: my_profile
        properties:
          name: My-Profile
          organization:
            showAsButton: optional
            assignMembershipOnLogin: required
          connectionNamePrefixTemplate: template1
          enabledFeatures:
            - scim
            - universal_logout
    variables:
      myProfileDs:
        fn::invoke:
          function: auth0:getConnectionProfile
          arguments:
            id: ${myProfile.id}
    

    Using getConnectionProfile

    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 getConnectionProfile(args: GetConnectionProfileArgs, opts?: InvokeOptions): Promise<GetConnectionProfileResult>
    function getConnectionProfileOutput(args: GetConnectionProfileOutputArgs, opts?: InvokeOptions): Output<GetConnectionProfileResult>
    def get_connection_profile(id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetConnectionProfileResult
    def get_connection_profile_output(id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetConnectionProfileResult]
    func LookupConnectionProfile(ctx *Context, args *LookupConnectionProfileArgs, opts ...InvokeOption) (*LookupConnectionProfileResult, error)
    func LookupConnectionProfileOutput(ctx *Context, args *LookupConnectionProfileOutputArgs, opts ...InvokeOption) LookupConnectionProfileResultOutput

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

    public static class GetConnectionProfile 
    {
        public static Task<GetConnectionProfileResult> InvokeAsync(GetConnectionProfileArgs args, InvokeOptions? opts = null)
        public static Output<GetConnectionProfileResult> Invoke(GetConnectionProfileInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetConnectionProfileResult> getConnectionProfile(GetConnectionProfileArgs args, InvokeOptions options)
    public static Output<GetConnectionProfileResult> getConnectionProfile(GetConnectionProfileArgs args, InvokeOptions options)
    
    fn::invoke:
      function: auth0:index/getConnectionProfile:getConnectionProfile
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Id string
    id String
    id string
    id str
    id String

    getConnectionProfile Result

    The following output properties are available:

    Supporting Types

    GetConnectionProfileOrganization

    AssignMembershipOnLogin string
    Whether to assign membership on login.
    ShowAsButton string
    Whether to show organization as a button.
    AssignMembershipOnLogin string
    Whether to assign membership on login.
    ShowAsButton string
    Whether to show organization as a button.
    assignMembershipOnLogin String
    Whether to assign membership on login.
    showAsButton String
    Whether to show organization as a button.
    assignMembershipOnLogin string
    Whether to assign membership on login.
    showAsButton string
    Whether to show organization as a button.
    assign_membership_on_login str
    Whether to assign membership on login.
    show_as_button str
    Whether to show organization as a button.
    assignMembershipOnLogin String
    Whether to assign membership on login.
    showAsButton String
    Whether to show organization as a button.

    GetConnectionProfileStrategyOverride

    Ad GetConnectionProfileStrategyOverrideAd
    Strategy override configuration.
    Adfs GetConnectionProfileStrategyOverrideAdfs
    Strategy override configuration.
    GoogleApps GetConnectionProfileStrategyOverrideGoogleApps
    Strategy override configuration.
    Oidc GetConnectionProfileStrategyOverrideOidc
    Strategy override configuration.
    Okta GetConnectionProfileStrategyOverrideOkta
    Strategy override configuration.
    Pingfederate GetConnectionProfileStrategyOverridePingfederate
    Strategy override configuration.
    Samlp GetConnectionProfileStrategyOverrideSamlp
    Strategy override configuration.
    Waad GetConnectionProfileStrategyOverrideWaad
    Strategy override configuration.
    Ad GetConnectionProfileStrategyOverrideAd
    Strategy override configuration.
    Adfs GetConnectionProfileStrategyOverrideAdfs
    Strategy override configuration.
    GoogleApps GetConnectionProfileStrategyOverrideGoogleApps
    Strategy override configuration.
    Oidc GetConnectionProfileStrategyOverrideOidc
    Strategy override configuration.
    Okta GetConnectionProfileStrategyOverrideOkta
    Strategy override configuration.
    Pingfederate GetConnectionProfileStrategyOverridePingfederate
    Strategy override configuration.
    Samlp GetConnectionProfileStrategyOverrideSamlp
    Strategy override configuration.
    Waad GetConnectionProfileStrategyOverrideWaad
    Strategy override configuration.
    ad GetConnectionProfileStrategyOverrideAd
    Strategy override configuration.
    adfs GetConnectionProfileStrategyOverrideAdfs
    Strategy override configuration.
    googleApps GetConnectionProfileStrategyOverrideGoogleApps
    Strategy override configuration.
    oidc GetConnectionProfileStrategyOverrideOidc
    Strategy override configuration.
    okta GetConnectionProfileStrategyOverrideOkta
    Strategy override configuration.
    pingfederate GetConnectionProfileStrategyOverridePingfederate
    Strategy override configuration.
    samlp GetConnectionProfileStrategyOverrideSamlp
    Strategy override configuration.
    waad GetConnectionProfileStrategyOverrideWaad
    Strategy override configuration.
    ad GetConnectionProfileStrategyOverrideAd
    Strategy override configuration.
    adfs GetConnectionProfileStrategyOverrideAdfs
    Strategy override configuration.
    googleApps GetConnectionProfileStrategyOverrideGoogleApps
    Strategy override configuration.
    oidc GetConnectionProfileStrategyOverrideOidc
    Strategy override configuration.
    okta GetConnectionProfileStrategyOverrideOkta
    Strategy override configuration.
    pingfederate GetConnectionProfileStrategyOverridePingfederate
    Strategy override configuration.
    samlp GetConnectionProfileStrategyOverrideSamlp
    Strategy override configuration.
    waad GetConnectionProfileStrategyOverrideWaad
    Strategy override configuration.
    ad GetConnectionProfileStrategyOverrideAd
    Strategy override configuration.
    adfs GetConnectionProfileStrategyOverrideAdfs
    Strategy override configuration.
    google_apps GetConnectionProfileStrategyOverrideGoogleApps
    Strategy override configuration.
    oidc GetConnectionProfileStrategyOverrideOidc
    Strategy override configuration.
    okta GetConnectionProfileStrategyOverrideOkta
    Strategy override configuration.
    pingfederate GetConnectionProfileStrategyOverridePingfederate
    Strategy override configuration.
    samlp GetConnectionProfileStrategyOverrideSamlp
    Strategy override configuration.
    waad GetConnectionProfileStrategyOverrideWaad
    Strategy override configuration.
    ad Property Map
    Strategy override configuration.
    adfs Property Map
    Strategy override configuration.
    googleApps Property Map
    Strategy override configuration.
    oidc Property Map
    Strategy override configuration.
    okta Property Map
    Strategy override configuration.
    pingfederate Property Map
    Strategy override configuration.
    samlp Property Map
    Strategy override configuration.
    waad Property Map
    Strategy override configuration.

    GetConnectionProfileStrategyOverrideAd

    ConnectionConfig GetConnectionProfileStrategyOverrideAdConnectionConfig
    Connection config for the strategy override.
    EnabledFeatures List<string>
    Enabled features for the strategy override.
    ConnectionConfig GetConnectionProfileStrategyOverrideAdConnectionConfig
    Connection config for the strategy override.
    EnabledFeatures []string
    Enabled features for the strategy override.
    connectionConfig GetConnectionProfileStrategyOverrideAdConnectionConfig
    Connection config for the strategy override.
    enabledFeatures List<String>
    Enabled features for the strategy override.
    connectionConfig GetConnectionProfileStrategyOverrideAdConnectionConfig
    Connection config for the strategy override.
    enabledFeatures string[]
    Enabled features for the strategy override.
    connection_config GetConnectionProfileStrategyOverrideAdConnectionConfig
    Connection config for the strategy override.
    enabled_features Sequence[str]
    Enabled features for the strategy override.
    connectionConfig Property Map
    Connection config for the strategy override.
    enabledFeatures List<String>
    Enabled features for the strategy override.

    GetConnectionProfileStrategyOverrideAdfs

    ConnectionConfig GetConnectionProfileStrategyOverrideAdfsConnectionConfig
    Connection config for the strategy override.
    EnabledFeatures List<string>
    Enabled features for the strategy override.
    ConnectionConfig GetConnectionProfileStrategyOverrideAdfsConnectionConfig
    Connection config for the strategy override.
    EnabledFeatures []string
    Enabled features for the strategy override.
    connectionConfig GetConnectionProfileStrategyOverrideAdfsConnectionConfig
    Connection config for the strategy override.
    enabledFeatures List<String>
    Enabled features for the strategy override.
    connectionConfig GetConnectionProfileStrategyOverrideAdfsConnectionConfig
    Connection config for the strategy override.
    enabledFeatures string[]
    Enabled features for the strategy override.
    connection_config GetConnectionProfileStrategyOverrideAdfsConnectionConfig
    Connection config for the strategy override.
    enabled_features Sequence[str]
    Enabled features for the strategy override.
    connectionConfig Property Map
    Connection config for the strategy override.
    enabledFeatures List<String>
    Enabled features for the strategy override.

    GetConnectionProfileStrategyOverrideGoogleApps

    ConnectionConfig GetConnectionProfileStrategyOverrideGoogleAppsConnectionConfig
    Connection config for the strategy override.
    EnabledFeatures List<string>
    Enabled features for the strategy override.
    ConnectionConfig GetConnectionProfileStrategyOverrideGoogleAppsConnectionConfig
    Connection config for the strategy override.
    EnabledFeatures []string
    Enabled features for the strategy override.
    connectionConfig GetConnectionProfileStrategyOverrideGoogleAppsConnectionConfig
    Connection config for the strategy override.
    enabledFeatures List<String>
    Enabled features for the strategy override.
    connectionConfig GetConnectionProfileStrategyOverrideGoogleAppsConnectionConfig
    Connection config for the strategy override.
    enabledFeatures string[]
    Enabled features for the strategy override.
    connection_config GetConnectionProfileStrategyOverrideGoogleAppsConnectionConfig
    Connection config for the strategy override.
    enabled_features Sequence[str]
    Enabled features for the strategy override.
    connectionConfig Property Map
    Connection config for the strategy override.
    enabledFeatures List<String>
    Enabled features for the strategy override.

    GetConnectionProfileStrategyOverrideOidc

    ConnectionConfig GetConnectionProfileStrategyOverrideOidcConnectionConfig
    Connection config for the strategy override.
    EnabledFeatures List<string>
    Enabled features for the strategy override.
    ConnectionConfig GetConnectionProfileStrategyOverrideOidcConnectionConfig
    Connection config for the strategy override.
    EnabledFeatures []string
    Enabled features for the strategy override.
    connectionConfig GetConnectionProfileStrategyOverrideOidcConnectionConfig
    Connection config for the strategy override.
    enabledFeatures List<String>
    Enabled features for the strategy override.
    connectionConfig GetConnectionProfileStrategyOverrideOidcConnectionConfig
    Connection config for the strategy override.
    enabledFeatures string[]
    Enabled features for the strategy override.
    connection_config GetConnectionProfileStrategyOverrideOidcConnectionConfig
    Connection config for the strategy override.
    enabled_features Sequence[str]
    Enabled features for the strategy override.
    connectionConfig Property Map
    Connection config for the strategy override.
    enabledFeatures List<String>
    Enabled features for the strategy override.

    GetConnectionProfileStrategyOverrideOkta

    ConnectionConfig GetConnectionProfileStrategyOverrideOktaConnectionConfig
    Connection config for the strategy override.
    EnabledFeatures List<string>
    Enabled features for the strategy override.
    ConnectionConfig GetConnectionProfileStrategyOverrideOktaConnectionConfig
    Connection config for the strategy override.
    EnabledFeatures []string
    Enabled features for the strategy override.
    connectionConfig GetConnectionProfileStrategyOverrideOktaConnectionConfig
    Connection config for the strategy override.
    enabledFeatures List<String>
    Enabled features for the strategy override.
    connectionConfig GetConnectionProfileStrategyOverrideOktaConnectionConfig
    Connection config for the strategy override.
    enabledFeatures string[]
    Enabled features for the strategy override.
    connection_config GetConnectionProfileStrategyOverrideOktaConnectionConfig
    Connection config for the strategy override.
    enabled_features Sequence[str]
    Enabled features for the strategy override.
    connectionConfig Property Map
    Connection config for the strategy override.
    enabledFeatures List<String>
    Enabled features for the strategy override.

    GetConnectionProfileStrategyOverridePingfederate

    ConnectionConfig GetConnectionProfileStrategyOverridePingfederateConnectionConfig
    Connection config for the strategy override.
    EnabledFeatures List<string>
    Enabled features for the strategy override.
    ConnectionConfig GetConnectionProfileStrategyOverridePingfederateConnectionConfig
    Connection config for the strategy override.
    EnabledFeatures []string
    Enabled features for the strategy override.
    connectionConfig GetConnectionProfileStrategyOverridePingfederateConnectionConfig
    Connection config for the strategy override.
    enabledFeatures List<String>
    Enabled features for the strategy override.
    connectionConfig GetConnectionProfileStrategyOverridePingfederateConnectionConfig
    Connection config for the strategy override.
    enabledFeatures string[]
    Enabled features for the strategy override.
    connection_config GetConnectionProfileStrategyOverridePingfederateConnectionConfig
    Connection config for the strategy override.
    enabled_features Sequence[str]
    Enabled features for the strategy override.
    connectionConfig Property Map
    Connection config for the strategy override.
    enabledFeatures List<String>
    Enabled features for the strategy override.

    GetConnectionProfileStrategyOverrideSamlp

    ConnectionConfig GetConnectionProfileStrategyOverrideSamlpConnectionConfig
    Connection config for the strategy override.
    EnabledFeatures List<string>
    Enabled features for the strategy override.
    ConnectionConfig GetConnectionProfileStrategyOverrideSamlpConnectionConfig
    Connection config for the strategy override.
    EnabledFeatures []string
    Enabled features for the strategy override.
    connectionConfig GetConnectionProfileStrategyOverrideSamlpConnectionConfig
    Connection config for the strategy override.
    enabledFeatures List<String>
    Enabled features for the strategy override.
    connectionConfig GetConnectionProfileStrategyOverrideSamlpConnectionConfig
    Connection config for the strategy override.
    enabledFeatures string[]
    Enabled features for the strategy override.
    connection_config GetConnectionProfileStrategyOverrideSamlpConnectionConfig
    Connection config for the strategy override.
    enabled_features Sequence[str]
    Enabled features for the strategy override.
    connectionConfig Property Map
    Connection config for the strategy override.
    enabledFeatures List<String>
    Enabled features for the strategy override.

    GetConnectionProfileStrategyOverrideWaad

    ConnectionConfig GetConnectionProfileStrategyOverrideWaadConnectionConfig
    Connection config for the strategy override.
    EnabledFeatures List<string>
    Enabled features for the strategy override.
    ConnectionConfig GetConnectionProfileStrategyOverrideWaadConnectionConfig
    Connection config for the strategy override.
    EnabledFeatures []string
    Enabled features for the strategy override.
    connectionConfig GetConnectionProfileStrategyOverrideWaadConnectionConfig
    Connection config for the strategy override.
    enabledFeatures List<String>
    Enabled features for the strategy override.
    connectionConfig GetConnectionProfileStrategyOverrideWaadConnectionConfig
    Connection config for the strategy override.
    enabledFeatures string[]
    Enabled features for the strategy override.
    connection_config GetConnectionProfileStrategyOverrideWaadConnectionConfig
    Connection config for the strategy override.
    enabled_features Sequence[str]
    Enabled features for the strategy override.
    connectionConfig Property Map
    Connection config for the strategy override.
    enabledFeatures List<String>
    Enabled features for the strategy override.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo
    Auth0 v3.34.0 published on Thursday, Nov 20, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate