Docs Packages
  1. Packages
  2. FusionAuth
  3. API Docs
  4. FusionAuthIdpFacebook
FusionAuth v4.0.1 published on Saturday, Sep 30, 2023 by Theo Gravity
theogravity/pulumi-fusionauth

fusionauth.FusionAuthIdpFacebook

Explore with Pulumi AI

fusionauth logo
FusionAuth v4.0.1 published on Saturday, Sep 30, 2023 by Theo Gravity
theogravity/pulumi-fusionauth

    # Facebook Identity Provider Resource

    The Facebook identity provider type will use the Facebook OAuth login API. It will provide a Login with Facebook button on FusionAuth’s login page that will leverage the Facebook login pop-up dialog. Additionally, this identity provider will call Facebook’s Graph API to load additional details about the user and store them in FusionAuth.

    The email address returned by the Facebook Graph API will be used to create or lookup the existing user. Additional claims returned by Facebook can be used to reconcile the User to FusionAuth by using a Facebook Reconcile Lambda. Unless you assign a reconcile lambda to this provider, on the email address will be used from the available claims returned by Facebook.

    When the picture field is not requested FusionAuth will also call Facebook’s /me/picture API to load the user’s profile image and store it as the imageUrl in FusionAuth. When the picture field is requested, the user’s profile image will be returned by the /me API and a second request to the /me/picture endpoint will not be required.

    Finally, FusionAuth will call Facebook’s /oauth/access_token API to exchange the login token for a long-lived Facebook token. This token is stored in the UserRegistration object inside the tokens Map. This Map stores the tokens from the various identity providers so that you can use them in your application to call their APIs.

    Please note if an idp_hint is appended to the OAuth Authorize endpoint, then the interaction behavior will be defaulted to redirect, even if popup interaction is explicitly configured.

    Facebook Identity Providers API

    Example Usage

    using System.Collections.Generic;
using Pulumi;
using Fusionauth = theogravity.Fusionauth;

return await Deployment.RunAsync(() => 
{
    var facebook = new Fusionauth.FusionAuthIdpFacebook("facebook", new()
    {
        ApplicationConfigurations = new[]
        {
            new Fusionauth.Inputs.FusionAuthIdpFacebookApplicationConfigurationArgs
            {
                ApplicationId = fusionauth_application.Myapp.Id,
                CreateRegistration = true,
                Enabled = true,
            },
        },
        ButtonText = "Login with Facebook",
        Debug = false,
        Enabled = true,
        AppId = "9876543210",
        ClientSecret = "716a572f917640698cdb99e9d7e64115",
        Fields = "email",
        Permissions = "email",
    });

});

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/theogravity/pulumi-fusionauth/sdk/v3/go/fusionauth"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fusionauth.NewFusionAuthIdpFacebook(ctx, "facebook", &fusionauth.FusionAuthIdpFacebookArgs{
			ApplicationConfigurations: fusionauth.FusionAuthIdpFacebookApplicationConfigurationArray{
				&fusionauth.FusionAuthIdpFacebookApplicationConfigurationArgs{
					ApplicationId:      pulumi.Any(fusionauth_application.Myapp.Id),
					CreateRegistration: pulumi.Bool(true),
					Enabled:            pulumi.Bool(true),
				},
			},
			ButtonText:   pulumi.String("Login with Facebook"),
			Debug:        pulumi.Bool(false),
			Enabled:      pulumi.Bool(true),
			AppId:        pulumi.String("9876543210"),
			ClientSecret: pulumi.String("716a572f917640698cdb99e9d7e64115"),
			Fields:       pulumi.String("email"),
			Permissions:  pulumi.String("email"),
		})
		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.fusionauth.FusionAuthIdpFacebook;
