1. Packages
  2. FusionAuth
  3. API Docs
  4. FusionAuthIdpApple
FusionAuth v6.0.2 published on Sunday, Feb 9, 2025 by Theo Gravity

fusionauth.FusionAuthIdpApple

Explore with Pulumi AI

# Apple Identity Provider Resource

The Apple identity provider type will use the Sign in with Apple APIs and will provide a Sign with Apple button on FusionAuth’s login page that will either redirect to an Apple sign in page or leverage native controls when using Safari on macOS or iOS. Additionally, this identity provider will call Apple’s /auth/token API to load additional details about the user and store them in FusionAuth.

FusionAuth will also store the Apple refresh_token that is returned from the /auth/token endpoint in the UserRegistration object inside the tokens Map. This Map stores the tokens from the various identity providers so that you can use them in your application to call their APIs.

Apple Identity Providers API

Example Usage

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

const apple = new fusionauth.FusionAuthIdpApple("apple", {
    applicationConfigurations: [{
        applicationId: "1c212e59-0d0e-6b1a-ad48-f4f92793be32",
        createRegistration: true,
        enabled: true,
    }],
    buttonText: "Sign in with Apple",
    debug: false,
    enabled: true,
    keyId: "2f81529c-4d39-4ce2-982e-cf5fbb1325f6",
    scope: "email name",
    servicesId: "com.piedpiper.webapp",
    teamId: "R4NQ1P4UEB",
});
Copy
import pulumi
import theogravity_pulumi_fusionauth as fusionauth

apple = fusionauth.FusionAuthIdpApple("apple",
    application_configurations=[{
        "application_id": "1c212e59-0d0e-6b1a-ad48-f4f92793be32",
        "create_registration": True,
        "enabled": True,
    }],
    button_text="Sign in with Apple",
    debug=False,
    enabled=True,
    key_id="2f81529c-4d39-4ce2-982e-cf5fbb1325f6",
    scope="email name",
    services_id="com.piedpiper.webapp",
    team_id="R4NQ1P4UEB")
