published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages the project-level passkey (WebAuthn) authentication settings. This is a singleton resource, and its id is always the project ID.
Create PasskeySettings Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PasskeySettings(name: string, args: PasskeySettingsArgs, opts?: CustomResourceOptions);@overload
def PasskeySettings(resource_name: str,
args: PasskeySettingsArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PasskeySettings(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
android_fingerprints: Optional[Sequence[str]] = None,
disabled: Optional[bool] = None,
display_name: Optional[str] = None,
top_level_domain: Optional[str] = None)func NewPasskeySettings(ctx *Context, name string, args PasskeySettingsArgs, opts ...ResourceOption) (*PasskeySettings, error)public PasskeySettings(string name, PasskeySettingsArgs args, CustomResourceOptions? opts = null)
public PasskeySettings(String name, PasskeySettingsArgs args)
public PasskeySettings(String name, PasskeySettingsArgs args, CustomResourceOptions options)
type: descope:PasskeySettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_passkey_settings" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args PasskeySettingsArgs
- 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 PasskeySettingsArgs
- 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 PasskeySettingsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PasskeySettingsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PasskeySettingsArgs
- 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 passkeySettingsResource = new Descope.PasskeySettings("passkeySettingsResource", new()
{
ProjectId = "string",
AndroidFingerprints = new[]
{
"string",
},
Disabled = false,
DisplayName = "string",
TopLevelDomain = "string",
});
example, err := descope.NewPasskeySettings(ctx, "passkeySettingsResource", &descope.PasskeySettingsArgs{
ProjectId: pulumi.String("string"),
AndroidFingerprints: pulumi.StringArray{
pulumi.String("string"),
},
Disabled: pulumi.Bool(false),
DisplayName: pulumi.String("string"),
TopLevelDomain: pulumi.String("string"),
})
resource "descope_passkey_settings" "passkeySettingsResource" {
lifecycle {
create_before_destroy = true
}
project_id = "string"
android_fingerprints = ["string"]
disabled = false
display_name = "string"
top_level_domain = "string"
}
var passkeySettingsResource = new PasskeySettings("passkeySettingsResource", PasskeySettingsArgs.builder()
.projectId("string")
.androidFingerprints("string")
.disabled(false)
.displayName("string")
.topLevelDomain("string")
.build());
passkey_settings_resource = descope.PasskeySettings("passkeySettingsResource",
project_id="string",
android_fingerprints=["string"],
disabled=False,
display_name="string",
top_level_domain="string")
const passkeySettingsResource = new descope.PasskeySettings("passkeySettingsResource", {
projectId: "string",
androidFingerprints: ["string"],
disabled: false,
displayName: "string",
topLevelDomain: "string",
});
type: descope:PasskeySettings
properties:
androidFingerprints:
- string
disabled: false
displayName: string
projectId: string
topLevelDomain: string
PasskeySettings 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 PasskeySettings resource accepts the following input properties:
- Project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- Android
Fingerprints List<string> - A list of SHA-256 APK key hash fingerprints (colon-separated hex, e.g.
AB:CD:EF:...) that are allowed as passkey origins for Android apps. When set, only Android apps with a matching fingerprint will be permitted to use passkey authentication. - Disabled bool
- Setting this to
truewill disallow using passkey authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passkeys. - Display
Name string - The human-friendly name shown to users when they create or use a passkey. Some password managers display this name, while others display the top level domain instead. When left empty, the project name is used.
- Top
Level stringDomain - Passkeys will be usable in the following domain and all its subdomains.
- Project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- Android
Fingerprints []string - A list of SHA-256 APK key hash fingerprints (colon-separated hex, e.g.
AB:CD:EF:...) that are allowed as passkey origins for Android apps. When set, only Android apps with a matching fingerprint will be permitted to use passkey authentication. - Disabled bool
- Setting this to
truewill disallow using passkey authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passkeys. - Display
Name string - The human-friendly name shown to users when they create or use a passkey. Some password managers display this name, while others display the top level domain instead. When left empty, the project name is used.
- Top
Level stringDomain - Passkeys will be usable in the following domain and all its subdomains.
- project_
id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- android_
fingerprints list(string) - A list of SHA-256 APK key hash fingerprints (colon-separated hex, e.g.
AB:CD:EF:...) that are allowed as passkey origins for Android apps. When set, only Android apps with a matching fingerprint will be permitted to use passkey authentication. - disabled bool
- Setting this to
truewill disallow using passkey authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passkeys. - display_
name string - The human-friendly name shown to users when they create or use a passkey. Some password managers display this name, while others display the top level domain instead. When left empty, the project name is used.
- top_
level_ stringdomain - Passkeys will be usable in the following domain and all its subdomains.
- project
Id String - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- android
Fingerprints List<String> - A list of SHA-256 APK key hash fingerprints (colon-separated hex, e.g.
AB:CD:EF:...) that are allowed as passkey origins for Android apps. When set, only Android apps with a matching fingerprint will be permitted to use passkey authentication. - disabled Boolean
- Setting this to
truewill disallow using passkey authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passkeys. - display
Name String - The human-friendly name shown to users when they create or use a passkey. Some password managers display this name, while others display the top level domain instead. When left empty, the project name is used.
- top
Level StringDomain - Passkeys will be usable in the following domain and all its subdomains.
- project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- android
Fingerprints string[] - A list of SHA-256 APK key hash fingerprints (colon-separated hex, e.g.
AB:CD:EF:...) that are allowed as passkey origins for Android apps. When set, only Android apps with a matching fingerprint will be permitted to use passkey authentication. - disabled boolean
- Setting this to
truewill disallow using passkey authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passkeys. - display
Name string - The human-friendly name shown to users when they create or use a passkey. Some password managers display this name, while others display the top level domain instead. When left empty, the project name is used.
- top
Level stringDomain - Passkeys will be usable in the following domain and all its subdomains.
- project_
id str - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- android_
fingerprints Sequence[str] - A list of SHA-256 APK key hash fingerprints (colon-separated hex, e.g.
AB:CD:EF:...) that are allowed as passkey origins for Android apps. When set, only Android apps with a matching fingerprint will be permitted to use passkey authentication. - disabled bool
- Setting this to
truewill disallow using passkey authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passkeys. - display_
name str - The human-friendly name shown to users when they create or use a passkey. Some password managers display this name, while others display the top level domain instead. When left empty, the project name is used.
- top_
level_ strdomain - Passkeys will be usable in the following domain and all its subdomains.
- project
Id String - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- android
Fingerprints List<String> - A list of SHA-256 APK key hash fingerprints (colon-separated hex, e.g.
AB:CD:EF:...) that are allowed as passkey origins for Android apps. When set, only Android apps with a matching fingerprint will be permitted to use passkey authentication. - disabled Boolean
- Setting this to
truewill disallow using passkey authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passkeys. - display
Name String - The human-friendly name shown to users when they create or use a passkey. Some password managers display this name, while others display the top level domain instead. When left empty, the project name is used.
- top
Level StringDomain - Passkeys will be usable in the following domain and all its subdomains.
Outputs
All input properties are implicitly available as output properties. Additionally, the PasskeySettings 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 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 PasskeySettings Resource
Get an existing PasskeySettings 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?: PasskeySettingsState, opts?: CustomResourceOptions): PasskeySettings@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
android_fingerprints: Optional[Sequence[str]] = None,
disabled: Optional[bool] = None,
display_name: Optional[str] = None,
project_id: Optional[str] = None,
top_level_domain: Optional[str] = None) -> PasskeySettingsfunc GetPasskeySettings(ctx *Context, name string, id IDInput, state *PasskeySettingsState, opts ...ResourceOption) (*PasskeySettings, error)public static PasskeySettings Get(string name, Input<string> id, PasskeySettingsState? state, CustomResourceOptions? opts = null)public static PasskeySettings get(String name, Output<String> id, PasskeySettingsState state, CustomResourceOptions options)resources: existingPasskeySettings: type: descope:PasskeySettings get: id: ${id}import {
to = descope_passkey_settings.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state PasskeySettingsState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state PasskeySettingsState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state PasskeySettingsState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state PasskeySettingsState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Android
Fingerprints List<string> - A list of SHA-256 APK key hash fingerprints (colon-separated hex, e.g.
AB:CD:EF:...) that are allowed as passkey origins for Android apps. When set, only Android apps with a matching fingerprint will be permitted to use passkey authentication. - Disabled bool
- Setting this to
truewill disallow using passkey authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passkeys. - Display
Name string - The human-friendly name shown to users when they create or use a passkey. Some password managers display this name, while others display the top level domain instead. When left empty, the project name is used.
- Project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- Top
Level stringDomain - Passkeys will be usable in the following domain and all its subdomains.
- Android
Fingerprints []string - A list of SHA-256 APK key hash fingerprints (colon-separated hex, e.g.
AB:CD:EF:...) that are allowed as passkey origins for Android apps. When set, only Android apps with a matching fingerprint will be permitted to use passkey authentication. - Disabled bool
- Setting this to
truewill disallow using passkey authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passkeys. - Display
Name string - The human-friendly name shown to users when they create or use a passkey. Some password managers display this name, while others display the top level domain instead. When left empty, the project name is used.
- Project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- Top
Level stringDomain - Passkeys will be usable in the following domain and all its subdomains.
- android_
fingerprints list(string) - A list of SHA-256 APK key hash fingerprints (colon-separated hex, e.g.
AB:CD:EF:...) that are allowed as passkey origins for Android apps. When set, only Android apps with a matching fingerprint will be permitted to use passkey authentication. - disabled bool
- Setting this to
truewill disallow using passkey authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passkeys. - display_
name string - The human-friendly name shown to users when they create or use a passkey. Some password managers display this name, while others display the top level domain instead. When left empty, the project name is used.
- project_
id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- top_
level_ stringdomain - Passkeys will be usable in the following domain and all its subdomains.
- android
Fingerprints List<String> - A list of SHA-256 APK key hash fingerprints (colon-separated hex, e.g.
AB:CD:EF:...) that are allowed as passkey origins for Android apps. When set, only Android apps with a matching fingerprint will be permitted to use passkey authentication. - disabled Boolean
- Setting this to
truewill disallow using passkey authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passkeys. - display
Name String - The human-friendly name shown to users when they create or use a passkey. Some password managers display this name, while others display the top level domain instead. When left empty, the project name is used.
- project
Id String - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- top
Level StringDomain - Passkeys will be usable in the following domain and all its subdomains.
- android
Fingerprints string[] - A list of SHA-256 APK key hash fingerprints (colon-separated hex, e.g.
AB:CD:EF:...) that are allowed as passkey origins for Android apps. When set, only Android apps with a matching fingerprint will be permitted to use passkey authentication. - disabled boolean
- Setting this to
truewill disallow using passkey authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passkeys. - display
Name string - The human-friendly name shown to users when they create or use a passkey. Some password managers display this name, while others display the top level domain instead. When left empty, the project name is used.
- project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- top
Level stringDomain - Passkeys will be usable in the following domain and all its subdomains.
- android_
fingerprints Sequence[str] - A list of SHA-256 APK key hash fingerprints (colon-separated hex, e.g.
AB:CD:EF:...) that are allowed as passkey origins for Android apps. When set, only Android apps with a matching fingerprint will be permitted to use passkey authentication. - disabled bool
- Setting this to
truewill disallow using passkey authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passkeys. - display_
name str - The human-friendly name shown to users when they create or use a passkey. Some password managers display this name, while others display the top level domain instead. When left empty, the project name is used.
- project_
id str - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- top_
level_ strdomain - Passkeys will be usable in the following domain and all its subdomains.
- android
Fingerprints List<String> - A list of SHA-256 APK key hash fingerprints (colon-separated hex, e.g.
AB:CD:EF:...) that are allowed as passkey origins for Android apps. When set, only Android apps with a matching fingerprint will be permitted to use passkey authentication. - disabled Boolean
- Setting this to
truewill disallow using passkey authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passkeys. - display
Name String - The human-friendly name shown to users when they create or use a passkey. Some password managers display this name, while others display the top level domain instead. When left empty, the project name is used.
- project
Id String - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- top
Level StringDomain - Passkeys will be usable in the following domain and all its subdomains.
Package Details
- Repository
- descope descope/pulumi-descope
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope