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

ibm.getAppidCloudDirectoryTemplate

Explore with Pulumi AI

Retrieve information about an IBM Cloud AppID Management Services Cloud Directory Email Template. For more information, see customizing emails

Example Usage

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

const tpl = ibm.getAppidCloudDirectoryTemplate({
    tenantId: _var.tenant_id,
    templateName: "USER_VERIFICATION",
});
Copy
import pulumi
import pulumi_ibm as ibm

tpl = ibm.get_appid_cloud_directory_template(tenant_id=var["tenant_id"],
    template_name="USER_VERIFICATION")
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.LookupAppidCloudDirectoryTemplate(ctx, &ibm.LookupAppidCloudDirectoryTemplateArgs{
			TenantId:     _var.Tenant_id,
			TemplateName: "USER_VERIFICATION",
		}, 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 tpl = Ibm.GetAppidCloudDirectoryTemplate.Invoke(new()
    {
        TenantId = @var.Tenant_id,
        TemplateName = "USER_VERIFICATION",
    });

});
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.GetAppidCloudDirectoryTemplateArgs;
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 tpl = IbmFunctions.getAppidCloudDirectoryTemplate(GetAppidCloudDirectoryTemplateArgs.builder()
            .tenantId(var_.tenant_id())
            .templateName("USER_VERIFICATION")
            .build());

    }
}
Copy
variables:
  tpl:
    fn::invoke:
      function: ibm:getAppidCloudDirectoryTemplate
      arguments:
        tenantId: ${var.tenant_id}
        templateName: USER_VERIFICATION
Copy

Using getAppidCloudDirectoryTemplate

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 getAppidCloudDirectoryTemplate(args: GetAppidCloudDirectoryTemplateArgs, opts?: InvokeOptions): Promise<GetAppidCloudDirectoryTemplateResult>
function getAppidCloudDirectoryTemplateOutput(args: GetAppidCloudDirectoryTemplateOutputArgs, opts?: InvokeOptions): Output<GetAppidCloudDirectoryTemplateResult>
Copy
def get_appid_cloud_directory_template(id: Optional[str] = None,
                                       language: Optional[str] = None,
                                       template_name: Optional[str] = None,
                                       tenant_id: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetAppidCloudDirectoryTemplateResult
def get_appid_cloud_directory_template_output(id: Optional[pulumi.Input[str]] = None,
                                       language: Optional[pulumi.Input[str]] = None,
                                       template_name: Optional[pulumi.Input[str]] = None,
                                       tenant_id: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetAppidCloudDirectoryTemplateResult]
Copy
func LookupAppidCloudDirectoryTemplate(ctx *Context, args *LookupAppidCloudDirectoryTemplateArgs, opts ...InvokeOption) (*LookupAppidCloudDirectoryTemplateResult, error)
func LookupAppidCloudDirectoryTemplateOutput(ctx *Context, args *LookupAppidCloudDirectoryTemplateOutputArgs, opts ...InvokeOption) LookupAppidCloudDirectoryTemplateResultOutput
Copy

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

public static class GetAppidCloudDirectoryTemplate 
{
    public static Task<GetAppidCloudDirectoryTemplateResult> InvokeAsync(GetAppidCloudDirectoryTemplateArgs args, InvokeOptions? opts = null)
    public static Output<GetAppidCloudDirectoryTemplateResult> Invoke(GetAppidCloudDirectoryTemplateInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAppidCloudDirectoryTemplateResult> getAppidCloudDirectoryTemplate(GetAppidCloudDirectoryTemplateArgs args, InvokeOptions options)
public static Output<GetAppidCloudDirectoryTemplateResult> getAppidCloudDirectoryTemplate(GetAppidCloudDirectoryTemplateArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getAppidCloudDirectoryTemplate:getAppidCloudDirectoryTemplate
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

TemplateName This property is required. string
The type of email template. This can be USER_VERIFICATION, WELCOME, PASSWORD_CHANGED, RESET_PASSWORD or MFA_VERIFICATION
TenantId This property is required. string
The AppID instance GUID
Id string
Language string
Preferred language for resource. Format as described at RFC5646. Default: en
TemplateName This property is required. string
The type of email template. This can be USER_VERIFICATION, WELCOME, PASSWORD_CHANGED, RESET_PASSWORD or MFA_VERIFICATION
TenantId This property is required. string
The AppID instance GUID
Id string
Language string
Preferred language for resource. Format as described at RFC5646. Default: en
templateName This property is required. String
The type of email template. This can be USER_VERIFICATION, WELCOME, PASSWORD_CHANGED, RESET_PASSWORD or MFA_VERIFICATION
tenantId This property is required. String
The AppID instance GUID
id String
language String
Preferred language for resource. Format as described at RFC5646. Default: en
templateName This property is required. string
The type of email template. This can be USER_VERIFICATION, WELCOME, PASSWORD_CHANGED, RESET_PASSWORD or MFA_VERIFICATION
tenantId This property is required. string
The AppID instance GUID
id string
language string
Preferred language for resource. Format as described at RFC5646. Default: en
template_name This property is required. str
The type of email template. This can be USER_VERIFICATION, WELCOME, PASSWORD_CHANGED, RESET_PASSWORD or MFA_VERIFICATION
tenant_id This property is required. str
The AppID instance GUID
id str
language str
Preferred language for resource. Format as described at RFC5646. Default: en
templateName This property is required. String
The type of email template. This can be USER_VERIFICATION, WELCOME, PASSWORD_CHANGED, RESET_PASSWORD or MFA_VERIFICATION
tenantId This property is required. String
The AppID instance GUID
id String
language String
Preferred language for resource. Format as described at RFC5646. Default: en

getAppidCloudDirectoryTemplate Result

The following output properties are available:

Base64EncodedHtmlBody string
(String) The HTML body of the email encoded in Base64
HtmlBody string
(String) The HTML body of the email
Id string
PlainTextBody string
(String) The text body of the email
Subject string
(String) The subject of the email
TemplateName string
TenantId string
Language string
Base64EncodedHtmlBody string
(String) The HTML body of the email encoded in Base64
HtmlBody string
(String) The HTML body of the email
Id string
PlainTextBody string
(String) The text body of the email
Subject string
(String) The subject of the email
TemplateName string
TenantId string
Language string
base64EncodedHtmlBody String
(String) The HTML body of the email encoded in Base64
htmlBody String
(String) The HTML body of the email
id String
plainTextBody String
(String) The text body of the email
subject String
(String) The subject of the email
templateName String
tenantId String
language String
base64EncodedHtmlBody string
(String) The HTML body of the email encoded in Base64
htmlBody string
(String) The HTML body of the email
id string
plainTextBody string
(String) The text body of the email
subject string
(String) The subject of the email
templateName string
tenantId string
language string
base64_encoded_html_body str
(String) The HTML body of the email encoded in Base64
html_body str
(String) The HTML body of the email
id str
plain_text_body str
(String) The text body of the email
subject str
(String) The subject of the email
template_name str
tenant_id str
language str
base64EncodedHtmlBody String
(String) The HTML body of the email encoded in Base64
htmlBody String
(String) The HTML body of the email
id String
plainTextBody String
(String) The text body of the email
subject String
(String) The subject of the email
templateName String
tenantId String
language String

Package Details

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