import com.pulumi.fusionauth.FusionAuthIdpFacebookArgs;
import com.pulumi.fusionauth.inputs.FusionAuthIdpFacebookApplicationConfigurationArgs;
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 facebook = new FusionAuthIdpFacebook("facebook", FusionAuthIdpFacebookArgs.builder()        
            .applicationConfigurations(FusionAuthIdpFacebookApplicationConfigurationArgs.builder()
                .applicationId(fusionauth_application.myapp().id())
                .createRegistration(true)
                .enabled(true)
                .build())
            .buttonText("Login with Facebook")
            .debug(false)
            .enabled(true)
            .appId("9876543210")
            .clientSecret("716a572f917640698cdb99e9d7e64115")
            .fields("email")
            .permissions("email")
            .build());

    }
}

    import pulumi
import theogravity_pulumi-fusionauth as fusionauth

facebook = fusionauth.FusionAuthIdpFacebook("facebook",
    application_configurations=[fusionauth.FusionAuthIdpFacebookApplicationConfigurationArgs(
        application_id=fusionauth_application["myapp"]["id"],
        create_registration=True,
        enabled=True,
    )],
    button_text="Login with Facebook",
    debug=False,
    enabled=True,
    app_id="9876543210",
    client_secret="716a572f917640698cdb99e9d7e64115",
    fields="email",
    permissions="email")

    import * as pulumi from "@pulumi/pulumi";
import * as fusionauth from "pulumi-fusionauth";

const facebook = new fusionauth.FusionAuthIdpFacebook("facebook", {
    applicationConfigurations: [{
        applicationId: fusionauth_application.myapp.id,
        createRegistration: true,
        enabled: true,
    }],
    buttonText: "Login with Facebook",
    debug: false,
    enabled: true,
    appId: "9876543210",
    clientSecret: "716a572f917640698cdb99e9d7e64115",
    fields: "email",
    permissions: "email",
});

    resources:
  facebook:
    type: fusionauth:FusionAuthIdpFacebook
    properties:
      applicationConfigurations:
        - applicationId: ${fusionauth_application.myapp.id}
          createRegistration: true
          enabled: true
      buttonText: Login with Facebook
      debug: false
      enabled: true
      appId: '9876543210'
      clientSecret: 716a572f917640698cdb99e9d7e64115
      fields: email
      permissions: email

    Create FusionAuthIdpFacebook Resource

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

    Constructor syntax

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

@overload
def FusionAuthIdpFacebook(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          app_id: Optional[str] = None,
                          button_text: Optional[str] = None,
                          client_secret: Optional[str] = None,
                          application_configurations: Optional[Sequence[FusionAuthIdpFacebookApplicationConfigurationArgs]] = None,
                          debug: Optional[bool] = None,
                          enabled: Optional[bool] = None,
                          fields: Optional[str] = None,
                          lambda_reconcile_id: Optional[str] = None,
                          linking_strategy: Optional[str] = None,
                          login_method: Optional[str] = None,
                          permissions: Optional[str] = None,
                          tenant_configurations: Optional[Sequence[FusionAuthIdpFacebookTenantConfigurationArgs]] = None)
    func NewFusionAuthIdpFacebook(ctx *Context, name string, args FusionAuthIdpFacebookArgs, opts ...ResourceOption) (*FusionAuthIdpFacebook, error)
    public FusionAuthIdpFacebook(string name, FusionAuthIdpFacebookArgs args, CustomResourceOptions? opts = null)
    public FusionAuthIdpFacebook(String name, FusionAuthIdpFacebookArgs args)
