Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. FusionAuth
  3. API Docs
  4. FusionAuthIdpTwitch
FusionAuth v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity
theogravity/pulumi-fusionauth

fusionauth.FusionAuthIdpTwitch

Explore with Pulumi AI

fusionauth logo
FusionAuth v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity
theogravity/pulumi-fusionauth

    # Twitch Identity Provider Resource

    The Twitch identity provider type will use the Twitch OAuth v2.0 login API. It will also provide a Login with Twitch button on FusionAuth’s login page that will direct a user to the Twitch login page.

    This identity provider will call Twitch’s API to load the user’s email and preferred_username and use those as email and username to lookup or create a user in FusionAuth depending on the linking strategy configured for this identity provider. Additional claims returned by Twitch can be used to reconcile the user to FusionAuth by using a Twitch Reconcile Lambda.

    FusionAuth will also store the Twitch refresh_token returned from the Twitch API in the link between the user and the identity provider. This token can be used by an application to make further requests to Twitch APIs on behalf of the user.

    Twitch Identity Provider APIs

    Example Usage

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

const twitch = new fusionauth.FusionAuthIdpTwitch("twitch", {
    applicationConfigurations: [{
        applicationId: fusionauth_application.my_app.id,
        createRegistration: true,
        enabled: true,
    }],
    buttonText: "Login with Twitch",
    clientId: "0eb1ce3c-2fb1-4ae9-b361-d49fc6e764cc",
    clientSecret: "693s000cbn66k0mxtqzr_c_NfLy3~6_SEA",
    scope: "Xboxlive.signin Xboxlive.offline_access",
});

    import pulumi
import theogravity_pulumi_fusionauth as fusionauth

