Class Connection

With Auth0, you can define sources of users, otherwise known as connections, which may include identity providers (such as Google or LinkedIn), databases, or passwordless authentication methods. This resource allows you to configure and manage connections to be used with your clients and users.

Example Usage

using Pulumi;
using Auth0 = Pulumi.Auth0;

class MyStack : Stack
{
public MyStack()
{
    var myConnection = new Auth0.Connection("myConnection", new Auth0.ConnectionArgs
    {
        Options = new Auth0.Inputs.ConnectionOptionsArgs
        {
            BruteForceProtection = "true",
            Configuration = 
            {
                { "bar", "baz" },
                { "foo", "bar" },
            },
            CustomScripts = 
            {
                { "getUser", @"function getByEmail (email, callback) {
return callback(new Error(""Whoops!""))
}

" },
            },
            EnabledDatabaseCustomization = "true",
            PasswordHistory = 
            {

                {
                    { "enable", true },
                    { "size", 3 },
                },
            },
            PasswordPolicy = "excellent",
        },
        Strategy = "auth0",
    });
    var myWaadConnection = new Auth0.Connection("myWaadConnection", new Auth0.ConnectionArgs
    {
        Options = new Auth0.Inputs.ConnectionOptionsArgs
        {
            ApiEnableUsers = true,
            AppDomain = "my-auth0-app.eu.auth0.com",
            BasicProfile = true,
            ClientId = "1234",
            ClientSecret = "1234",
            DomainAliases = 
            {
                "example.io",
            },
            ExtGroups = true,
            ExtProfile = true,
            TenantDomain = "exmaple.onmicrosoft.com",
            UseWsfed = false,
            WaadCommonEndpoint = false,
            WaadProtocol = "openid-connect",
        },
        Strategy = "waad",
    });
}

}

Inheritance

System.Object

Pulumi.Resource

Pulumi.CustomResource

Connection

Inherited Members

Pulumi.CustomResource.Id

Pulumi.Resource.GetResourceType()

Pulumi.Resource.GetResourceName()

Pulumi.Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Auth0

Assembly: Pulumi.Auth0.dll

Syntax

public class Connection : CustomResource

Constructors

Connection(String, ConnectionArgs, CustomResourceOptions)

Create a Connection resource with the given unique name, arguments, and options.

Declaration

public Connection(string name, ConnectionArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ConnectionArgs	args	The arguments used to populate this resource's properties
Pulumi.CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

DisplayName

Name used in login screen

Declaration

public Output<string> DisplayName { get; }

Property Value

Type	Description
Pulumi.Output<System.String>

EnabledClients

Set(String). IDs of the clients for which the connection is enabled. If not specified, no clients are enabled.

Declaration

public Output<ImmutableArray<string>> EnabledClients { get; }

Property Value

Type	Description
Pulumi.Output<System.Collections.Immutable.ImmutableArray<System.String>>

IsDomainConnection

Boolean. Indicates whether or not the connection is domain level.

Declaration

public Output<bool> IsDomainConnection { get; }

Property Value

Type	Description
Pulumi.Output<System.Boolean>

Name

String. Name of the connection.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Pulumi.Output<System.String>

Options

List(Resource). Configuration settings for connection options. For details, see Options.

Declaration

public Output<ConnectionOptions> Options { get; }

Property Value

Type	Description
Pulumi.Output<ConnectionOptions>

Realms

List(String). Defines the realms for which the connection will be used (i.e., email domains). If not specified, the connection name is added as the realm.

Declaration

public Output<ImmutableArray<string>> Realms { get; }

Property Value

Type	Description
Pulumi.Output<System.Collections.Immutable.ImmutableArray<System.String>>

Strategy

String. Type of the connection, which indicates the identity provider. Options include ad, adfs, amazon, aol, apple, auth0, auth0-adldap, auth0-oidc, baidu, bitbucket, bitly, box, custom, daccount, dropbox, dwolla, email, evernote, evernote-sandbox, exact, facebook, fitbit, flickr, github, google-apps, google-oauth2, guardian, instagram, ip, line, linkedin, miicard, oauth1, oauth2, office365, oidc, paypal, paypal-sandbox, pingfederate, planningcenter, renren, salesforce, salesforce-community, salesforce-sandbox samlp, sharepoint, shopify, sms, soundcloud, thecity, thecity-sandbox, thirtysevensignals, twitter, untappd, vkontakte, waad, weibo, windowslive, wordpress, yahoo, yammer, yandex.

Declaration

public Output<string> Strategy { get; }

Property Value

Type	Description
Pulumi.Output<System.String>

StrategyVersion

Int. Version 1 is deprecated, use version 2.

Declaration

public Output<string> StrategyVersion { get; }

Property Value

Type	Description
Pulumi.Output<System.String>

Methods

Get(String, Input<String>, ConnectionState, CustomResourceOptions)

Get an existing Connection resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Connection Get(string name, Input<string> id, ConnectionState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Pulumi.Input<System.String>	id	The unique provider ID of the resource to lookup.
ConnectionState	state	Any extra arguments used during the lookup.
Pulumi.CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Connection