public FusionAuthIdpFacebook(String name, FusionAuthIdpFacebookArgs args, CustomResourceOptions options)

    type: fusionauth:FusionAuthIdpFacebook
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 FusionAuthIdpFacebookArgs
    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 FusionAuthIdpFacebookArgs
    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 FusionAuthIdpFacebookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FusionAuthIdpFacebookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FusionAuthIdpFacebookArgs
    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 fusionAuthIdpFacebookResource = new Fusionauth.FusionAuthIdpFacebook("fusionAuthIdpFacebookResource", new()
{
    AppId = "string",
    ButtonText = "string",
    ClientSecret = "string",
    ApplicationConfigurations = new[]
    {
        new Fusionauth.Inputs.FusionAuthIdpFacebookApplicationConfigurationArgs
        {
            AppId = "string",
            ApplicationId = "string",
            ButtonText = "string",
            ClientSecret = "string",
            CreateRegistration = false,
            Enabled = false,
            Fields = "string",
            Permissions = "string",
        },
    },
    Debug = false,
    Enabled = false,
    Fields = "string",
    LambdaReconcileId = "string",
    LinkingStrategy = "string",
    LoginMethod = "string",
    Permissions = "string",
    TenantConfigurations = new[]
    {
        new Fusionauth.Inputs.FusionAuthIdpFacebookTenantConfigurationArgs
        {
            LimitUserLinkCountEnabled = false,
            LimitUserLinkCountMaximumLinks = 0,
            TenantId = "string",
        },
    },
});

    example, err := fusionauth.NewFusionAuthIdpFacebook(ctx, "fusionAuthIdpFacebookResource", &fusionauth.FusionAuthIdpFacebookArgs{
	AppId:        pulumi.String("string"),
	ButtonText:   pulumi.String("string"),
	ClientSecret: pulumi.String("string"),
	ApplicationConfigurations: fusionauth.FusionAuthIdpFacebookApplicationConfigurationArray{
		&fusionauth.FusionAuthIdpFacebookApplicationConfigurationArgs{
			AppId:              pulumi.String("string"),
			ApplicationId:      pulumi.String("string"),
			ButtonText:         pulumi.String("string"),
			ClientSecret:       pulumi.String("string"),
			CreateRegistration: pulumi.Bool(false),
			Enabled:            pulumi.Bool(false),
			Fields:             pulumi.String("string"),
			Permissions:        pulumi.String("string"),
		},
	},
	Debug:             pulumi.Bool(false),
	Enabled:           pulumi.Bool(false),
	Fields:            pulumi.String("string"),
	LambdaReconcileId: pulumi.String("string"),
	LinkingStrategy:   pulumi.String("string"),
	LoginMethod:       pulumi.String("string"),
	Permissions:       pulumi.String("string"),
	TenantConfigurations: fusionauth.FusionAuthIdpFacebookTenantConfigurationArray{
		&fusionauth.FusionAuthIdpFacebookTenantConfigurationArgs{
			LimitUserLinkCountEnabled:      pulumi.Bool(false),
			LimitUserLinkCountMaximumLinks: pulumi.Int(0),
			TenantId:                       pulumi.String("string"),
		},
	},
})

    var fusionAuthIdpFacebookResource = new FusionAuthIdpFacebook("fusionAuthIdpFacebookResource", FusionAuthIdpFacebookArgs.builder()
    .appId("string")
    .buttonText("string")
    .clientSecret("string")
    .applicationConfigurations(FusionAuthIdpFacebookApplicationConfigurationArgs.builder()
        .appId("string")
        .applicationId("string")
        .buttonText("string")
        .clientSecret("string")
        .createRegistration(false)
        .enabled(false)
        .fields("string")
        .permissions("string")
        .build())
    .debug(false)
    .enabled(false)
    .fields("string")
    .lambdaReconcileId("string")
    .linkingStrategy("string")
    .loginMethod("string")
    .permissions("string")
    .tenantConfigurations(FusionAuthIdpFacebookTenantConfigurationArgs.builder()
        .limitUserLinkCountEnabled(false)
        .limitUserLinkCountMaximumLinks(0)
        .tenantId("string")
        .build())
    .build());

    fusion_auth_idp_facebook_resource = fusionauth.FusionAuthIdpFacebook("fusionAuthIdpFacebookResource",
    app_id="string",
    button_text="string",
    client_secret="string",
    application_configurations=[fusionauth.FusionAuthIdpFacebookApplicationConfigurationArgs(
        app_id="string",
        application_id="string",
        button_text="string",
        client_secret="string",
        create_registration=False,
        enabled=False,
        fields="string",
        permissions="string",
    )],
    debug=False,
    enabled=False,
    fields="string",
    lambda_reconcile_id="string",
    linking_strategy="string",
    login_method="string",
    permissions="string",
    tenant_configurations=[fusionauth.FusionAuthIdpFacebookTenantConfigurationArgs(
        limit_user_link_count_enabled=False,
        limit_user_link_count_maximum_links=0,
        tenant_id="string",
    )])

    const fusionAuthIdpFacebookResource = new fusionauth.FusionAuthIdpFacebook("fusionAuthIdpFacebookResource", {
    appId: "string",
    buttonText: "string",
    clientSecret: "string",
    applicationConfigurations: [{
        appId: "string",
        applicationId: "string",
        buttonText: "string",
        clientSecret: "string",
        createRegistration: false,
        enabled: false,
        fields: "string",
        permissions: "string",
    }],
    debug: false,
    enabled: false,
    fields: "string",
    lambdaReconcileId: "string",
    linkingStrategy: "string",
    loginMethod: "string",
    permissions: "string",
    tenantConfigurations: [{
        limitUserLinkCountEnabled: false,
        limitUserLinkCountMaximumLinks: 0,
        tenantId: "string",
    }],
});

    type: fusionauth:FusionAuthIdpFacebook
