Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Propelauth Provider
  3. API Docs
  4. SocialLogin
propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
propelauth/terraform-provider-propelauth

propelauth.SocialLogin

Explore with Pulumi AI

propelauth logo
propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
propelauth/terraform-provider-propelauth

    Backend API Key resource. This is for configuring the basic BE API key information in PropelAuth.

    Example Usage

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

const config = new pulumi.Config();
const githubClientSecret = config.require("githubClientSecret");
const githubSso = new propelauth.SocialLogin("githubSso", {
    socialProvider: "GitHub",
    clientId: "my-client-id",
    clientSecret: githubClientSecret,
});

    import pulumi
import pulumi_propelauth as propelauth

config = pulumi.Config()
github_client_secret = config.require("githubClientSecret")
github_sso = propelauth.SocialLogin("githubSso",
    social_provider="GitHub",
    client_id="my-client-id",
    client_secret=github_client_secret)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/propelauth/propelauth"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		githubClientSecret := cfg.Require("githubClientSecret")
		_, err := propelauth.NewSocialLogin(ctx, "githubSso", &propelauth.SocialLoginArgs{
			SocialProvider: pulumi.String("GitHub"),
			ClientId:       pulumi.String("my-client-id"),
			ClientSecret:   pulumi.String(githubClientSecret),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var githubClientSecret = config.Require("githubClientSecret");
    var githubSso = new Propelauth.SocialLogin("githubSso", new()
    {
        SocialProvider = "GitHub",
        ClientId = "my-client-id",
        ClientSecret = githubClientSecret,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.propelauth.SocialLogin;
import com.pulumi.propelauth.SocialLoginArgs;
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 config = ctx.config();
        final var githubClientSecret = config.get("githubClientSecret");
        var githubSso = new SocialLogin("githubSso", SocialLoginArgs.builder()
            .socialProvider("GitHub")
            .clientId("my-client-id")
            .clientSecret(githubClientSecret)
            .build());

    }
}

    configuration:
  githubClientSecret:
    type: string
resources:
  githubSso:
    type: propelauth:SocialLogin
    properties:
      socialProvider: GitHub
      clientId: my-client-id
      clientSecret: ${githubClientSecret}

    Create SocialLogin Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SocialLogin(name: string, args: SocialLoginArgs, opts?: CustomResourceOptions);
    @overload
def SocialLogin(resource_name: str,
                args: SocialLoginArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def SocialLogin(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                client_id: Optional[str] = None,
                client_secret: Optional[str] = None,
                social_provider: Optional[str] = None)
    func NewSocialLogin(ctx *Context, name string, args SocialLoginArgs, opts ...ResourceOption) (*SocialLogin, error)
    public SocialLogin(string name, SocialLoginArgs args, CustomResourceOptions? opts = null)
    public SocialLogin(String name, SocialLoginArgs args)
public SocialLogin(String name, SocialLoginArgs args, CustomResourceOptions options)

    type: propelauth:SocialLogin
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SocialLoginArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SocialLoginArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SocialLoginArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SocialLoginArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SocialLoginArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var socialLoginResource = new Propelauth.SocialLogin("socialLoginResource", new()
{
    ClientId = "string",
    ClientSecret = "string",
    SocialProvider = "string",
});

    example, err := propelauth.NewSocialLogin(ctx, "socialLoginResource", &propelauth.SocialLoginArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
SocialProvider: pulumi.String("string"),
})

    var socialLoginResource = new SocialLogin("socialLoginResource", SocialLoginArgs.builder()
    .clientId("string")
    .clientSecret("string")
    .socialProvider("string")
    .build());

    social_login_resource = propelauth.SocialLogin("socialLoginResource",
    client_id="string",
    client_secret="string",
    social_provider="string")

    const socialLoginResource = new propelauth.SocialLogin("socialLoginResource", {
    clientId: "string",
    clientSecret: "string",
    socialProvider: "string",
});

    type: propelauth:SocialLogin
properties:
    clientId: string
    clientSecret: string
    socialProvider: string

    SocialLogin Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SocialLogin resource accepts the following input properties:

    ClientId string
    The client ID. This is a unique identifier for the oauth client that can be retrieved from the OIDC provider.
    ClientSecret string
    The client secret for the oauth client that can be retrieved from the OIDC provider.
    SocialProvider string
    The OIDC provider for the Social Login you're configuring. This is only for internal dislay purposes.Accepted values are Google, Microsoft, GitHub, Slack, LinkedIn, Atlassian, Apple, Salesforce, QuickBooks, Xero, Salesloft, and Outreach.
    ClientId string
    The client ID. This is a unique identifier for the oauth client that can be retrieved from the OIDC provider.
    ClientSecret string
    The client secret for the oauth client that can be retrieved from the OIDC provider.
    SocialProvider string
    The OIDC provider for the Social Login you're configuring. This is only for internal dislay purposes.Accepted values are Google, Microsoft, GitHub, Slack, LinkedIn, Atlassian, Apple, Salesforce, QuickBooks, Xero, Salesloft, and Outreach.
    clientId String
    The client ID. This is a unique identifier for the oauth client that can be retrieved from the OIDC provider.
    clientSecret String
    The client secret for the oauth client that can be retrieved from the OIDC provider.
    socialProvider String
    The OIDC provider for the Social Login you're configuring. This is only for internal dislay purposes.Accepted values are Google, Microsoft, GitHub, Slack, LinkedIn, Atlassian, Apple, Salesforce, QuickBooks, Xero, Salesloft, and Outreach.
    clientId string
    The client ID. This is a unique identifier for the oauth client that can be retrieved from the OIDC provider.
    clientSecret string
    The client secret for the oauth client that can be retrieved from the OIDC provider.
    socialProvider string
    The OIDC provider for the Social Login you're configuring. This is only for internal dislay purposes.Accepted values are Google, Microsoft, GitHub, Slack, LinkedIn, Atlassian, Apple, Salesforce, QuickBooks, Xero, Salesloft, and Outreach.
    client_id str
    The client ID. This is a unique identifier for the oauth client that can be retrieved from the OIDC provider.
    client_secret str
    The client secret for the oauth client that can be retrieved from the OIDC provider.
    social_provider str
    The OIDC provider for the Social Login you're configuring. This is only for internal dislay purposes.Accepted values are Google, Microsoft, GitHub, Slack, LinkedIn, Atlassian, Apple, Salesforce, QuickBooks, Xero, Salesloft, and Outreach.
    clientId String
    The client ID. This is a unique identifier for the oauth client that can be retrieved from the OIDC provider.
    clientSecret String
    The client secret for the oauth client that can be retrieved from the OIDC provider.
    socialProvider String
    The OIDC provider for the Social Login you're configuring. This is only for internal dislay purposes.Accepted values are Google, Microsoft, GitHub, Slack, LinkedIn, Atlassian, Apple, Salesforce, QuickBooks, Xero, Salesloft, and Outreach.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SocialLogin resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SocialLogin Resource

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

    public static get(name: string, id: Input<ID>, state?: SocialLoginState, opts?: CustomResourceOptions): SocialLogin
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        social_provider: Optional[str] = None) -> SocialLogin
    func GetSocialLogin(ctx *Context, name string, id IDInput, state *SocialLoginState, opts ...ResourceOption) (*SocialLogin, error)
    public static SocialLogin Get(string name, Input<string> id, SocialLoginState? state, CustomResourceOptions? opts = null)
    public static SocialLogin get(String name, Output<String> id, SocialLoginState state, CustomResourceOptions options)
    resources:  _:    type: propelauth:SocialLogin    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ClientId string
    The client ID. This is a unique identifier for the oauth client that can be retrieved from the OIDC provider.
    ClientSecret string
    The client secret for the oauth client that can be retrieved from the OIDC provider.
    SocialProvider string
    The OIDC provider for the Social Login you're configuring. This is only for internal dislay purposes.Accepted values are Google, Microsoft, GitHub, Slack, LinkedIn, Atlassian, Apple, Salesforce, QuickBooks, Xero, Salesloft, and Outreach.
    ClientId string
    The client ID. This is a unique identifier for the oauth client that can be retrieved from the OIDC provider.
    ClientSecret string
    The client secret for the oauth client that can be retrieved from the OIDC provider.
    SocialProvider string
    The OIDC provider for the Social Login you're configuring. This is only for internal dislay purposes.Accepted values are Google, Microsoft, GitHub, Slack, LinkedIn, Atlassian, Apple, Salesforce, QuickBooks, Xero, Salesloft, and Outreach.
    clientId String
    The client ID. This is a unique identifier for the oauth client that can be retrieved from the OIDC provider.
    clientSecret String
    The client secret for the oauth client that can be retrieved from the OIDC provider.
    socialProvider String
    The OIDC provider for the Social Login you're configuring. This is only for internal dislay purposes.Accepted values are Google, Microsoft, GitHub, Slack, LinkedIn, Atlassian, Apple, Salesforce, QuickBooks, Xero, Salesloft, and Outreach.
    clientId string
    The client ID. This is a unique identifier for the oauth client that can be retrieved from the OIDC provider.
    clientSecret string
    The client secret for the oauth client that can be retrieved from the OIDC provider.
    socialProvider string
    The OIDC provider for the Social Login you're configuring. This is only for internal dislay purposes.Accepted values are Google, Microsoft, GitHub, Slack, LinkedIn, Atlassian, Apple, Salesforce, QuickBooks, Xero, Salesloft, and Outreach.
    client_id str
    The client ID. This is a unique identifier for the oauth client that can be retrieved from the OIDC provider.
    client_secret str
    The client secret for the oauth client that can be retrieved from the OIDC provider.
    social_provider str
    The OIDC provider for the Social Login you're configuring. This is only for internal dislay purposes.Accepted values are Google, Microsoft, GitHub, Slack, LinkedIn, Atlassian, Apple, Salesforce, QuickBooks, Xero, Salesloft, and Outreach.
    clientId String
    The client ID. This is a unique identifier for the oauth client that can be retrieved from the OIDC provider.
    clientSecret String
    The client secret for the oauth client that can be retrieved from the OIDC provider.
    socialProvider String
    The OIDC provider for the Social Login you're configuring. This is only for internal dislay purposes.Accepted values are Google, Microsoft, GitHub, Slack, LinkedIn, Atlassian, Apple, Salesforce, QuickBooks, Xero, Salesloft, and Outreach.

    Import

    Import an existing social login integration by the social_provider name

    $ pulumi import propelauth:index/socialLogin:SocialLogin github_sso GitHub

    or

    $ pulumi import propelauth:index/socialLogin:SocialLogin mircosoft_sso Microsoft

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    propelauth propelauth/terraform-provider-propelauth
    License
    Notes
    This Pulumi package is based on the propelauth Terraform Provider.
    propelauth logo
    propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
    propelauth/terraform-provider-propelauth