Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Authentik Provider
  3. API Docs
  4. StageAuthenticatorSms
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik

authentik.StageAuthenticatorSms

Explore with Pulumi AI

authentik logo
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik

    Create StageAuthenticatorSms Resource

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

    Constructor syntax

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

@overload
def StageAuthenticatorSms(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          account_sid: Optional[str] = None,
                          auth: Optional[str] = None,
                          from_number: Optional[str] = None,
                          auth_password: Optional[str] = None,
                          auth_type: Optional[str] = None,
                          configure_flow: Optional[str] = None,
                          friendly_name: Optional[str] = None,
                          mapping: Optional[str] = None,
                          name: Optional[str] = None,
                          sms_provider: Optional[str] = None,
                          stage_authenticator_sms_id: Optional[str] = None,
                          verify_only: Optional[bool] = None)
    func NewStageAuthenticatorSms(ctx *Context, name string, args StageAuthenticatorSmsArgs, opts ...ResourceOption) (*StageAuthenticatorSms, error)
    public StageAuthenticatorSms(string name, StageAuthenticatorSmsArgs args, CustomResourceOptions? opts = null)
    public StageAuthenticatorSms(String name, StageAuthenticatorSmsArgs args)
public StageAuthenticatorSms(String name, StageAuthenticatorSmsArgs args, CustomResourceOptions options)

    type: authentik:StageAuthenticatorSms
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 StageAuthenticatorSmsArgs
    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 StageAuthenticatorSmsArgs
    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 StageAuthenticatorSmsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StageAuthenticatorSmsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StageAuthenticatorSmsArgs
    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 stageAuthenticatorSmsResource = new Authentik.StageAuthenticatorSms("stageAuthenticatorSmsResource", new()
{
    AccountSid = "string",
    Auth = "string",
    FromNumber = "string",
    AuthPassword = "string",
    AuthType = "string",
    ConfigureFlow = "string",
    FriendlyName = "string",
    Mapping = "string",
    Name = "string",
    SmsProvider = "string",
    StageAuthenticatorSmsId = "string",
    VerifyOnly = false,
});

    example, err := authentik.NewStageAuthenticatorSms(ctx, "stageAuthenticatorSmsResource", &authentik.StageAuthenticatorSmsArgs{
	AccountSid:              pulumi.String("string"),
	Auth:                    pulumi.String("string"),
	FromNumber:              pulumi.String("string"),
	AuthPassword:            pulumi.String("string"),
	AuthType:                pulumi.String("string"),
	ConfigureFlow:           pulumi.String("string"),
	FriendlyName:            pulumi.String("string"),
	Mapping:                 pulumi.String("string"),
	Name:                    pulumi.String("string"),
	SmsProvider:             pulumi.String("string"),
	StageAuthenticatorSmsId: pulumi.String("string"),
	VerifyOnly:              pulumi.Bool(false),
})

    var stageAuthenticatorSmsResource = new StageAuthenticatorSms("stageAuthenticatorSmsResource", StageAuthenticatorSmsArgs.builder()
    .accountSid("string")
    .auth("string")
    .fromNumber("string")
    .authPassword("string")
    .authType("string")
    .configureFlow("string")
    .friendlyName("string")
    .mapping("string")
    .name("string")
    .smsProvider("string")
    .stageAuthenticatorSmsId("string")
    .verifyOnly(false)
    .build());

    stage_authenticator_sms_resource = authentik.StageAuthenticatorSms("stageAuthenticatorSmsResource",
    account_sid="string",
    auth="string",
    from_number="string",
    auth_password="string",
    auth_type="string",
    configure_flow="string",
    friendly_name="string",
    mapping="string",
    name="string",
    sms_provider="string",
    stage_authenticator_sms_id="string",
    verify_only=False)

    const stageAuthenticatorSmsResource = new authentik.StageAuthenticatorSms("stageAuthenticatorSmsResource", {
    accountSid: "string",
    auth: "string",
    fromNumber: "string",
    authPassword: "string",
    authType: "string",
    configureFlow: "string",
    friendlyName: "string",
    mapping: "string",
    name: "string",
    smsProvider: "string",
    stageAuthenticatorSmsId: "string",
    verifyOnly: false,
});

    type: authentik:StageAuthenticatorSms