properties:
    appId: string
    applicationConfigurations:
        - appId: string
          applicationId: string
          buttonText: string
          clientSecret: string
          createRegistration: false
          enabled: false
          fields: string
          permissions: string
    buttonText: string
    clientSecret: string
    debug: false
    enabled: false
    fields: string
    lambdaReconcileId: string
    linkingStrategy: string
    loginMethod: string
    permissions: string
    tenantConfigurations:
        - limitUserLinkCountEnabled: false
          limitUserLinkCountMaximumLinks: 0
          tenantId: string

    FusionAuthIdpFacebook Resource Properties

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

    Inputs

    The FusionAuthIdpFacebook resource accepts the following input properties:

    AppId string
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    ButtonText string
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    ClientSecret string
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    ApplicationConfigurations List<theogravity.Fusionauth.Inputs.FusionAuthIdpFacebookApplicationConfiguration>
    The configuration for each Application that the identity provider is enabled for.
    Debug bool
    Determines if debug is enabled for this provider. When enabled, an Event Log is created each time this provider is invoked to reconcile a login.
    Enabled bool
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    Fields string
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    LambdaReconcileId string
    The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.
    LinkingStrategy string
    The linking strategy to use when creating the link between the Facebook Identity Provider and the user. The valid values are:
    LoginMethod string
    The login method to use for this Identity Provider. The valid values are:
    Permissions string
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    TenantConfigurations List<theogravity.Fusionauth.Inputs.FusionAuthIdpFacebookTenantConfiguration>
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    AppId string
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    ButtonText string
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    ClientSecret string
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    ApplicationConfigurations []FusionAuthIdpFacebookApplicationConfigurationArgs
    The configuration for each Application that the identity provider is enabled for.
    Debug bool
    Determines if debug is enabled for this provider. When enabled, an Event Log is created each time this provider is invoked to reconcile a login.
    Enabled bool
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    Fields string
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    LambdaReconcileId string
    The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.
    LinkingStrategy string
    The linking strategy to use when creating the link between the Facebook Identity Provider and the user. The valid values are:
    LoginMethod string
    The login method to use for this Identity Provider. The valid values are:
    Permissions string
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    TenantConfigurations []FusionAuthIdpFacebookTenantConfigurationArgs
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    appId String
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    buttonText String
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    clientSecret String
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    applicationConfigurations List<FusionAuthIdpFacebookApplicationConfiguration>
    The configuration for each Application that the identity provider is enabled for.
    debug Boolean
    Determines if debug is enabled for this provider. When enabled, an Event Log is created each time this provider is invoked to reconcile a login.
    enabled Boolean
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    fields String
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    lambdaReconcileId String
    The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.
    linkingStrategy String
    The linking strategy to use when creating the link between the Facebook Identity Provider and the user. The valid values are:
    loginMethod String
    The login method to use for this Identity Provider. The valid values are:
    permissions String
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    tenantConfigurations List<FusionAuthIdpFacebookTenantConfiguration>
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    appId string
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    buttonText string
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    clientSecret string
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    applicationConfigurations FusionAuthIdpFacebookApplicationConfiguration[]
    The configuration for each Application that the identity provider is enabled for.
    debug boolean
    Determines if debug is enabled for this provider. When enabled, an Event Log is created each time this provider is invoked to reconcile a login.
    enabled boolean
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    fields string
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    lambdaReconcileId string
    The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.
    linkingStrategy string
    The linking strategy to use when creating the link between the Facebook Identity Provider and the user. The valid values are:
    loginMethod string
    The login method to use for this Identity Provider. The valid values are:
    permissions string
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    tenantConfigurations FusionAuthIdpFacebookTenantConfiguration[]
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    app_id str
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    button_text str
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    client_secret str
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    application_configurations Sequence[FusionAuthIdpFacebookApplicationConfigurationArgs]
    The configuration for each Application that the identity provider is enabled for.
    debug bool
    Determines if debug is enabled for this provider. When enabled, an Event Log is created each time this provider is invoked to reconcile a login.
    enabled bool
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    fields str
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    lambda_reconcile_id str
    The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.
    linking_strategy str
    The linking strategy to use when creating the link between the Facebook Identity Provider and the user. The valid values are:
    login_method str
    The login method to use for this Identity Provider. The valid values are:
    permissions str
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    tenant_configurations Sequence[FusionAuthIdpFacebookTenantConfigurationArgs]
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    appId String
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    buttonText String
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    clientSecret String
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    applicationConfigurations List<Property Map>
    The configuration for each Application that the identity provider is enabled for.
    debug Boolean
    Determines if debug is enabled for this provider. When enabled, an Event Log is created each time this provider is invoked to reconcile a login.
    enabled Boolean
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    fields String
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    lambdaReconcileId String
    The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.
    linkingStrategy String
    The linking strategy to use when creating the link between the Facebook Identity Provider and the user. The valid values are:
    loginMethod String
    The login method to use for this Identity Provider. The valid values are:
    permissions String
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    tenantConfigurations List<Property Map>
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FusionAuthIdpFacebook 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 FusionAuthIdpFacebook Resource

    Get an existing FusionAuthIdpFacebook 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?: FusionAuthIdpFacebookState, opts?: CustomResourceOptions): FusionAuthIdpFacebook
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_id: Optional[str] = None,
        application_configurations: Optional[Sequence[FusionAuthIdpFacebookApplicationConfigurationArgs]] = None,
        button_text: Optional[str] = None,
        client_secret: Optional[str] = None,
        debug: Optional[bool] = None,
        enabled: Optional[bool] = None,
        fields: Optional[str] = None,
        lambda_reconcile_id: Optional[str] = None,
        linking_strategy: Optional[str] = None,
        login_method: Optional[str] = None,
        permissions: Optional[str] = None,
        tenant_configurations: Optional[Sequence[FusionAuthIdpFacebookTenantConfigurationArgs]] = None) -> FusionAuthIdpFacebook
    func GetFusionAuthIdpFacebook(ctx *Context, name string, id IDInput, state *FusionAuthIdpFacebookState, opts ...ResourceOption) (*FusionAuthIdpFacebook, error)
    public static FusionAuthIdpFacebook Get(string name, Input<string> id, FusionAuthIdpFacebookState? state, CustomResourceOptions? opts = null)
    public static FusionAuthIdpFacebook get(String name, Output<String> id, FusionAuthIdpFacebookState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AppId string
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    ApplicationConfigurations List<theogravity.Fusionauth.Inputs.FusionAuthIdpFacebookApplicationConfiguration>
    The configuration for each Application that the identity provider is enabled for.
    ButtonText string
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    ClientSecret string
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    Debug bool
    Determines if debug is enabled for this provider. When enabled, an Event Log is created each time this provider is invoked to reconcile a login.
    Enabled bool
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    Fields string
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    LambdaReconcileId string
    The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.
    LinkingStrategy string
    The linking strategy to use when creating the link between the Facebook Identity Provider and the user. The valid values are:
    LoginMethod string
    The login method to use for this Identity Provider. The valid values are:
    Permissions string
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    TenantConfigurations List<theogravity.Fusionauth.Inputs.FusionAuthIdpFacebookTenantConfiguration>
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    AppId string
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    ApplicationConfigurations []FusionAuthIdpFacebookApplicationConfigurationArgs
    The configuration for each Application that the identity provider is enabled for.
    ButtonText string
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    ClientSecret string
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    Debug bool
    Determines if debug is enabled for this provider. When enabled, an Event Log is created each time this provider is invoked to reconcile a login.
    Enabled bool
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    Fields string
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    LambdaReconcileId string
    The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.
    LinkingStrategy string
    The linking strategy to use when creating the link between the Facebook Identity Provider and the user. The valid values are:
    LoginMethod string
    The login method to use for this Identity Provider. The valid values are:
    Permissions string
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    TenantConfigurations []FusionAuthIdpFacebookTenantConfigurationArgs
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    appId String
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    applicationConfigurations List<FusionAuthIdpFacebookApplicationConfiguration>
    The configuration for each Application that the identity provider is enabled for.
    buttonText String
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    clientSecret String
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    debug Boolean
    Determines if debug is enabled for this provider. When enabled, an Event Log is created each time this provider is invoked to reconcile a login.
    enabled Boolean
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    fields String
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    lambdaReconcileId String
    The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.
    linkingStrategy String
    The linking strategy to use when creating the link between the Facebook Identity Provider and the user. The valid values are:
    loginMethod String
    The login method to use for this Identity Provider. The valid values are:
    permissions String
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    tenantConfigurations List<FusionAuthIdpFacebookTenantConfiguration>
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    appId string
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    applicationConfigurations FusionAuthIdpFacebookApplicationConfiguration[]
    The configuration for each Application that the identity provider is enabled for.
    buttonText string
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    clientSecret string
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    debug boolean
    Determines if debug is enabled for this provider. When enabled, an Event Log is created each time this provider is invoked to reconcile a login.
    enabled boolean
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    fields string
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    lambdaReconcileId string
    The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.
    linkingStrategy string
    The linking strategy to use when creating the link between the Facebook Identity Provider and the user. The valid values are:
    loginMethod string
    The login method to use for this Identity Provider. The valid values are:
    permissions string
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    tenantConfigurations FusionAuthIdpFacebookTenantConfiguration[]
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    app_id str
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    application_configurations Sequence[FusionAuthIdpFacebookApplicationConfigurationArgs]
    The configuration for each Application that the identity provider is enabled for.
    button_text str
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    client_secret str
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    debug bool
    Determines if debug is enabled for this provider. When enabled, an Event Log is created each time this provider is invoked to reconcile a login.
    enabled bool
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    fields str
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    lambda_reconcile_id str
    The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.
    linking_strategy str
    The linking strategy to use when creating the link between the Facebook Identity Provider and the user. The valid values are:
    login_method str
    The login method to use for this Identity Provider. The valid values are:
    permissions str
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    tenant_configurations Sequence[FusionAuthIdpFacebookTenantConfigurationArgs]
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    appId String
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    applicationConfigurations List<Property Map>
    The configuration for each Application that the identity provider is enabled for.
    buttonText String
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    clientSecret String
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    debug Boolean
    Determines if debug is enabled for this provider. When enabled, an Event Log is created each time this provider is invoked to reconcile a login.
    enabled Boolean
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    fields String
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    lambdaReconcileId String
    The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.
    linkingStrategy String
    The linking strategy to use when creating the link between the Facebook Identity Provider and the user. The valid values are:
    loginMethod String
    The login method to use for this Identity Provider. The valid values are:
    permissions String
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    tenantConfigurations List<Property Map>
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.

    Supporting Types

    FusionAuthIdpFacebookApplicationConfiguration, FusionAuthIdpFacebookApplicationConfigurationArgs

    AppId string
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    ApplicationId string
    ID of the FusionAuth Application to apply this configuration to.
    ButtonText string
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    ClientSecret string
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    CreateRegistration bool
    Determines if a UserRegistration is created for the User automatically or not. If a user doesn’t exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.
    Enabled bool
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    Fields string
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    Permissions string
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    AppId string
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    ApplicationId string
    ID of the FusionAuth Application to apply this configuration to.
    ButtonText string
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    ClientSecret string
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    CreateRegistration bool
    Determines if a UserRegistration is created for the User automatically or not. If a user doesn’t exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.
    Enabled bool
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    Fields string
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    Permissions string
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    appId String
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    applicationId String
    ID of the FusionAuth Application to apply this configuration to.
    buttonText String
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    clientSecret String
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    createRegistration Boolean
    Determines if a UserRegistration is created for the User automatically or not. If a user doesn’t exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.
    enabled Boolean
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    fields String
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    permissions String
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    appId string
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    applicationId string
    ID of the FusionAuth Application to apply this configuration to.
    buttonText string
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    clientSecret string
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    createRegistration boolean
    Determines if a UserRegistration is created for the User automatically or not. If a user doesn’t exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.
    enabled boolean
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    fields string
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    permissions string
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    app_id str
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    application_id str
    ID of the FusionAuth Application to apply this configuration to.
    button_text str
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    client_secret str
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    create_registration bool
    Determines if a UserRegistration is created for the User automatically or not. If a user doesn’t exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.
    enabled bool
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    fields str
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    permissions str
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API
    appId String
    The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    applicationId String
    ID of the FusionAuth Application to apply this configuration to.
    buttonText String
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    clientSecret String
    The top-level client secret, also known as 'App Secret', to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.
    createRegistration Boolean
    Determines if a UserRegistration is created for the User automatically or not. If a user doesn’t exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.
    enabled Boolean
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    fields String
    The top-level fields that you are requesting from Facebook. Field values are documented at Facebook Graph API
    permissions String
    The top-level permissions that your application is asking of the user’s Facebook account. Permission values are documented at Facebook Login API

    FusionAuthIdpFacebookTenantConfiguration, FusionAuthIdpFacebookTenantConfigurationArgs

    LimitUserLinkCountEnabled bool
    When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
    LimitUserLinkCountMaximumLinks int
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    TenantId string
    The unique Id of the tenant that this configuration applies to.
    LimitUserLinkCountEnabled bool
    When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
    LimitUserLinkCountMaximumLinks int
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    TenantId string
    The unique Id of the tenant that this configuration applies to.
    limitUserLinkCountEnabled Boolean
    When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
    limitUserLinkCountMaximumLinks Integer
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    tenantId String
    The unique Id of the tenant that this configuration applies to.
    limitUserLinkCountEnabled boolean
    When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
    limitUserLinkCountMaximumLinks number
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    tenantId string
    The unique Id of the tenant that this configuration applies to.
    limit_user_link_count_enabled bool
    When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
    limit_user_link_count_maximum_links int
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    tenant_id str
    The unique Id of the tenant that this configuration applies to.
    limitUserLinkCountEnabled Boolean
    When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
    limitUserLinkCountMaximumLinks Number
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    tenantId String
    The unique Id of the tenant that this configuration applies to.

    Package Details

    Repository
    fusionauth theogravity/pulumi-fusionauth
    License
    MIT
    Notes
    This Pulumi package is based on the fusionauth Terraform Provider.
    fusionauth logo
    FusionAuth v4.0.1 published on Saturday, Sep 30, 2023 by Theo Gravity
    theogravity/pulumi-fusionauth