Copy
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.NewFusionAuthIdpApple(ctx, "apple", &fusionauth.FusionAuthIdpAppleArgs{
			ApplicationConfigurations: fusionauth.FusionAuthIdpAppleApplicationConfigurationArray{
				&fusionauth.FusionAuthIdpAppleApplicationConfigurationArgs{
					ApplicationId:      pulumi.String("1c212e59-0d0e-6b1a-ad48-f4f92793be32"),
					CreateRegistration: pulumi.Bool(true),
					Enabled:            pulumi.Bool(true),
				},
			},
			ButtonText: pulumi.String("Sign in with Apple"),
			Debug:      pulumi.Bool(false),
			Enabled:    pulumi.Bool(true),
			KeyId:      pulumi.String("2f81529c-4d39-4ce2-982e-cf5fbb1325f6"),
			Scope:      pulumi.String("email name"),
			ServicesId: pulumi.String("com.piedpiper.webapp"),
			TeamId:     pulumi.String("R4NQ1P4UEB"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fusionauth = theogravity.Fusionauth;

return await Deployment.RunAsync(() => 
{
    var apple = new Fusionauth.FusionAuthIdpApple("apple", new()
    {
        ApplicationConfigurations = new[]
        {
            new Fusionauth.Inputs.FusionAuthIdpAppleApplicationConfigurationArgs
            {
                ApplicationId = "1c212e59-0d0e-6b1a-ad48-f4f92793be32",
                CreateRegistration = true,
                Enabled = true,
            },
        },
        ButtonText = "Sign in with Apple",
        Debug = false,
        Enabled = true,
        KeyId = "2f81529c-4d39-4ce2-982e-cf5fbb1325f6",
        Scope = "email name",
        ServicesId = "com.piedpiper.webapp",
        TeamId = "R4NQ1P4UEB",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fusionauth.FusionAuthIdpApple;
import com.pulumi.fusionauth.FusionAuthIdpAppleArgs;
import com.pulumi.fusionauth.inputs.FusionAuthIdpAppleApplicationConfigurationArgs;
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 apple = new FusionAuthIdpApple("apple", FusionAuthIdpAppleArgs.builder()
            .applicationConfigurations(FusionAuthIdpAppleApplicationConfigurationArgs.builder()
                .applicationId("1c212e59-0d0e-6b1a-ad48-f4f92793be32")
                .createRegistration(true)
                .enabled(true)
                .build())
            .buttonText("Sign in with Apple")
            .debug(false)
            .enabled(true)
            .keyId("2f81529c-4d39-4ce2-982e-cf5fbb1325f6")
            .scope("email name")
            .servicesId("com.piedpiper.webapp")
            .teamId("R4NQ1P4UEB")
            .build());

    }
}
Copy
resources:
  apple:
    type: fusionauth:FusionAuthIdpApple
    properties:
      applicationConfigurations:
        - applicationId: 1c212e59-0d0e-6b1a-ad48-f4f92793be32
          createRegistration: true
          enabled: true
      buttonText: Sign in with Apple
      debug: false
      enabled: true
      keyId: 2f81529c-4d39-4ce2-982e-cf5fbb1325f6
      scope: email name
      servicesId: com.piedpiper.webapp
      teamId: R4NQ1P4UEB
Copy

Create FusionAuthIdpApple Resource

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

Constructor syntax

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

@overload
def FusionAuthIdpApple(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       bundle_id: Optional[str] = None,
                       button_text: Optional[str] = None,
                       key_id: Optional[str] = None,
                       services_id: Optional[str] = None,
                       team_id: Optional[str] = None,
                       application_configurations: Optional[Sequence[FusionAuthIdpAppleApplicationConfigurationArgs]] = None,
                       debug: Optional[bool] = None,
                       enabled: Optional[bool] = None,
                       lambda_reconcile_id: Optional[str] = None,
                       linking_strategy: Optional[str] = None,
                       scope: Optional[str] = None,
                       tenant_configurations: Optional[Sequence[FusionAuthIdpAppleTenantConfigurationArgs]] = None)
func NewFusionAuthIdpApple(ctx *Context, name string, args FusionAuthIdpAppleArgs, opts ...ResourceOption) (*FusionAuthIdpApple, error)
public FusionAuthIdpApple(string name, FusionAuthIdpAppleArgs args, CustomResourceOptions? opts = null)
public FusionAuthIdpApple(String name, FusionAuthIdpAppleArgs args)
public FusionAuthIdpApple(String name, FusionAuthIdpAppleArgs args, CustomResourceOptions options)
type: fusionauth:FusionAuthIdpApple
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. FusionAuthIdpAppleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. FusionAuthIdpAppleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. FusionAuthIdpAppleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. FusionAuthIdpAppleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FusionAuthIdpAppleArgs
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 fusionAuthIdpAppleResource = new Fusionauth.FusionAuthIdpApple("fusionAuthIdpAppleResource", new()
{
    BundleId = "string",
    ButtonText = "string",
    KeyId = "string",
    ServicesId = "string",
    TeamId = "string",
    ApplicationConfigurations = new[]
    {
        new Fusionauth.Inputs.FusionAuthIdpAppleApplicationConfigurationArgs
        {
            ApplicationId = "string",
            BundleId = "string",
            ButtonText = "string",
            CreateRegistration = false,
            Enabled = false,
            KeyId = "string",
            Scope = "string",
            ServicesId = "string",
            TeamId = "string",
        },
    },
    Debug = false,
    Enabled = false,
    LambdaReconcileId = "string",
    LinkingStrategy = "string",
    Scope = "string",
    TenantConfigurations = new[]
    {
        new Fusionauth.Inputs.FusionAuthIdpAppleTenantConfigurationArgs
        {
            LimitUserLinkCountEnabled = false,
            LimitUserLinkCountMaximumLinks = 0,
            TenantId = "string",
        },
    },
});
Copy
example, err := fusionauth.NewFusionAuthIdpApple(ctx, "fusionAuthIdpAppleResource", &fusionauth.FusionAuthIdpAppleArgs{
	BundleId:   pulumi.String("string"),
	ButtonText: pulumi.String("string"),
	KeyId:      pulumi.String("string"),
	ServicesId: pulumi.String("string"),
	TeamId:     pulumi.String("string"),
	ApplicationConfigurations: fusionauth.FusionAuthIdpAppleApplicationConfigurationArray{
		&fusionauth.FusionAuthIdpAppleApplicationConfigurationArgs{
			ApplicationId:      pulumi.String("string"),
			BundleId:           pulumi.String("string"),
			ButtonText:         pulumi.String("string"),
			CreateRegistration: pulumi.Bool(false),
			Enabled:            pulumi.Bool(false),
			KeyId:              pulumi.String("string"),
			Scope:              pulumi.String("string"),
			ServicesId:         pulumi.String("string"),
			TeamId:             pulumi.String("string"),
		},
	},
	Debug:             pulumi.Bool(false),
	Enabled:           pulumi.Bool(false),
	LambdaReconcileId: pulumi.String("string"),
	LinkingStrategy:   pulumi.String("string"),
	Scope:             pulumi.String("string"),
	TenantConfigurations: fusionauth.FusionAuthIdpAppleTenantConfigurationArray{
		&fusionauth.FusionAuthIdpAppleTenantConfigurationArgs{
			LimitUserLinkCountEnabled:      pulumi.Bool(false),
			LimitUserLinkCountMaximumLinks: pulumi.Int(0),
			TenantId:                       pulumi.String("string"),
		},
	},
})
Copy
var fusionAuthIdpAppleResource = new FusionAuthIdpApple("fusionAuthIdpAppleResource", FusionAuthIdpAppleArgs.builder()
    .bundleId("string")
    .buttonText("string")
    .keyId("string")
    .servicesId("string")
    .teamId("string")
    .applicationConfigurations(FusionAuthIdpAppleApplicationConfigurationArgs.builder()
        .applicationId("string")
        .bundleId("string")
        .buttonText("string")
        .createRegistration(false)
        .enabled(false)
        .keyId("string")
        .scope("string")
        .servicesId("string")
        .teamId("string")
        .build())
    .debug(false)
    .enabled(false)
    .lambdaReconcileId("string")
    .linkingStrategy("string")
    .scope("string")
    .tenantConfigurations(FusionAuthIdpAppleTenantConfigurationArgs.builder()
        .limitUserLinkCountEnabled(false)
        .limitUserLinkCountMaximumLinks(0)
        .tenantId("string")
        .build())
    .build());
Copy
fusion_auth_idp_apple_resource = fusionauth.FusionAuthIdpApple("fusionAuthIdpAppleResource",
    bundle_id="string",
    button_text="string",
    key_id="string",
    services_id="string",
    team_id="string",
    application_configurations=[{
        "application_id": "string",
        "bundle_id": "string",
        "button_text": "string",
        "create_registration": False,
        "enabled": False,
        "key_id": "string",
        "scope": "string",
        "services_id": "string",
        "team_id": "string",
    }],
    debug=False,
    enabled=False,
    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",
    }])
Copy
const fusionAuthIdpAppleResource = new fusionauth.FusionAuthIdpApple("fusionAuthIdpAppleResource", {
    bundleId: "string",
    buttonText: "string",
    keyId: "string",
    servicesId: "string",
    teamId: "string",
    applicationConfigurations: [{
        applicationId: "string",
        bundleId: "string",
        buttonText: "string",
        createRegistration: false,
        enabled: false,
        keyId: "string",
        scope: "string",
        servicesId: "string",
        teamId: "string",
    }],
    debug: false,
    enabled: false,
    lambdaReconcileId: "string",
    linkingStrategy: "string",
    scope: "string",
    tenantConfigurations: [{
        limitUserLinkCountEnabled: false,
        limitUserLinkCountMaximumLinks: 0,
        tenantId: "string",
    }],
});
Copy
type: fusionauth:FusionAuthIdpApple
properties:
    applicationConfigurations:
        - applicationId: string
          bundleId: string
          buttonText: string
          createRegistration: false
          enabled: false
          keyId: string
          scope: string
          servicesId: string
          teamId: string
    bundleId: string
    buttonText: string
    debug: false
    enabled: false
    keyId: string
    lambdaReconcileId: string
    linkingStrategy: string
    scope: string
    servicesId: string
    teamId: string
    tenantConfigurations:
        - limitUserLinkCountEnabled: false
          limitUserLinkCountMaximumLinks: 0
          tenantId: string
Copy

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

BundleId This property is required. string
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
ButtonText This property is required. string
The top-level button text to use on the FusionAuth login page for this Identity Provider.
KeyId
This property is required.
Changes to this property will trigger replacement.
string
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
ServicesId This property is required. string
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
TeamId This property is required. string
The Apple App ID Prefix, or Team ID found in your Apple Developer Account which has been configured for Sign in with Apple.
ApplicationConfigurations List<theogravity.Fusionauth.Inputs.FusionAuthIdpAppleApplicationConfiguration>
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.
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 space separated scope that you are requesting from Apple.
TenantConfigurations List<theogravity.Fusionauth.Inputs.FusionAuthIdpAppleTenantConfiguration>
The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
BundleId This property is required. string
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
ButtonText This property is required. string
The top-level button text to use on the FusionAuth login page for this Identity Provider.
KeyId
This property is required.
Changes to this property will trigger replacement.
string
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
ServicesId This property is required. string
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
TeamId This property is required. string
The Apple App ID Prefix, or Team ID found in your Apple Developer Account which has been configured for Sign in with Apple.
ApplicationConfigurations []FusionAuthIdpAppleApplicationConfigurationArgs
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.
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 space separated scope that you are requesting from Apple.
TenantConfigurations []FusionAuthIdpAppleTenantConfigurationArgs
The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
bundleId This property is required. String
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
buttonText This property is required. String
The top-level button text to use on the FusionAuth login page for this Identity Provider.
keyId
This property is required.
Changes to this property will trigger replacement.
String
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
servicesId This property is required. String
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
teamId This property is required. String
The Apple App ID Prefix, or Team ID found in your Apple Developer Account which has been configured for Sign in with Apple.
applicationConfigurations List<FusionAuthIdpAppleApplicationConfiguration>
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.
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 space separated scope that you are requesting from Apple.
tenantConfigurations List<FusionAuthIdpAppleTenantConfiguration>
The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
bundleId This property is required. string
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
buttonText This property is required. string
The top-level button text to use on the FusionAuth login page for this Identity Provider.
keyId
This property is required.
Changes to this property will trigger replacement.
string
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
servicesId This property is required. string
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
teamId This property is required. string
The Apple App ID Prefix, or Team ID found in your Apple Developer Account which has been configured for Sign in with Apple.
applicationConfigurations FusionAuthIdpAppleApplicationConfiguration[]
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.
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 space separated scope that you are requesting from Apple.
tenantConfigurations FusionAuthIdpAppleTenantConfiguration[]
The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
bundle_id This property is required. str
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
button_text This property is required. str
The top-level button text to use on the FusionAuth login page for this Identity Provider.
key_id
This property is required.
Changes to this property will trigger replacement.
str
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
services_id This property is required. str
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
team_id This property is required. str
The Apple App ID Prefix, or Team ID found in your Apple Developer Account which has been configured for Sign in with Apple.
application_configurations Sequence[FusionAuthIdpAppleApplicationConfigurationArgs]
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.
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 space separated scope that you are requesting from Apple.
tenant_configurations Sequence[FusionAuthIdpAppleTenantConfigurationArgs]
The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
bundleId This property is required. String
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
buttonText This property is required. String
The top-level button text to use on the FusionAuth login page for this Identity Provider.
keyId
This property is required.
Changes to this property will trigger replacement.
String
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
servicesId This property is required. String
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
teamId This property is required. String
The Apple App ID Prefix, or Team ID found in your Apple Developer Account which has been configured for Sign in with Apple.
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.
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 space separated scope that you are requesting from Apple.
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 FusionAuthIdpApple 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 FusionAuthIdpApple Resource

Get an existing FusionAuthIdpApple 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?: FusionAuthIdpAppleState, opts?: CustomResourceOptions): FusionAuthIdpApple
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application_configurations: Optional[Sequence[FusionAuthIdpAppleApplicationConfigurationArgs]] = None,
        bundle_id: Optional[str] = None,
        button_text: Optional[str] = None,
        debug: Optional[bool] = None,
        enabled: Optional[bool] = None,
        key_id: Optional[str] = None,
        lambda_reconcile_id: Optional[str] = None,
        linking_strategy: Optional[str] = None,
        scope: Optional[str] = None,
        services_id: Optional[str] = None,
        team_id: Optional[str] = None,
        tenant_configurations: Optional[Sequence[FusionAuthIdpAppleTenantConfigurationArgs]] = None) -> FusionAuthIdpApple
func GetFusionAuthIdpApple(ctx *Context, name string, id IDInput, state *FusionAuthIdpAppleState, opts ...ResourceOption) (*FusionAuthIdpApple, error)
public static FusionAuthIdpApple Get(string name, Input<string> id, FusionAuthIdpAppleState? state, CustomResourceOptions? opts = null)
public static FusionAuthIdpApple get(String name, Output<String> id, FusionAuthIdpAppleState state, CustomResourceOptions options)
resources:  _:    type: fusionauth:FusionAuthIdpApple    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.FusionAuthIdpAppleApplicationConfiguration>
The configuration for each Application that the identity provider is enabled for.
BundleId string
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
ButtonText string
The top-level button text to use on the FusionAuth login page for this Identity Provider.
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.
KeyId Changes to this property will trigger replacement. string
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
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 space separated scope that you are requesting from Apple.
ServicesId string
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
TeamId string
The Apple App ID Prefix, or Team ID found in your Apple Developer Account which has been configured for Sign in with Apple.
TenantConfigurations List<theogravity.Fusionauth.Inputs.FusionAuthIdpAppleTenantConfiguration>
The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
ApplicationConfigurations []FusionAuthIdpAppleApplicationConfigurationArgs
The configuration for each Application that the identity provider is enabled for.
BundleId string
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
ButtonText string
The top-level button text to use on the FusionAuth login page for this Identity Provider.
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.
KeyId Changes to this property will trigger replacement. string
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
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 space separated scope that you are requesting from Apple.
ServicesId string
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
TeamId string
The Apple App ID Prefix, or Team ID found in your Apple Developer Account which has been configured for Sign in with Apple.
TenantConfigurations []FusionAuthIdpAppleTenantConfigurationArgs
The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
applicationConfigurations List<FusionAuthIdpAppleApplicationConfiguration>
The configuration for each Application that the identity provider is enabled for.
bundleId String
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
buttonText String
The top-level button text to use on the FusionAuth login page for this Identity Provider.
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.
keyId Changes to this property will trigger replacement. String
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
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 space separated scope that you are requesting from Apple.
servicesId String
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
teamId String
The Apple App ID Prefix, or Team ID found in your Apple Developer Account which has been configured for Sign in with Apple.
tenantConfigurations List<FusionAuthIdpAppleTenantConfiguration>
The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
applicationConfigurations FusionAuthIdpAppleApplicationConfiguration[]
The configuration for each Application that the identity provider is enabled for.
bundleId string
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
buttonText string
The top-level button text to use on the FusionAuth login page for this Identity Provider.
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.
keyId Changes to this property will trigger replacement. string
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
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 space separated scope that you are requesting from Apple.
servicesId string
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
teamId string
The Apple App ID Prefix, or Team ID found in your Apple Developer Account which has been configured for Sign in with Apple.
tenantConfigurations FusionAuthIdpAppleTenantConfiguration[]
The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
application_configurations Sequence[FusionAuthIdpAppleApplicationConfigurationArgs]
The configuration for each Application that the identity provider is enabled for.
bundle_id str
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
button_text str
The top-level button text to use on the FusionAuth login page for this Identity Provider.
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.
key_id Changes to this property will trigger replacement. str
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
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 space separated scope that you are requesting from Apple.
services_id str
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
team_id str
The Apple App ID Prefix, or Team ID found in your Apple Developer Account which has been configured for Sign in with Apple.
tenant_configurations Sequence[FusionAuthIdpAppleTenantConfigurationArgs]
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.
bundleId String
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
buttonText String
The top-level button text to use on the FusionAuth login page for this Identity Provider.
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.
keyId Changes to this property will trigger replacement. String
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
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 space separated scope that you are requesting from Apple.
servicesId String
The unique Id of the private key downloaded from Apple and imported into Key Master that will be used to sign the client secret.
teamId String
The Apple App ID Prefix, or Team ID found in your Apple Developer Account which has been configured for Sign in with Apple.
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

FusionAuthIdpAppleApplicationConfiguration
, FusionAuthIdpAppleApplicationConfigurationArgs

ApplicationId string
ID of the Application to apply this configuration to.
BundleId string
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
ButtonText string
This is an optional Application specific override for the top level button text.
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.
KeyId string
This is an optional Application specific override for the top level keyId.
Scope string
This is an optional Application specific override for for the top level scope.
ServicesId string
This is an optional Application specific override for for the top level servicesId.
TeamId string
This is an optional Application specific override for for the top level teamId.
ApplicationId string
ID of the Application to apply this configuration to.
BundleId string
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
ButtonText string
This is an optional Application specific override for the top level button text.
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.
KeyId string
This is an optional Application specific override for the top level keyId.
Scope string
This is an optional Application specific override for for the top level scope.
ServicesId string
This is an optional Application specific override for for the top level servicesId.
TeamId string
This is an optional Application specific override for for the top level teamId.
applicationId String
ID of the Application to apply this configuration to.
bundleId String
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
buttonText String
This is an optional Application specific override for the top level button text.
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.
keyId String
This is an optional Application specific override for the top level keyId.
scope String
This is an optional Application specific override for for the top level scope.
servicesId String
This is an optional Application specific override for for the top level servicesId.
teamId String
This is an optional Application specific override for for the top level teamId.
applicationId string
ID of the Application to apply this configuration to.
bundleId string
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
buttonText string
This is an optional Application specific override for the top level button text.
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.
keyId string
This is an optional Application specific override for the top level keyId.
scope string
This is an optional Application specific override for for the top level scope.
servicesId string
This is an optional Application specific override for for the top level servicesId.
teamId string
This is an optional Application specific override for for the top level teamId.
application_id str
ID of the Application to apply this configuration to.
bundle_id str
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
button_text str
This is an optional Application specific override for the top level button text.
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.
key_id str
This is an optional Application specific override for the top level keyId.
scope str
This is an optional Application specific override for for the top level scope.
services_id str
This is an optional Application specific override for for the top level servicesId.
team_id str
This is an optional Application specific override for for the top level teamId.
applicationId String
ID of the Application to apply this configuration to.
bundleId String
The Apple Bundle identifier found in your Apple Developer Account which has been configured for Sign in with Apple. The Bundle identifier is used to Sign in with Apple from native applications. The request must include bundle_id or services_id . If services_id is omitted, this field is required.
buttonText String
This is an optional Application specific override for the top level button text.
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.
keyId String
This is an optional Application specific override for the top level keyId.
scope String
This is an optional Application specific override for for the top level scope.
servicesId String
This is an optional Application specific override for for the top level servicesId.
teamId String
This is an optional Application specific override for for the top level teamId.

FusionAuthIdpAppleTenantConfiguration
, FusionAuthIdpAppleTenantConfigurationArgs

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.