published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages the project-level TOTP (authenticator app) authentication settings. This is a singleton resource, and its id is always the project ID.
Create TotpSettings Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TotpSettings(name: string, args: TotpSettingsArgs, opts?: CustomResourceOptions);@overload
def TotpSettings(resource_name: str,
args: TotpSettingsArgs,
opts: Optional[ResourceOptions] = None)
@overload
def TotpSettings(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
disabled: Optional[bool] = None,
service_label: Optional[str] = None)func NewTotpSettings(ctx *Context, name string, args TotpSettingsArgs, opts ...ResourceOption) (*TotpSettings, error)public TotpSettings(string name, TotpSettingsArgs args, CustomResourceOptions? opts = null)
public TotpSettings(String name, TotpSettingsArgs args)
public TotpSettings(String name, TotpSettingsArgs args, CustomResourceOptions options)
type: descope:TotpSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_totp_settings" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args TotpSettingsArgs
- 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 TotpSettingsArgs
- 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 TotpSettingsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TotpSettingsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TotpSettingsArgs
- 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 totpSettingsResource = new Descope.TotpSettings("totpSettingsResource", new()
{
ProjectId = "string",
Disabled = false,
ServiceLabel = "string",
});
example, err := descope.NewTotpSettings(ctx, "totpSettingsResource", &descope.TotpSettingsArgs{
ProjectId: pulumi.String("string"),
Disabled: pulumi.Bool(false),
ServiceLabel: pulumi.String("string"),
})
resource "descope_totp_settings" "totpSettingsResource" {
lifecycle {
create_before_destroy = true
}
project_id = "string"
disabled = false
service_label = "string"
}
var totpSettingsResource = new TotpSettings("totpSettingsResource", TotpSettingsArgs.builder()
.projectId("string")
.disabled(false)
.serviceLabel("string")
.build());
totp_settings_resource = descope.TotpSettings("totpSettingsResource",
project_id="string",
disabled=False,
service_label="string")
const totpSettingsResource = new descope.TotpSettings("totpSettingsResource", {
projectId: "string",
disabled: false,
serviceLabel: "string",
});
type: descope:TotpSettings
properties:
disabled: false
projectId: string
serviceLabel: string
TotpSettings 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 TotpSettings 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.
- Disabled bool
- Setting this to
truewill disallow using TOTP authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use TOTP. - Service
Label string - The template for the service issuer label (issuer) shown in the authenticator app.
- 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.
- Disabled bool
- Setting this to
truewill disallow using TOTP authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use TOTP. - Service
Label string - The template for the service issuer label (issuer) shown in the authenticator app.
- 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.
- disabled bool
- Setting this to
truewill disallow using TOTP authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use TOTP. - service_
label string - The template for the service issuer label (issuer) shown in the authenticator app.
- 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.
- disabled Boolean
- Setting this to
truewill disallow using TOTP authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use TOTP. - service
Label String - The template for the service issuer label (issuer) shown in the authenticator app.
- 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.
- disabled boolean
- Setting this to
truewill disallow using TOTP authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use TOTP. - service
Label string - The template for the service issuer label (issuer) shown in the authenticator app.
- 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.
- disabled bool
- Setting this to
truewill disallow using TOTP authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use TOTP. - service_
label str - The template for the service issuer label (issuer) shown in the authenticator app.
- 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.
- disabled Boolean
- Setting this to
truewill disallow using TOTP authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use TOTP. - service
Label String - The template for the service issuer label (issuer) shown in the authenticator app.
Outputs
All input properties are implicitly available as output properties. Additionally, the TotpSettings 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 TotpSettings Resource
Get an existing TotpSettings 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?: TotpSettingsState, opts?: CustomResourceOptions): TotpSettings@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
disabled: Optional[bool] = None,
project_id: Optional[str] = None,
service_label: Optional[str] = None) -> TotpSettingsfunc GetTotpSettings(ctx *Context, name string, id IDInput, state *TotpSettingsState, opts ...ResourceOption) (*TotpSettings, error)public static TotpSettings Get(string name, Input<string> id, TotpSettingsState? state, CustomResourceOptions? opts = null)public static TotpSettings get(String name, Output<String> id, TotpSettingsState state, CustomResourceOptions options)resources: existingTotpSettings: type: descope:TotpSettings get: id: ${id}import {
to = descope_totp_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 TotpSettingsState
- 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 TotpSettingsState
- 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 TotpSettingsState
- 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 TotpSettingsState
- 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.
- Disabled bool
- Setting this to
truewill disallow using TOTP authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use TOTP. - 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.
- Service
Label string - The template for the service issuer label (issuer) shown in the authenticator app.
- Disabled bool
- Setting this to
truewill disallow using TOTP authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use TOTP. - 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.
- Service
Label string - The template for the service issuer label (issuer) shown in the authenticator app.
- disabled bool
- Setting this to
truewill disallow using TOTP authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use TOTP. - 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.
- service_
label string - The template for the service issuer label (issuer) shown in the authenticator app.
- disabled Boolean
- Setting this to
truewill disallow using TOTP authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use TOTP. - 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.
- service
Label String - The template for the service issuer label (issuer) shown in the authenticator app.
- disabled boolean
- Setting this to
truewill disallow using TOTP authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use TOTP. - 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.
- service
Label string - The template for the service issuer label (issuer) shown in the authenticator app.
- disabled bool
- Setting this to
truewill disallow using TOTP authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use TOTP. - 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.
- service_
label str - The template for the service issuer label (issuer) shown in the authenticator app.
- disabled Boolean
- Setting this to
truewill disallow using TOTP authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use TOTP. - 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.
- service
Label String - The template for the service issuer label (issuer) shown in the authenticator app.
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