Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. AppidMfaChannel
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.AppidMfaChannel

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create, update, or delete an IBM Cloud AppID Management Services MFA Channel resource. For more information, see multifactor authentication

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const mf = new ibm.AppidMfaChannel("mf", {
    tenantId: _var.tenant_id,
    active: "sms",
    smsConfigs: [{
        key: "<nexmo key>",
        secret: "<nexmo secret>",
        from: "+11112223333",
    }],
});

    import pulumi
import pulumi_ibm as ibm

mf = ibm.AppidMfaChannel("mf",
    tenant_id=var["tenant_id"],
    active="sms",
    sms_configs=[{
        "key": "<nexmo key>",
        "secret": "<nexmo secret>",
        "from_": "+11112223333",
    }])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewAppidMfaChannel(ctx, "mf", &ibm.AppidMfaChannelArgs{
			TenantId: pulumi.Any(_var.Tenant_id),
			Active:   pulumi.String("sms"),
			SmsConfigs: ibm.AppidMfaChannelSmsConfigArray{
				&ibm.AppidMfaChannelSmsConfigArgs{
					Key:    pulumi.String("<nexmo key>"),
					Secret: pulumi.String("<nexmo secret>"),
					From:   pulumi.String("+11112223333"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var mf = new Ibm.AppidMfaChannel("mf", new()
    {
        TenantId = @var.Tenant_id,
        Active = "sms",
        SmsConfigs = new[]
        {
            new Ibm.Inputs.AppidMfaChannelSmsConfigArgs
            {
                Key = "<nexmo key>",
                Secret = "<nexmo secret>",
                From = "+11112223333",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.AppidMfaChannel;
import com.pulumi.ibm.AppidMfaChannelArgs;
import com.pulumi.ibm.inputs.AppidMfaChannelSmsConfigArgs;
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 mf = new AppidMfaChannel("mf", AppidMfaChannelArgs.builder()
            .tenantId(var_.tenant_id())
            .active("sms")
            .smsConfigs(AppidMfaChannelSmsConfigArgs.builder()
                .key("<nexmo key>")
                .secret("<nexmo secret>")
                .from("+11112223333")
                .build())
            .build());

    }
}

    resources:
  mf:
    type: ibm:AppidMfaChannel
    properties:
      tenantId: ${var.tenant_id}
      active: sms
      smsConfigs:
        - key: <nexmo key>
          secret: <nexmo secret>
          from: '+11112223333'

    Create AppidMfaChannel Resource

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

    Constructor syntax

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

@overload
def AppidMfaChannel(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    active: Optional[str] = None,
                    tenant_id: Optional[str] = None,
                    appid_mfa_channel_id: Optional[str] = None,
                    sms_configs: Optional[Sequence[AppidMfaChannelSmsConfigArgs]] = None)
    func NewAppidMfaChannel(ctx *Context, name string, args AppidMfaChannelArgs, opts ...ResourceOption) (*AppidMfaChannel, error)
    public AppidMfaChannel(string name, AppidMfaChannelArgs args, CustomResourceOptions? opts = null)
    public AppidMfaChannel(String name, AppidMfaChannelArgs args)
public AppidMfaChannel(String name, AppidMfaChannelArgs args, CustomResourceOptions options)

    type: ibm:AppidMfaChannel
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 AppidMfaChannelArgs
    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 AppidMfaChannelArgs
    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 AppidMfaChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppidMfaChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppidMfaChannelArgs
    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 appidMfaChannelResource = new Ibm.AppidMfaChannel("appidMfaChannelResource", new()
{
    Active = "string",
    TenantId = "string",
    AppidMfaChannelId = "string",
    SmsConfigs = new[]
    {
        new Ibm.Inputs.AppidMfaChannelSmsConfigArgs
        {
            From = "string",
            Key = "string",
            Secret = "string",
        },
    },
});

    example, err := ibm.NewAppidMfaChannel(ctx, "appidMfaChannelResource", &ibm.AppidMfaChannelArgs{
	Active:            pulumi.String("string"),
	TenantId:          pulumi.String("string"),
	AppidMfaChannelId: pulumi.String("string"),
	SmsConfigs: ibm.AppidMfaChannelSmsConfigArray{
		&ibm.AppidMfaChannelSmsConfigArgs{
			From:   pulumi.String("string"),
			Key:    pulumi.String("string"),
			Secret: pulumi.String("string"),
		},
	},
})

    var appidMfaChannelResource = new AppidMfaChannel("appidMfaChannelResource", AppidMfaChannelArgs.builder()
    .active("string")
    .tenantId("string")
    .appidMfaChannelId("string")
    .smsConfigs(AppidMfaChannelSmsConfigArgs.builder()
        .from("string")
        .key("string")
        .secret("string")
        .build())
    .build());

    appid_mfa_channel_resource = ibm.AppidMfaChannel("appidMfaChannelResource",
    active="string",
    tenant_id="string",
    appid_mfa_channel_id="string",
    sms_configs=[{
        "from_": "string",
        "key": "string",
        "secret": "string",
    }])

    const appidMfaChannelResource = new ibm.AppidMfaChannel("appidMfaChannelResource", {
    active: "string",
    tenantId: "string",
    appidMfaChannelId: "string",
    smsConfigs: [{
        from: "string",
        key: "string",
        secret: "string",
    }],
});

    type: ibm:AppidMfaChannel
properties:
    active: string
    appidMfaChannelId: string
    smsConfigs:
        - from: string
          key: string
          secret: string
    tenantId: string

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

    Active string
    Determines which channel is currently active, allowed values: email, sms. Note: in addition, AppID MFA should be enabled, see ibm.AppidMfa resource
    TenantId string
    The AppID instance GUID
    AppidMfaChannelId string
    SmsConfigs List<AppidMfaChannelSmsConfig>

    SMS channel configuration. After signing up for a Vonage account, you can get your API key and secret on the dashboard.

    Nested scheme for sms_config:

    Active string
    Determines which channel is currently active, allowed values: email, sms. Note: in addition, AppID MFA should be enabled, see ibm.AppidMfa resource
    TenantId string
    The AppID instance GUID
    AppidMfaChannelId string
    SmsConfigs []AppidMfaChannelSmsConfigArgs

    SMS channel configuration. After signing up for a Vonage account, you can get your API key and secret on the dashboard.

    Nested scheme for sms_config:

    active String
    Determines which channel is currently active, allowed values: email, sms. Note: in addition, AppID MFA should be enabled, see ibm.AppidMfa resource
    tenantId String
    The AppID instance GUID
    appidMfaChannelId String
    smsConfigs List<AppidMfaChannelSmsConfig>

    SMS channel configuration. After signing up for a Vonage account, you can get your API key and secret on the dashboard.

    Nested scheme for sms_config:

    active string
    Determines which channel is currently active, allowed values: email, sms. Note: in addition, AppID MFA should be enabled, see ibm.AppidMfa resource
    tenantId string
    The AppID instance GUID
    appidMfaChannelId string
    smsConfigs AppidMfaChannelSmsConfig[]

    SMS channel configuration. After signing up for a Vonage account, you can get your API key and secret on the dashboard.

    Nested scheme for sms_config:

    active str
    Determines which channel is currently active, allowed values: email, sms. Note: in addition, AppID MFA should be enabled, see ibm.AppidMfa resource
    tenant_id str
    The AppID instance GUID
    appid_mfa_channel_id str
    sms_configs Sequence[AppidMfaChannelSmsConfigArgs]

    SMS channel configuration. After signing up for a Vonage account, you can get your API key and secret on the dashboard.

    Nested scheme for sms_config:

    active String
    Determines which channel is currently active, allowed values: email, sms. Note: in addition, AppID MFA should be enabled, see ibm.AppidMfa resource
    tenantId String
    The AppID instance GUID
    appidMfaChannelId String
    smsConfigs List<Property Map>

    SMS channel configuration. After signing up for a Vonage account, you can get your API key and secret on the dashboard.

    Nested scheme for sms_config:

    Outputs

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

    Get an existing AppidMfaChannel 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?: AppidMfaChannelState, opts?: CustomResourceOptions): AppidMfaChannel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[str] = None,
        appid_mfa_channel_id: Optional[str] = None,
        sms_configs: Optional[Sequence[AppidMfaChannelSmsConfigArgs]] = None,
        tenant_id: Optional[str] = None) -> AppidMfaChannel
    func GetAppidMfaChannel(ctx *Context, name string, id IDInput, state *AppidMfaChannelState, opts ...ResourceOption) (*AppidMfaChannel, error)
    public static AppidMfaChannel Get(string name, Input<string> id, AppidMfaChannelState? state, CustomResourceOptions? opts = null)
    public static AppidMfaChannel get(String name, Output<String> id, AppidMfaChannelState state, CustomResourceOptions options)
    resources:  _:    type: ibm:AppidMfaChannel    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:
    Active string
    Determines which channel is currently active, allowed values: email, sms. Note: in addition, AppID MFA should be enabled, see ibm.AppidMfa resource
    AppidMfaChannelId string
    SmsConfigs List<AppidMfaChannelSmsConfig>

    SMS channel configuration. After signing up for a Vonage account, you can get your API key and secret on the dashboard.

    Nested scheme for sms_config:

    TenantId string
    The AppID instance GUID
    Active string
    Determines which channel is currently active, allowed values: email, sms. Note: in addition, AppID MFA should be enabled, see ibm.AppidMfa resource
    AppidMfaChannelId string
    SmsConfigs []AppidMfaChannelSmsConfigArgs

    SMS channel configuration. After signing up for a Vonage account, you can get your API key and secret on the dashboard.

    Nested scheme for sms_config:

    TenantId string
    The AppID instance GUID
    active String
    Determines which channel is currently active, allowed values: email, sms. Note: in addition, AppID MFA should be enabled, see ibm.AppidMfa resource
    appidMfaChannelId String
    smsConfigs List<AppidMfaChannelSmsConfig>

    SMS channel configuration. After signing up for a Vonage account, you can get your API key and secret on the dashboard.

    Nested scheme for sms_config:

    tenantId String
    The AppID instance GUID
    active string
    Determines which channel is currently active, allowed values: email, sms. Note: in addition, AppID MFA should be enabled, see ibm.AppidMfa resource
    appidMfaChannelId string
    smsConfigs AppidMfaChannelSmsConfig[]

    SMS channel configuration. After signing up for a Vonage account, you can get your API key and secret on the dashboard.

    Nested scheme for sms_config:

    tenantId string
    The AppID instance GUID
    active str
    Determines which channel is currently active, allowed values: email, sms. Note: in addition, AppID MFA should be enabled, see ibm.AppidMfa resource
    appid_mfa_channel_id str
    sms_configs Sequence[AppidMfaChannelSmsConfigArgs]

    SMS channel configuration. After signing up for a Vonage account, you can get your API key and secret on the dashboard.

    Nested scheme for sms_config:

    tenant_id str
    The AppID instance GUID
    active String
    Determines which channel is currently active, allowed values: email, sms. Note: in addition, AppID MFA should be enabled, see ibm.AppidMfa resource
    appidMfaChannelId String
    smsConfigs List<Property Map>

    SMS channel configuration. After signing up for a Vonage account, you can get your API key and secret on the dashboard.

    Nested scheme for sms_config:

    tenantId String
    The AppID instance GUID

    Supporting Types

    AppidMfaChannelSmsConfig, AppidMfaChannelSmsConfigArgs

    From string
    Sender's phone number
    Key string
    API key
    Secret string
    API secret
    From string
    Sender's phone number
    Key string
    API key
    Secret string
    API secret
    from String
    Sender's phone number
    key String
    API key
    secret String
    API secret
    from string
    Sender's phone number
    key string
    API key
    secret string
    API secret
    from_ str
    Sender's phone number
    key str
    API key
    secret str
    API secret
    from String
    Sender's phone number
    key String
    API key
    secret String
    API secret

    Import

    The ibm_appid_mfa_channel resource can be imported by using the AppID tenant ID.

    Syntax

    bash

    $ pulumi import ibm:index/appidMfaChannel:AppidMfaChannel mf <tenant_id>

    Example

    bash

    $ pulumi import ibm:index/appidMfaChannel:AppidMfaChannel mf 5fa344a8-d361-4bc2-9051-58ca253f4b2b

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm