1. Packages
  2. Ibm Provider
  3. API Docs
  4. getAppidMfaChannel
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getAppidMfaChannel

Explore with Pulumi AI

Retrieve an IBM Cloud AppID Management Services MFA channel configuration. For more information, see multifactor authentication

Example Usage

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

const mf = ibm.getAppidMfaChannel({
    tenantId: _var.tenant_id,
});
Copy
import pulumi
import pulumi_ibm as ibm

mf = ibm.get_appid_mfa_channel(tenant_id=var["tenant_id"])
Copy
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.LookupAppidMfaChannel(ctx, &ibm.LookupAppidMfaChannelArgs{
			TenantId: _var.Tenant_id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var mf = Ibm.GetAppidMfaChannel.Invoke(new()
    {
        TenantId = @var.Tenant_id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetAppidMfaChannelArgs;
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) {
        final var mf = IbmFunctions.getAppidMfaChannel(GetAppidMfaChannelArgs.builder()
            .tenantId(var_.tenant_id())
            .build());

    }
}
Copy
variables:
  mf:
    fn::invoke:
      function: ibm:getAppidMfaChannel
      arguments:
        tenantId: ${var.tenant_id}
Copy

Using getAppidMfaChannel

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAppidMfaChannel(args: GetAppidMfaChannelArgs, opts?: InvokeOptions): Promise<GetAppidMfaChannelResult>
function getAppidMfaChannelOutput(args: GetAppidMfaChannelOutputArgs, opts?: InvokeOptions): Output<GetAppidMfaChannelResult>
Copy
def get_appid_mfa_channel(id: Optional[str] = None,
                          tenant_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetAppidMfaChannelResult
def get_appid_mfa_channel_output(id: Optional[pulumi.Input[str]] = None,
                          tenant_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetAppidMfaChannelResult]
Copy
func LookupAppidMfaChannel(ctx *Context, args *LookupAppidMfaChannelArgs, opts ...InvokeOption) (*LookupAppidMfaChannelResult, error)
func LookupAppidMfaChannelOutput(ctx *Context, args *LookupAppidMfaChannelOutputArgs, opts ...InvokeOption) LookupAppidMfaChannelResultOutput
Copy

> Note: This function is named LookupAppidMfaChannel in the Go SDK.

public static class GetAppidMfaChannel 
{
    public static Task<GetAppidMfaChannelResult> InvokeAsync(GetAppidMfaChannelArgs args, InvokeOptions? opts = null)
    public static Output<GetAppidMfaChannelResult> Invoke(GetAppidMfaChannelInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAppidMfaChannelResult> getAppidMfaChannel(GetAppidMfaChannelArgs args, InvokeOptions options)
public static Output<GetAppidMfaChannelResult> getAppidMfaChannel(GetAppidMfaChannelArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getAppidMfaChannel:getAppidMfaChannel
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

TenantId This property is required. string
The AppID instance GUID
Id string
TenantId This property is required. string
The AppID instance GUID
Id string
tenantId This property is required. String
The AppID instance GUID
id String
tenantId This property is required. string
The AppID instance GUID
id string
tenant_id This property is required. str
The AppID instance GUID
id str
tenantId This property is required. String
The AppID instance GUID
id String

getAppidMfaChannel Result

The following output properties are available:

Active string
(String) Shows which channel is currently active, possible values: email, sms
Id string
SmsConfigs List<GetAppidMfaChannelSmsConfig>
(List of Object, Max: 1) SMS channel configuration
TenantId string
Active string
(String) Shows which channel is currently active, possible values: email, sms
Id string
SmsConfigs []GetAppidMfaChannelSmsConfig
(List of Object, Max: 1) SMS channel configuration
TenantId string
active String
(String) Shows which channel is currently active, possible values: email, sms
id String
smsConfigs List<GetAppidMfaChannelSmsConfig>
(List of Object, Max: 1) SMS channel configuration
tenantId String
active string
(String) Shows which channel is currently active, possible values: email, sms
id string
smsConfigs GetAppidMfaChannelSmsConfig[]
(List of Object, Max: 1) SMS channel configuration
tenantId string
active str
(String) Shows which channel is currently active, possible values: email, sms
id str
sms_configs Sequence[GetAppidMfaChannelSmsConfig]
(List of Object, Max: 1) SMS channel configuration
tenant_id str
active String
(String) Shows which channel is currently active, possible values: email, sms
id String
smsConfigs List<Property Map>
(List of Object, Max: 1) SMS channel configuration
tenantId String

Supporting Types

GetAppidMfaChannelSmsConfig

From This property is required. string
(String) Sender's phone number
Key This property is required. string
(String) API key
Secret This property is required. string
(String) API secret
From This property is required. string
(String) Sender's phone number
Key This property is required. string
(String) API key
Secret This property is required. string
(String) API secret
from This property is required. String
(String) Sender's phone number
key This property is required. String
(String) API key
secret This property is required. String
(String) API secret
from This property is required. string
(String) Sender's phone number
key This property is required. string
(String) API key
secret This property is required. string
(String) API secret
from_ This property is required. str
(String) Sender's phone number
key This property is required. str
(String) API key
secret This property is required. str
(String) API secret
from This property is required. String
(String) Sender's phone number
key This property is required. String
(String) API key
secret This property is required. String
(String) API secret

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.