1. Packages
  2. FusionAuth
  3. API Docs
  4. FusionAuthIdpSteam
FusionAuth v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity

fusionauth.FusionAuthIdpSteam

Explore with Pulumi AI

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

    # Steam Identity Provider Resource

    The Steam identity provider type will use the Steam OAuth login API. It will also provide a Login with Steam button on FusionAuth’s login page that will direct a user to the Steam login page. The Steam login uses the implicit OAuth grant and will return to the callback URL with token and state in the URL Fragment. This is handled by the FusionAuth /oauth2/implicit javascript function to pass those values to the /oauth2/callback endpoint.

    This identity provider will call Steam’s API to load the Steam user’s personaname and use that as username to lookup or create a user in FusionAuth depending on the linking strategy configured for this identity provider. However, Steam does not allow access to user emails, so neither email linking strategy can be used and user’s will not be able to login or be created.

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

    Steam Identity Provider APIs

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fusionauth from "pulumi-fusionauth";
    
    const steam = new fusionauth.FusionAuthIdpSteam("steam", {
        applicationConfigurations: [{
            applicationId: fusionauth_application.GPS_Insight.id,
            createRegistration: true,
            enabled: true,
        }],
        buttonText: "Login with Steam",
        clientId: "0eb1ce3c-2fb1-4ae9-b361-d49fc6e764cc",
        scope: "Xboxlive.signin Xboxlive.offline_access",
        webApiKey: "HG0A97ACKPQ5ZLPU0007BN6674OA25TY",
    });
    
    import pulumi
    import theogravity_pulumi_fusionauth as fusionauth
    
    steam = fusionauth.FusionAuthIdpSteam("steam",
        application_configurations=[fusionauth.FusionAuthIdpSteamApplicationConfigurationArgs(
            application_id=fusionauth_application["GPS_Insight"]["id"],
            create_registration=True,
            enabled=True,
        )],
        button_text="Login with Steam",
        client_id="0eb1ce3c-2fb1-4ae9-b361-d49fc6e764cc",
        scope="Xboxlive.signin Xboxlive.offline_access",
        web_api_key="HG0A97ACKPQ5ZLPU0007BN6674OA25TY")
    
    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.NewFusionAuthIdpSteam(ctx, "steam", &fusionauth.FusionAuthIdpSteamArgs{
    			ApplicationConfigurations: fusionauth.FusionAuthIdpSteamApplicationConfigurationArray{
    				&fusionauth.FusionAuthIdpSteamApplicationConfigurationArgs{
    					ApplicationId:      pulumi.Any(fusionauth_application.GPS_Insight.Id),
    					CreateRegistration: pulumi.Bool(true),
    					Enabled:            pulumi.Bool(true),
    				},
    			},
    			ButtonText: pulumi.String("Login with Steam"),
    			ClientId:   pulumi.String("0eb1ce3c-2fb1-4ae9-b361-d49fc6e764cc"),
    			Scope:      pulumi.String("Xboxlive.signin Xboxlive.offline_access"),
    			WebApiKey:  pulumi.String("HG0A97ACKPQ5ZLPU0007BN6674OA25TY"),
    		})
    		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 steam = new Fusionauth.FusionAuthIdpSteam("steam", new()
        {
            ApplicationConfigurations = new[]
            {
                new Fusionauth.Inputs.FusionAuthIdpSteamApplicationConfigurationArgs
                {
                    ApplicationId = fusionauth_application.GPS_Insight.Id,
                    CreateRegistration = true,
                    Enabled = true,
                },
            },
            ButtonText = "Login with Steam",
            ClientId = "0eb1ce3c-2fb1-4ae9-b361-d49fc6e764cc",
            Scope = "Xboxlive.signin Xboxlive.offline_access",
            WebApiKey = "HG0A97ACKPQ5ZLPU0007BN6674OA25TY",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fusionauth.FusionAuthIdpSteam;
    import com.pulumi.fusionauth.FusionAuthIdpSteamArgs;
    import com.pulumi.fusionauth.inputs.FusionAuthIdpSteamApplicationConfigurationArgs;
    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 steam = new FusionAuthIdpSteam("steam", FusionAuthIdpSteamArgs.builder()
                .applicationConfigurations(FusionAuthIdpSteamApplicationConfigurationArgs.builder()
                    .applicationId(fusionauth_application.GPS_Insight().id())
                    .createRegistration(true)
                    .enabled(true)
                    .build())
                .buttonText("Login with Steam")
                .clientId("0eb1ce3c-2fb1-4ae9-b361-d49fc6e764cc")
                .scope("Xboxlive.signin Xboxlive.offline_access")
                .webApiKey("HG0A97ACKPQ5ZLPU0007BN6674OA25TY")
                .build());
    
        }
    }
    
    resources:
      steam:
        type: fusionauth:FusionAuthIdpSteam
        properties:
          applicationConfigurations:
            - applicationId: ${fusionauth_application.GPS_Insight.id}
              createRegistration: true
              enabled: true
          buttonText: Login with Steam
          clientId: 0eb1ce3c-2fb1-4ae9-b361-d49fc6e764cc
          scope: Xboxlive.signin Xboxlive.offline_access
          webApiKey: HG0A97ACKPQ5ZLPU0007BN6674OA25TY
    

    Create FusionAuthIdpSteam Resource

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

    Constructor syntax

    new FusionAuthIdpSteam(name: string, args: FusionAuthIdpSteamArgs, opts?: CustomResourceOptions);
    @overload
    def FusionAuthIdpSteam(resource_name: str,
                           args: FusionAuthIdpSteamArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def FusionAuthIdpSteam(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           button_text: Optional[str] = None,
                           client_id: Optional[str] = None,
                           web_api_key: Optional[str] = None,
                           application_configurations: Optional[Sequence[FusionAuthIdpSteamApplicationConfigurationArgs]] = 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[FusionAuthIdpSteamTenantConfigurationArgs]] = None)
    func NewFusionAuthIdpSteam(ctx *Context, name string, args FusionAuthIdpSteamArgs, opts ...ResourceOption) (*FusionAuthIdpSteam, error)
    public FusionAuthIdpSteam(string name, FusionAuthIdpSteamArgs args, CustomResourceOptions? opts = null)
    public FusionAuthIdpSteam(String name, FusionAuthIdpSteamArgs args)
    public FusionAuthIdpSteam(String name, FusionAuthIdpSteamArgs args, CustomResourceOptions options)
    
    type: fusionauth:FusionAuthIdpSteam
    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 FusionAuthIdpSteamArgs
    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 FusionAuthIdpSteamArgs
    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 FusionAuthIdpSteamArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FusionAuthIdpSteamArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FusionAuthIdpSteamArgs
    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 fusionAuthIdpSteamResource = new Fusionauth.FusionAuthIdpSteam("fusionAuthIdpSteamResource", new()
    {
        ButtonText = "string",
        ClientId = "string",
        WebApiKey = "string",
        ApplicationConfigurations = new[]
        {
            new Fusionauth.Inputs.FusionAuthIdpSteamApplicationConfigurationArgs
            {
                ApplicationId = "string",
                ButtonText = "string",
                ClientId = "string",
                CreateRegistration = false,
                Enabled = false,
                Scope = "string",
                WebApiKey = "string",
            },
        },
        Debug = false,
        Enabled = false,
        IdpId = "string",
        LambdaReconcileId = "string",
        LinkingStrategy = "string",
        Scope = "string",
        TenantConfigurations = new[]
        {
            new Fusionauth.Inputs.FusionAuthIdpSteamTenantConfigurationArgs
            {
                LimitUserLinkCountEnabled = false,
                LimitUserLinkCountMaximumLinks = 0,
                TenantId = "string",
            },
        },
    });
    
    example, err := fusionauth.NewFusionAuthIdpSteam(ctx, "fusionAuthIdpSteamResource", &fusionauth.FusionAuthIdpSteamArgs{
    	ButtonText: pulumi.String("string"),
    	ClientId:   pulumi.String("string"),
    	WebApiKey:  pulumi.String("string"),
    	ApplicationConfigurations: fusionauth.FusionAuthIdpSteamApplicationConfigurationArray{
    		&fusionauth.FusionAuthIdpSteamApplicationConfigurationArgs{
    			ApplicationId:      pulumi.String("string"),
    			ButtonText:         pulumi.String("string"),
    			ClientId:           pulumi.String("string"),
    			CreateRegistration: pulumi.Bool(false),
    			Enabled:            pulumi.Bool(false),
    			Scope:              pulumi.String("string"),
    			WebApiKey:          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.FusionAuthIdpSteamTenantConfigurationArray{
    		&fusionauth.FusionAuthIdpSteamTenantConfigurationArgs{
    			LimitUserLinkCountEnabled:      pulumi.Bool(false),
    			LimitUserLinkCountMaximumLinks: pulumi.Int(0),
    			TenantId:                       pulumi.String("string"),
    		},
    	},
    })
    
    var fusionAuthIdpSteamResource = new FusionAuthIdpSteam("fusionAuthIdpSteamResource", FusionAuthIdpSteamArgs.builder()
        .buttonText("string")
        .clientId("string")
        .webApiKey("string")
        .applicationConfigurations(FusionAuthIdpSteamApplicationConfigurationArgs.builder()
            .applicationId("string")
            .buttonText("string")
            .clientId("string")
            .createRegistration(false)
            .enabled(false)
            .scope("string")
            .webApiKey("string")
            .build())
        .debug(false)
        .enabled(false)
        .idpId("string")
        .lambdaReconcileId("string")
        .linkingStrategy("string")
        .scope("string")
        .tenantConfigurations(FusionAuthIdpSteamTenantConfigurationArgs.builder()
            .limitUserLinkCountEnabled(false)
            .limitUserLinkCountMaximumLinks(0)
            .tenantId("string")
            .build())
        .build());
    
    fusion_auth_idp_steam_resource = fusionauth.FusionAuthIdpSteam("fusionAuthIdpSteamResource",
        button_text="string",
        client_id="string",
        web_api_key="string",
        application_configurations=[{
            "application_id": "string",
            "button_text": "string",
            "client_id": "string",
            "create_registration": False,
            "enabled": False,
            "scope": "string",
            "web_api_key": "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 fusionAuthIdpSteamResource = new fusionauth.FusionAuthIdpSteam("fusionAuthIdpSteamResource", {
        buttonText: "string",
        clientId: "string",
        webApiKey: "string",
        applicationConfigurations: [{
            applicationId: "string",
            buttonText: "string",
            clientId: "string",
            createRegistration: false,
            enabled: false,
            scope: "string",
            webApiKey: "string",
        }],
        debug: false,
        enabled: false,
        idpId: "string",
        lambdaReconcileId: "string",
        linkingStrategy: "string",
        scope: "string",
        tenantConfigurations: [{
            limitUserLinkCountEnabled: false,
            limitUserLinkCountMaximumLinks: 0,
            tenantId: "string",
        }],
    });
    
    type: fusionauth:FusionAuthIdpSteam
    properties:
        applicationConfigurations:
            - applicationId: string
              buttonText: string
              clientId: string
              createRegistration: false
              enabled: false
              scope: string
              webApiKey: string
        buttonText: string
        clientId: string
        debug: false
        enabled: false
        idpId: string
        lambdaReconcileId: string
        linkingStrategy: string
        scope: string
        tenantConfigurations:
            - limitUserLinkCountEnabled: false
              limitUserLinkCountMaximumLinks: 0
              tenantId: string
        webApiKey: string
    

    FusionAuthIdpSteam 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 FusionAuthIdpSteam 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
    The top-level Steam client id for your Application. This value is retrieved from the Steam developer website when you setup your Steam developer account.
    WebApiKey string
    The top-level web API key to use with the Steam Identity Provider when retrieving the player summary info. This value is retrieved from the Steam developer website when you setup your Steam developer account.
    ApplicationConfigurations List<theogravity.Fusionauth.Inputs.FusionAuthIdpSteamApplicationConfiguration>
    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 Steam.
    TenantConfigurations List<theogravity.Fusionauth.Inputs.FusionAuthIdpSteamTenantConfiguration>
    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
    The top-level Steam client id for your Application. This value is retrieved from the Steam developer website when you setup your Steam developer account.
    WebApiKey string
    The top-level web API key to use with the Steam Identity Provider when retrieving the player summary info. This value is retrieved from the Steam developer website when you setup your Steam developer account.
    ApplicationConfigurations []FusionAuthIdpSteamApplicationConfigurationArgs
    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 Steam.
    TenantConfigurations []FusionAuthIdpSteamTenantConfigurationArgs
    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
    The top-level Steam client id for your Application. This value is retrieved from the Steam developer website when you setup your Steam developer account.
    webApiKey String
    The top-level web API key to use with the Steam Identity Provider when retrieving the player summary info. This value is retrieved from the Steam developer website when you setup your Steam developer account.
    applicationConfigurations List<FusionAuthIdpSteamApplicationConfiguration>
    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 Steam.
    tenantConfigurations List<FusionAuthIdpSteamTenantConfiguration>
    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
    The top-level Steam client id for your Application. This value is retrieved from the Steam developer website when you setup your Steam developer account.
    webApiKey string
    The top-level web API key to use with the Steam Identity Provider when retrieving the player summary info. This value is retrieved from the Steam developer website when you setup your Steam developer account.
    applicationConfigurations FusionAuthIdpSteamApplicationConfiguration[]
    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 Steam.
    tenantConfigurations FusionAuthIdpSteamTenantConfiguration[]
    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
    The top-level Steam client id for your Application. This value is retrieved from the Steam developer website when you setup your Steam developer account.
    web_api_key str
    The top-level web API key to use with the Steam Identity Provider when retrieving the player summary info. This value is retrieved from the Steam developer website when you setup your Steam developer account.
    application_configurations Sequence[FusionAuthIdpSteamApplicationConfigurationArgs]
    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 Steam.
    tenant_configurations Sequence[FusionAuthIdpSteamTenantConfigurationArgs]
    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
    The top-level Steam client id for your Application. This value is retrieved from the Steam developer website when you setup your Steam developer account.
    webApiKey String
    The top-level web API key to use with the Steam Identity Provider when retrieving the player summary info. This value is retrieved from the Steam developer website when you setup your Steam 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 Steam.
    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 FusionAuthIdpSteam 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 FusionAuthIdpSteam Resource

    Get an existing FusionAuthIdpSteam 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?: FusionAuthIdpSteamState, opts?: CustomResourceOptions): FusionAuthIdpSteam
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            application_configurations: Optional[Sequence[FusionAuthIdpSteamApplicationConfigurationArgs]] = None,
            button_text: Optional[str] = None,
            client_id: 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[FusionAuthIdpSteamTenantConfigurationArgs]] = None,
            web_api_key: Optional[str] = None) -> FusionAuthIdpSteam
    func GetFusionAuthIdpSteam(ctx *Context, name string, id IDInput, state *FusionAuthIdpSteamState, opts ...ResourceOption) (*FusionAuthIdpSteam, error)
    public static FusionAuthIdpSteam Get(string name, Input<string> id, FusionAuthIdpSteamState? state, CustomResourceOptions? opts = null)
    public static FusionAuthIdpSteam get(String name, Output<String> id, FusionAuthIdpSteamState 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.FusionAuthIdpSteamApplicationConfiguration>
    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
    The top-level Steam client id for your Application. This value is retrieved from the Steam developer website when you setup your Steam 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 Steam.
    TenantConfigurations List<theogravity.Fusionauth.Inputs.FusionAuthIdpSteamTenantConfiguration>
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    WebApiKey string
    The top-level web API key to use with the Steam Identity Provider when retrieving the player summary info. This value is retrieved from the Steam developer website when you setup your Steam developer account.
    ApplicationConfigurations []FusionAuthIdpSteamApplicationConfigurationArgs
    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
    The top-level Steam client id for your Application. This value is retrieved from the Steam developer website when you setup your Steam 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 Steam.
    TenantConfigurations []FusionAuthIdpSteamTenantConfigurationArgs
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    WebApiKey string
    The top-level web API key to use with the Steam Identity Provider when retrieving the player summary info. This value is retrieved from the Steam developer website when you setup your Steam developer account.
    applicationConfigurations List<FusionAuthIdpSteamApplicationConfiguration>
    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
    The top-level Steam client id for your Application. This value is retrieved from the Steam developer website when you setup your Steam 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 Steam.
    tenantConfigurations List<FusionAuthIdpSteamTenantConfiguration>
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    webApiKey String
    The top-level web API key to use with the Steam Identity Provider when retrieving the player summary info. This value is retrieved from the Steam developer website when you setup your Steam developer account.
    applicationConfigurations FusionAuthIdpSteamApplicationConfiguration[]
    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
    The top-level Steam client id for your Application. This value is retrieved from the Steam developer website when you setup your Steam 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 Steam.
    tenantConfigurations FusionAuthIdpSteamTenantConfiguration[]
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    webApiKey string
    The top-level web API key to use with the Steam Identity Provider when retrieving the player summary info. This value is retrieved from the Steam developer website when you setup your Steam developer account.
    application_configurations Sequence[FusionAuthIdpSteamApplicationConfigurationArgs]
    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
    The top-level Steam client id for your Application. This value is retrieved from the Steam developer website when you setup your Steam 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 Steam.
    tenant_configurations Sequence[FusionAuthIdpSteamTenantConfigurationArgs]
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    web_api_key str
    The top-level web API key to use with the Steam Identity Provider when retrieving the player summary info. This value is retrieved from the Steam developer website when you setup your Steam 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.
    clientId String
    The top-level Steam client id for your Application. This value is retrieved from the Steam developer website when you setup your Steam 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 Steam.
    tenantConfigurations List<Property Map>
    The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
    webApiKey String
    The top-level web API key to use with the Steam Identity Provider when retrieving the player summary info. This value is retrieved from the Steam developer website when you setup your Steam developer account.

    Supporting Types

    FusionAuthIdpSteamApplicationConfiguration, FusionAuthIdpSteamApplicationConfigurationArgs

    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.
    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.
    WebApiKey string
    This is an optional Application specific override for the top level webAPIKey.
    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.
    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.
    WebApiKey string
    This is an optional Application specific override for the top level webAPIKey.
    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.
    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.
    webApiKey String
    This is an optional Application specific override for the top level webAPIKey.
    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.
    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.
    webApiKey string
    This is an optional Application specific override for the top level webAPIKey.
    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.
    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.
    web_api_key str
    This is an optional Application specific override for the top level webAPIKey.
    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.
    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.
    webApiKey String
    This is an optional Application specific override for the top level webAPIKey.

    FusionAuthIdpSteamTenantConfiguration, FusionAuthIdpSteamTenantConfigurationArgs

    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