twitch = fusionauth.FusionAuthIdpTwitch("twitch",
    application_configurations=[fusionauth.FusionAuthIdpTwitchApplicationConfigurationArgs(
        application_id=fusionauth_application["my_app"]["id"],
        create_registration=True,
        enabled=True,
    )],
    button_text="Login with Twitch",
    client_id="0eb1ce3c-2fb1-4ae9-b361-d49fc6e764cc",
    client_secret="693s000cbn66k0mxtqzr_c_NfLy3~6_SEA",
    scope="Xboxlive.signin Xboxlive.offline_access")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fusionauth.NewFusionAuthIdpTwitch(ctx, "twitch", &fusionauth.FusionAuthIdpTwitchArgs{
			ApplicationConfigurations: fusionauth.FusionAuthIdpTwitchApplicationConfigurationArray{
				&fusionauth.FusionAuthIdpTwitchApplicationConfigurationArgs{
					ApplicationId:      pulumi.Any(fusionauth_application.My_app.Id),
					CreateRegistration: pulumi.Bool(true),
					Enabled:            pulumi.Bool(true),
				},
			},
			ButtonText:   pulumi.String("Login with Twitch"),
			ClientId:     pulumi.String("0eb1ce3c-2fb1-4ae9-b361-d49fc6e764cc"),
			ClientSecret: pulumi.String("693s000cbn66k0mxtqzr_c_NfLy3~6_SEA"),
			Scope:        pulumi.String("Xboxlive.signin Xboxlive.offline_access"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var twitch = new Fusionauth.FusionAuthIdpTwitch("twitch", new()
    {
        ApplicationConfigurations = new[]
        {
            new Fusionauth.Inputs.FusionAuthIdpTwitchApplicationConfigurationArgs
            {
                ApplicationId = fusionauth_application.My_app.Id,
                CreateRegistration = true,
                Enabled = true,
            },
        },
        ButtonText = "Login with Twitch",
        ClientId = "0eb1ce3c-2fb1-4ae9-b361-d49fc6e764cc",
        ClientSecret = "693s000cbn66k0mxtqzr_c_NfLy3~6_SEA",
        Scope = "Xboxlive.signin Xboxlive.offline_access",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fusionauth.FusionAuthIdpTwitch;
import com.pulumi.fusionauth.FusionAuthIdpTwitchArgs;
import com.pulumi.fusionauth.inputs.FusionAuthIdpTwitchApplicationConfigurationArgs;
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 twitch = new FusionAuthIdpTwitch("twitch", FusionAuthIdpTwitchArgs.builder()
            .applicationConfigurations(FusionAuthIdpTwitchApplicationConfigurationArgs.builder()
                .applicationId(fusionauth_application.my_app().id())
                .createRegistration(true)
                .enabled(true)
                .build())
            .buttonText("Login with Twitch")
            .clientId("0eb1ce3c-2fb1-4ae9-b361-d49fc6e764cc")
            .clientSecret("693s000cbn66k0mxtqzr_c_NfLy3~6_SEA")
            .scope("Xboxlive.signin Xboxlive.offline_access")
            .build());

    }
}

    resources:
  twitch:
    type: fusionauth:FusionAuthIdpTwitch
    properties:
      applicationConfigurations:
        - applicationId: ${fusionauth_application.my_app.id}
          createRegistration: true
          enabled: true
      buttonText: Login with Twitch
      clientId: 0eb1ce3c-2fb1-4ae9-b361-d49fc6e764cc
      clientSecret: 693s000cbn66k0mxtqzr_c_NfLy3~6_SEA
      scope: Xboxlive.signin Xboxlive.offline_access

    Create FusionAuthIdpTwitch Resource

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

    Constructor syntax

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

@overload
def FusionAuthIdpTwitch(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        button_text: Optional[str] = None,
                        client_id: Optional[str] = None,
                        client_secret: Optional[str] = None,
                        application_configurations: Optional[Sequence[FusionAuthIdpTwitchApplicationConfigurationArgs]] = None,
                        debug: Optional[bool] = None,
                        enabled: Optional[bool] = None,
                        idp_id: Optional[str] = None,
                        lambda_reconcile_id: Optional[str] = None,
                        linking_strategy: Optional[str] = None,
                        scope: Optional[str] = None,
                        tenant_configurations: Optional[Sequence[FusionAuthIdpTwitchTenantConfigurationArgs]] = None)
    func NewFusionAuthIdpTwitch(ctx *Context, name string, args FusionAuthIdpTwitchArgs, opts ...ResourceOption) (*FusionAuthIdpTwitch, error)
    public FusionAuthIdpTwitch(string name, FusionAuthIdpTwitchArgs args, CustomResourceOptions? opts = null)
    public FusionAuthIdpTwitch(String name, FusionAuthIdpTwitchArgs args)
public FusionAuthIdpTwitch(String name, FusionAuthIdpTwitchArgs args, CustomResourceOptions options)

    type: fusionauth:FusionAuthIdpTwitch
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 FusionAuthIdpTwitchArgs
    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 FusionAuthIdpTwitchArgs
    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 FusionAuthIdpTwitchArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FusionAuthIdpTwitchArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FusionAuthIdpTwitchArgs
    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 fusionAuthIdpTwitchResource = new Fusionauth.FusionAuthIdpTwitch("fusionAuthIdpTwitchResource", new()
{
    ButtonText = "string",
    ClientId = "string",
    ClientSecret = "string",
    ApplicationConfigurations = new[]
    {
        new Fusionauth.Inputs.FusionAuthIdpTwitchApplicationConfigurationArgs
        {
            ApplicationId = "string",
            ButtonText = "string",
            ClientId = "string",
            ClientSecret = "string",
            CreateRegistration = false,
            Enabled = false,
            Scope = "string",
        },
    },
    Debug = false,
    Enabled = false,
    IdpId = "string",
    LambdaReconcileId = "string",
    LinkingStrategy = "string",
    Scope = "string",
    TenantConfigurations = new[]
    {
        new Fusionauth.Inputs.FusionAuthIdpTwitchTenantConfigurationArgs
        {
            LimitUserLinkCountEnabled = false,
            LimitUserLinkCountMaximumLinks = 0,
            TenantId = "string",
        },
    },
});

    example, err := fusionauth.NewFusionAuthIdpTwitch(ctx, "fusionAuthIdpTwitchResource", &fusionauth.FusionAuthIdpTwitchArgs{
	ButtonText:   pulumi.String("string"),
	ClientId:     pulumi.String("string"),
	ClientSecret: pulumi.String("string"),
	ApplicationConfigurations: fusionauth.FusionAuthIdpTwitchApplicationConfigurationArray{
		&fusionauth.FusionAuthIdpTwitchApplicationConfigurationArgs{
			ApplicationId:      pulumi.String("string"),
			ButtonText:         pulumi.String("string"),
			ClientId:           pulumi.String("string"),
			ClientSecret:       pulumi.String("string"),
			CreateRegistration: pulumi.Bool(false),
			Enabled:            pulumi.Bool(false),
			Scope:              pulumi.String("string"),
		},
	},
	Debug:             pulumi.Bool(false),
	Enabled:           pulumi.Bool(false),
	IdpId:             pulumi.String("string"),
	LambdaReconcileId: pulumi.String("string"),
	LinkingStrategy:   pulumi.String("string"),
	Scope:             pulumi.String("string"),
	TenantConfigurations: fusionauth.FusionAuthIdpTwitchTenantConfigurationArray{
		&fusionauth.FusionAuthIdpTwitchTenantConfigurationArgs{
			LimitUserLinkCountEnabled:      pulumi.Bool(false),
			LimitUserLinkCountMaximumLinks: pulumi.Int(0),
			TenantId:                       pulumi.String("string"),
		},
	},
})

    var fusionAuthIdpTwitchResource = new FusionAuthIdpTwitch("fusionAuthIdpTwitchResource", FusionAuthIdpTwitchArgs.builder()
    .buttonText("string")
    .clientId("string")
    .clientSecret("string")
    .applicationConfigurations(FusionAuthIdpTwitchApplicationConfigurationArgs.builder()
        .applicationId("string")
        .buttonText("string")
        .clientId("string")
        .clientSecret("string")
        .createRegistration(false)
        .enabled(false)
        .scope("string")
        .build())
    .debug(false)
    .enabled(false)
    .idpId("string")
    .lambdaReconcileId("string")
    .linkingStrategy("string")
    .scope("string")
    .tenantConfigurations(FusionAuthIdpTwitchTenantConfigurationArgs.builder()
        .limitUserLinkCountEnabled(false)
        .limitUserLinkCountMaximumLinks(0)
        .tenantId("string")
        .build())
    .build());

    fusion_auth_idp_twitch_resource = fusionauth.FusionAuthIdpTwitch("fusionAuthIdpTwitchResource",
    button_text="string",
    client_id="string",
    client_secret="string",
    application_configurations=[{
        "application_id": "string",
        "button_text": "string",
        "client_id": "string",
        "client_secret": "string",
        "create_registration": False,
        "enabled": False,
        "scope": "string",
    }],
    debug=False,
    enabled=False,
    idp_id="string",
    lambda_reconcile_id="string",
    linking_strategy="string",
    scope="string",
    tenant_configurations=[{
        "limit_user_link_count_enabled": False,
        "limit_user_link_count_maximum_links": 0,
        "tenant_id": "string",
    }])

    const fusionAuthIdpTwitchResource = new fusionauth.FusionAuthIdpTwitch("fusionAuthIdpTwitchResource", {
    buttonText: "string",
    clientId: "string",
    clientSecret: "string",
    applicationConfigurations: [{
        applicationId: "string",
        buttonText: "string",
        clientId: "string",
        clientSecret: "string",
        createRegistration: false,
        enabled: false,
        scope: "string",
    }],
    debug: false,
    enabled: false,
    idpId: "string",
    lambdaReconcileId: "string",
    linkingStrategy: "string",
    scope: "string",
    tenantConfigurations: [{
        limitUserLinkCountEnabled: false,
        limitUserLinkCountMaximumLinks: 0,
        tenantId: "string",
    }],
});

    type: fusionauth:FusionAuthIdpTwitch
properties:
    applicationConfigurations:
        - applicationId: string
          buttonText: string
          clientId: string
          clientSecret: string
          createRegistration: false
          enabled: false
          scope: string
    buttonText: string
    clientId: string
    clientSecret: string
    debug: false
    enabled: false
    idpId: string
    lambdaReconcileId: string
    linkingStrategy: string
    scope: string
    tenantConfigurations:
        - limitUserLinkCountEnabled: false
          limitUserLinkCountMaximumLinks: 0
          tenantId: string

    FusionAuthIdpTwitch 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 FusionAuthIdpTwitch resource accepts the following input properties:

    ButtonText string
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    ClientId string
    TThe top-level Xbox client id for your Application. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    ClientSecret string
    The top-level client secret to use with the Xbox Identity Provider when retrieving the long-lived token. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    ApplicationConfigurations List<theogravity.Fusionauth.Inputs.FusionAuthIdpTwitchApplicationConfiguration>
    The configuration for each Application that the identity provider is enabled for.
    Debug bool
    Determines if debug is enabled for this provider. When enabled, each time this provider is invoked to reconcile a login an Event Log will be created.
    Enabled bool
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    IdpId string
    The ID to use for the new identity provider. If not specified a secure random UUID will be generated.
    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 {idp_display_name} Identity Provider and the user.
    Scope string
    The top-level scope that you are requesting from Xbox.
    TenantConfigurations List<theogravity.Fusionauth.Inputs.FusionAuthIdpTwitchTenantConfiguration>
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    ButtonText string
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    ClientId string
    TThe top-level Xbox client id for your Application. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    ClientSecret string
    The top-level client secret to use with the Xbox Identity Provider when retrieving the long-lived token. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    ApplicationConfigurations []FusionAuthIdpTwitchApplicationConfigurationArgs
    The configuration for each Application that the identity provider is enabled for.
    Debug bool
    Determines if debug is enabled for this provider. When enabled, each time this provider is invoked to reconcile a login an Event Log will be created.
    Enabled bool
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    IdpId string
    The ID to use for the new identity provider. If not specified a secure random UUID will be generated.
    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 {idp_display_name} Identity Provider and the user.
    Scope string
    The top-level scope that you are requesting from Xbox.
    TenantConfigurations []FusionAuthIdpTwitchTenantConfigurationArgs
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    buttonText String
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    clientId String
    TThe top-level Xbox client id for your Application. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    clientSecret String
    The top-level client secret to use with the Xbox Identity Provider when retrieving the long-lived token. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    applicationConfigurations List<FusionAuthIdpTwitchApplicationConfiguration>
    The configuration for each Application that the identity provider is enabled for.
    debug Boolean
    Determines if debug is enabled for this provider. When enabled, each time this provider is invoked to reconcile a login an Event Log will be created.
    enabled Boolean
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    idpId String
    The ID to use for the new identity provider. If not specified a secure random UUID will be generated.
    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 {idp_display_name} Identity Provider and the user.
    scope String
    The top-level scope that you are requesting from Xbox.
    tenantConfigurations List<FusionAuthIdpTwitchTenantConfiguration>
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    buttonText string
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    clientId string
    TThe top-level Xbox client id for your Application. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    clientSecret string
    The top-level client secret to use with the Xbox Identity Provider when retrieving the long-lived token. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    applicationConfigurations FusionAuthIdpTwitchApplicationConfiguration[]
    The configuration for each Application that the identity provider is enabled for.
    debug boolean
    Determines if debug is enabled for this provider. When enabled, each time this provider is invoked to reconcile a login an Event Log will be created.
    enabled boolean
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    idpId string
    The ID to use for the new identity provider. If not specified a secure random UUID will be generated.
    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 {idp_display_name} Identity Provider and the user.
    scope string
    The top-level scope that you are requesting from Xbox.
    tenantConfigurations FusionAuthIdpTwitchTenantConfiguration[]
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    button_text str
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    client_id str
    TThe top-level Xbox client id for your Application. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    client_secret str
    The top-level client secret to use with the Xbox Identity Provider when retrieving the long-lived token. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    application_configurations Sequence[FusionAuthIdpTwitchApplicationConfigurationArgs]
    The configuration for each Application that the identity provider is enabled for.
    debug bool
    Determines if debug is enabled for this provider. When enabled, each time this provider is invoked to reconcile a login an Event Log will be created.
    enabled bool
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    idp_id str
    The ID to use for the new identity provider. If not specified a secure random UUID will be generated.
    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 {idp_display_name} Identity Provider and the user.
    scope str
    The top-level scope that you are requesting from Xbox.
    tenant_configurations Sequence[FusionAuthIdpTwitchTenantConfigurationArgs]
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    buttonText String
    The top-level button text to use on the FusionAuth login page for this Identity Provider.
    clientId String
    TThe top-level Xbox client id for your Application. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    clientSecret String
    The top-level client secret to use with the Xbox Identity Provider when retrieving the long-lived token. This value is retrieved from the Xbox developer website when you setup your Xbox 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, each time this provider is invoked to reconcile a login an Event Log will be created.
    enabled Boolean
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    idpId String
    The ID to use for the new identity provider. If not specified a secure random UUID will be generated.
    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 {idp_display_name} Identity Provider and the user.
    scope String
    The top-level scope that you are requesting from Xbox.
    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 FusionAuthIdpTwitch 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 FusionAuthIdpTwitch Resource

    Get an existing FusionAuthIdpTwitch 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?: FusionAuthIdpTwitchState, opts?: CustomResourceOptions): FusionAuthIdpTwitch
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application_configurations: Optional[Sequence[FusionAuthIdpTwitchApplicationConfigurationArgs]] = None,
        button_text: Optional[str] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        debug: Optional[bool] = None,
        enabled: Optional[bool] = None,
        idp_id: Optional[str] = None,
        lambda_reconcile_id: Optional[str] = None,
        linking_strategy: Optional[str] = None,
        scope: Optional[str] = None,
        tenant_configurations: Optional[Sequence[FusionAuthIdpTwitchTenantConfigurationArgs]] = None) -> FusionAuthIdpTwitch
    func GetFusionAuthIdpTwitch(ctx *Context, name string, id IDInput, state *FusionAuthIdpTwitchState, opts ...ResourceOption) (*FusionAuthIdpTwitch, error)
    public static FusionAuthIdpTwitch Get(string name, Input<string> id, FusionAuthIdpTwitchState? state, CustomResourceOptions? opts = null)
    public static FusionAuthIdpTwitch get(String name, Output<String> id, FusionAuthIdpTwitchState 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:
    ApplicationConfigurations List<theogravity.Fusionauth.Inputs.FusionAuthIdpTwitchApplicationConfiguration>
    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.
    ClientId string
    TThe top-level Xbox client id for your Application. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    ClientSecret string
    The top-level client secret to use with the Xbox Identity Provider when retrieving the long-lived token. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    Debug bool
    Determines if debug is enabled for this provider. When enabled, each time this provider is invoked to reconcile a login an Event Log will be created.
    Enabled bool
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    IdpId string
    The ID to use for the new identity provider. If not specified a secure random UUID will be generated.
    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 {idp_display_name} Identity Provider and the user.
    Scope string
    The top-level scope that you are requesting from Xbox.
    TenantConfigurations List<theogravity.Fusionauth.Inputs.FusionAuthIdpTwitchTenantConfiguration>
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    ApplicationConfigurations []FusionAuthIdpTwitchApplicationConfigurationArgs
    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.
    ClientId string
    TThe top-level Xbox client id for your Application. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    ClientSecret string
    The top-level client secret to use with the Xbox Identity Provider when retrieving the long-lived token. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    Debug bool
    Determines if debug is enabled for this provider. When enabled, each time this provider is invoked to reconcile a login an Event Log will be created.
    Enabled bool
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    IdpId string
    The ID to use for the new identity provider. If not specified a secure random UUID will be generated.
    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 {idp_display_name} Identity Provider and the user.
    Scope string
    The top-level scope that you are requesting from Xbox.
    TenantConfigurations []FusionAuthIdpTwitchTenantConfigurationArgs
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    applicationConfigurations List<FusionAuthIdpTwitchApplicationConfiguration>
    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.
    clientId String
    TThe top-level Xbox client id for your Application. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    clientSecret String
    The top-level client secret to use with the Xbox Identity Provider when retrieving the long-lived token. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    debug Boolean
    Determines if debug is enabled for this provider. When enabled, each time this provider is invoked to reconcile a login an Event Log will be created.
    enabled Boolean
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    idpId String
    The ID to use for the new identity provider. If not specified a secure random UUID will be generated.
    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 {idp_display_name} Identity Provider and the user.
    scope String
    The top-level scope that you are requesting from Xbox.
    tenantConfigurations List<FusionAuthIdpTwitchTenantConfiguration>
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    applicationConfigurations FusionAuthIdpTwitchApplicationConfiguration[]
    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.
    clientId string
    TThe top-level Xbox client id for your Application. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    clientSecret string
    The top-level client secret to use with the Xbox Identity Provider when retrieving the long-lived token. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    debug boolean
    Determines if debug is enabled for this provider. When enabled, each time this provider is invoked to reconcile a login an Event Log will be created.
    enabled boolean
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    idpId string
    The ID to use for the new identity provider. If not specified a secure random UUID will be generated.
    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 {idp_display_name} Identity Provider and the user.
    scope string
    The top-level scope that you are requesting from Xbox.
    tenantConfigurations FusionAuthIdpTwitchTenantConfiguration[]
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    application_configurations Sequence[FusionAuthIdpTwitchApplicationConfigurationArgs]
    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_id str
    TThe top-level Xbox client id for your Application. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    client_secret str
    The top-level client secret to use with the Xbox Identity Provider when retrieving the long-lived token. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    debug bool
    Determines if debug is enabled for this provider. When enabled, each time this provider is invoked to reconcile a login an Event Log will be created.
    enabled bool
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    idp_id str
    The ID to use for the new identity provider. If not specified a secure random UUID will be generated.
    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 {idp_display_name} Identity Provider and the user.
    scope str
    The top-level scope that you are requesting from Xbox.
    tenant_configurations Sequence[FusionAuthIdpTwitchTenantConfigurationArgs]
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    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.
    clientId String
    TThe top-level Xbox client id for your Application. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    clientSecret String
    The top-level client secret to use with the Xbox Identity Provider when retrieving the long-lived token. This value is retrieved from the Xbox developer website when you setup your Xbox developer account.
    debug Boolean
    Determines if debug is enabled for this provider. When enabled, each time this provider is invoked to reconcile a login an Event Log will be created.
    enabled Boolean
    Determines if this provider is enabled. If it is false then it will be disabled globally.
    idpId String
    The ID to use for the new identity provider. If not specified a secure random UUID will be generated.
    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 {idp_display_name} Identity Provider and the user.
    scope String
    The top-level scope that you are requesting from Xbox.
    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

    FusionAuthIdpTwitchApplicationConfiguration, FusionAuthIdpTwitchApplicationConfigurationArgs

    ApplicationId string
    ID of the Application to apply this configuration to.
    ButtonText string
    This is an optional Application specific override for the top level button text.
    ClientId string
    This is an optional Application specific override for the top level client_id.
    ClientSecret string
    This is an optional Application specific override for the top level client_secret.
    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 identity provider is enabled for the Application specified by the applicationId key.
    Scope string
    This is an optional Application specific override for the top level scope.
    ApplicationId string
    ID of the Application to apply this configuration to.
    ButtonText string
    This is an optional Application specific override for the top level button text.
    ClientId string
    This is an optional Application specific override for the top level client_id.
    ClientSecret string
    This is an optional Application specific override for the top level client_secret.
    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 identity provider is enabled for the Application specified by the applicationId key.
    Scope string
    This is an optional Application specific override for the top level scope.
    applicationId String
    ID of the Application to apply this configuration to.
    buttonText String
    This is an optional Application specific override for the top level button text.
    clientId String
    This is an optional Application specific override for the top level client_id.
    clientSecret String
    This is an optional Application specific override for the top level client_secret.
    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 identity provider is enabled for the Application specified by the applicationId key.
    scope String
    This is an optional Application specific override for the top level scope.
    applicationId string
    ID of the Application to apply this configuration to.
    buttonText string
    This is an optional Application specific override for the top level button text.
    clientId string
    This is an optional Application specific override for the top level client_id.
    clientSecret string
    This is an optional Application specific override for the top level client_secret.
    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 identity provider is enabled for the Application specified by the applicationId key.
    scope string
    This is an optional Application specific override for the top level scope.
    application_id str
    ID of the Application to apply this configuration to.
    button_text str
    This is an optional Application specific override for the top level button text.
    client_id str
    This is an optional Application specific override for the top level client_id.
    client_secret str
    This is an optional Application specific override for the top level client_secret.
    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 identity provider is enabled for the Application specified by the applicationId key.
    scope str
    This is an optional Application specific override for the top level scope.
    applicationId String
    ID of the Application to apply this configuration to.
    buttonText String
    This is an optional Application specific override for the top level button text.
    clientId String
    This is an optional Application specific override for the top level client_id.
    clientSecret String
    This is an optional Application specific override for the top level client_secret.
    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 identity provider is enabled for the Application specified by the applicationId key.
    scope String
    This is an optional Application specific override for the top level scope.

    FusionAuthIdpTwitchTenantConfiguration, FusionAuthIdpTwitchTenantConfigurationArgs

    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 v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity
    theogravity/pulumi-fusionauth