properties:
    accountSid: string
    auth: string
    authPassword: string
    authType: string
    configureFlow: string
    friendlyName: string
    fromNumber: string
    mapping: string
    name: string
    smsProvider: string
    stageAuthenticatorSmsId: string
    verifyOnly: false

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

    AccountSid string
    Auth string
    FromNumber string
    AuthPassword string
    AuthType string
    Allowed values: - basic - bearer Defaults to basic.
    ConfigureFlow string
    FriendlyName string
    Mapping string
    Name string
    SmsProvider string
    Allowed values: - twilio - generic Defaults to twilio.
    StageAuthenticatorSmsId string
    VerifyOnly bool
    Defaults to false.
    AccountSid string
    Auth string
    FromNumber string
    AuthPassword string
    AuthType string
    Allowed values: - basic - bearer Defaults to basic.
    ConfigureFlow string
    FriendlyName string
    Mapping string
    Name string
    SmsProvider string
    Allowed values: - twilio - generic Defaults to twilio.
    StageAuthenticatorSmsId string
    VerifyOnly bool
    Defaults to false.
    accountSid String
    auth String
    fromNumber String
    authPassword String
    authType String
    Allowed values: - basic - bearer Defaults to basic.
    configureFlow String
    friendlyName String
    mapping String
    name String
    smsProvider String
    Allowed values: - twilio - generic Defaults to twilio.
    stageAuthenticatorSmsId String
    verifyOnly Boolean
    Defaults to false.
    accountSid string
    auth string
    fromNumber string
    authPassword string
    authType string
    Allowed values: - basic - bearer Defaults to basic.
    configureFlow string
    friendlyName string
    mapping string
    name string
    smsProvider string
    Allowed values: - twilio - generic Defaults to twilio.
    stageAuthenticatorSmsId string
    verifyOnly boolean
    Defaults to false.
    account_sid str
    auth str
    from_number str
    auth_password str
    auth_type str
    Allowed values: - basic - bearer Defaults to basic.
    configure_flow str
    friendly_name str
    mapping str
    name str
    sms_provider str
    Allowed values: - twilio - generic Defaults to twilio.
    stage_authenticator_sms_id str
    verify_only bool
    Defaults to false.
    accountSid String
    auth String
    fromNumber String
    authPassword String
    authType String
    Allowed values: - basic - bearer Defaults to basic.
    configureFlow String
    friendlyName String
    mapping String
    name String
    smsProvider String
    Allowed values: - twilio - generic Defaults to twilio.
    stageAuthenticatorSmsId String
    verifyOnly Boolean
    Defaults to false.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StageAuthenticatorSms 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 StageAuthenticatorSms Resource

    Get an existing StageAuthenticatorSms 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?: StageAuthenticatorSmsState, opts?: CustomResourceOptions): StageAuthenticatorSms
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_sid: Optional[str] = None,
        auth: Optional[str] = None,
        auth_password: Optional[str] = None,
        auth_type: Optional[str] = None,
        configure_flow: Optional[str] = None,
        friendly_name: Optional[str] = None,
        from_number: Optional[str] = None,
        mapping: Optional[str] = None,
        name: Optional[str] = None,
        sms_provider: Optional[str] = None,
        stage_authenticator_sms_id: Optional[str] = None,
        verify_only: Optional[bool] = None) -> StageAuthenticatorSms
    func GetStageAuthenticatorSms(ctx *Context, name string, id IDInput, state *StageAuthenticatorSmsState, opts ...ResourceOption) (*StageAuthenticatorSms, error)
    public static StageAuthenticatorSms Get(string name, Input<string> id, StageAuthenticatorSmsState? state, CustomResourceOptions? opts = null)
    public static StageAuthenticatorSms get(String name, Output<String> id, StageAuthenticatorSmsState state, CustomResourceOptions options)
    resources:  _:    type: authentik:StageAuthenticatorSms    get:      id: ${id}
    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:
    AccountSid string
    Auth string
    AuthPassword string
    AuthType string
    Allowed values: - basic - bearer Defaults to basic.
    ConfigureFlow string
    FriendlyName string
    FromNumber string
    Mapping string
    Name string
    SmsProvider string
    Allowed values: - twilio - generic Defaults to twilio.
    StageAuthenticatorSmsId string
    VerifyOnly bool
    Defaults to false.
    AccountSid string
    Auth string
    AuthPassword string
    AuthType string
    Allowed values: - basic - bearer Defaults to basic.
    ConfigureFlow string
    FriendlyName string
    FromNumber string
    Mapping string
    Name string
    SmsProvider string
    Allowed values: - twilio - generic Defaults to twilio.
    StageAuthenticatorSmsId string
    VerifyOnly bool
    Defaults to false.
    accountSid String
    auth String
    authPassword String
    authType String
    Allowed values: - basic - bearer Defaults to basic.
    configureFlow String
    friendlyName String
    fromNumber String
    mapping String
    name String
    smsProvider String
    Allowed values: - twilio - generic Defaults to twilio.
    stageAuthenticatorSmsId String
    verifyOnly Boolean
    Defaults to false.
    accountSid string
    auth string
    authPassword string
    authType string
    Allowed values: - basic - bearer Defaults to basic.
    configureFlow string
    friendlyName string
    fromNumber string
    mapping string
    name string
    smsProvider string
    Allowed values: - twilio - generic Defaults to twilio.
    stageAuthenticatorSmsId string
    verifyOnly boolean
    Defaults to false.
    account_sid str
    auth str
    auth_password str
    auth_type str
    Allowed values: - basic - bearer Defaults to basic.
    configure_flow str
    friendly_name str
    from_number str
    mapping str
    name str
    sms_provider str
    Allowed values: - twilio - generic Defaults to twilio.
    stage_authenticator_sms_id str
    verify_only bool
    Defaults to false.
    accountSid String
    auth String
    authPassword String
    authType String
    Allowed values: - basic - bearer Defaults to basic.
    configureFlow String
    friendlyName String
    fromNumber String
    mapping String
    name String
    smsProvider String
    Allowed values: - twilio - generic Defaults to twilio.
    stageAuthenticatorSmsId String
    verifyOnly Boolean
    Defaults to false.

    Package Details

    Repository
    authentik goauthentik/terraform-provider-authentik
    License
    Notes
    This Pulumi package is based on the authentik Terraform Provider.
    authentik logo
    authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
    goauthentik/terraform-provider-authentik