1. Packages
  2. Ibm Provider
  3. API Docs
  4. AppidMfa
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.AppidMfa

Explore with Pulumi AI

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

    Create, update, or delete an IBM Cloud AppID Management Services MFA 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.AppidMfa("mf", {
        tenantId: _var.tenant_id,
        isActive: true,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    mf = ibm.AppidMfa("mf",
        tenant_id=var["tenant_id"],
        is_active=True)
    
    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.NewAppidMfa(ctx, "mf", &ibm.AppidMfaArgs{
    			TenantId: pulumi.Any(_var.Tenant_id),
    			IsActive: pulumi.Bool(true),
    		})
    		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.AppidMfa("mf", new()
        {
            TenantId = @var.Tenant_id,
            IsActive = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.AppidMfa;
    import com.pulumi.ibm.AppidMfaArgs;
    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 AppidMfa("mf", AppidMfaArgs.builder()
                .tenantId(var_.tenant_id())
                .isActive(true)
                .build());
    
        }
    }
    
    resources:
      mf:
        type: ibm:AppidMfa
        properties:
          tenantId: ${var.tenant_id}
          isActive: true
    

    Create AppidMfa Resource

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

    Constructor syntax

    new AppidMfa(name: string, args: AppidMfaArgs, opts?: CustomResourceOptions);
    @overload
    def AppidMfa(resource_name: str,
                 args: AppidMfaArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def AppidMfa(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 is_active: Optional[bool] = None,
                 tenant_id: Optional[str] = None,
                 appid_mfa_id: Optional[str] = None)
    func NewAppidMfa(ctx *Context, name string, args AppidMfaArgs, opts ...ResourceOption) (*AppidMfa, error)
    public AppidMfa(string name, AppidMfaArgs args, CustomResourceOptions? opts = null)
    public AppidMfa(String name, AppidMfaArgs args)
    public AppidMfa(String name, AppidMfaArgs args, CustomResourceOptions options)
    
    type: ibm:AppidMfa
    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 AppidMfaArgs
    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 AppidMfaArgs
    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 AppidMfaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppidMfaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppidMfaArgs
    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 appidMfaResource = new Ibm.AppidMfa("appidMfaResource", new()
    {
        IsActive = false,
        TenantId = "string",
        AppidMfaId = "string",
    });
    
    example, err := ibm.NewAppidMfa(ctx, "appidMfaResource", &ibm.AppidMfaArgs{
    	IsActive:   pulumi.Bool(false),
    	TenantId:   pulumi.String("string"),
    	AppidMfaId: pulumi.String("string"),
    })
    
    var appidMfaResource = new AppidMfa("appidMfaResource", AppidMfaArgs.builder()
        .isActive(false)
        .tenantId("string")
        .appidMfaId("string")
        .build());
    
    appid_mfa_resource = ibm.AppidMfa("appidMfaResource",
        is_active=False,
        tenant_id="string",
        appid_mfa_id="string")
    
    const appidMfaResource = new ibm.AppidMfa("appidMfaResource", {
        isActive: false,
        tenantId: "string",
        appidMfaId: "string",
    });
    
    type: ibm:AppidMfa
    properties:
        appidMfaId: string
        isActive: false
        tenantId: string
    

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

    IsActive bool
    true if MFA should be enabled
    TenantId string
    The AppID instance GUID
    AppidMfaId string
    IsActive bool
    true if MFA should be enabled
    TenantId string
    The AppID instance GUID
    AppidMfaId string
    isActive Boolean
    true if MFA should be enabled
    tenantId String
    The AppID instance GUID
    appidMfaId String
    isActive boolean
    true if MFA should be enabled
    tenantId string
    The AppID instance GUID
    appidMfaId string
    is_active bool
    true if MFA should be enabled
    tenant_id str
    The AppID instance GUID
    appid_mfa_id str
    isActive Boolean
    true if MFA should be enabled
    tenantId String
    The AppID instance GUID
    appidMfaId String

    Outputs

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

    Get an existing AppidMfa 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?: AppidMfaState, opts?: CustomResourceOptions): AppidMfa
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            appid_mfa_id: Optional[str] = None,
            is_active: Optional[bool] = None,
            tenant_id: Optional[str] = None) -> AppidMfa
    func GetAppidMfa(ctx *Context, name string, id IDInput, state *AppidMfaState, opts ...ResourceOption) (*AppidMfa, error)
    public static AppidMfa Get(string name, Input<string> id, AppidMfaState? state, CustomResourceOptions? opts = null)
    public static AppidMfa get(String name, Output<String> id, AppidMfaState state, CustomResourceOptions options)
    resources:  _:    type: ibm:AppidMfa    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:
    AppidMfaId string
    IsActive bool
    true if MFA should be enabled
    TenantId string
    The AppID instance GUID
    AppidMfaId string
    IsActive bool
    true if MFA should be enabled
    TenantId string
    The AppID instance GUID
    appidMfaId String
    isActive Boolean
    true if MFA should be enabled
    tenantId String
    The AppID instance GUID
    appidMfaId string
    isActive boolean
    true if MFA should be enabled
    tenantId string
    The AppID instance GUID
    appid_mfa_id str
    is_active bool
    true if MFA should be enabled
    tenant_id str
    The AppID instance GUID
    appidMfaId String
    isActive Boolean
    true if MFA should be enabled
    tenantId String
    The AppID instance GUID

    Import

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

    Syntax

    bash

    $ pulumi import ibm:index/appidMfa:AppidMfa mf <tenant_id>
    

    Example

    bash

    $ pulumi import ibm:index/appidMfa:AppidMfa 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