Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
  3. API Docs
  4. PhoneProvider
Auth0 v3.16.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-auth0

auth0.PhoneProvider

Explore with Pulumi AI

auth0 logo
Auth0 v3.16.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-auth0

    Auth0 allows you to configure your own phone messaging provider to help you manage, monitor, and troubleshoot your SMS and voice communications. You can only configure one phone provider for all SMS and voice communications per tenant.

    !> This resource manages to create a max of 1 phone provider for a tenant. To avoid potential issues, it is recommended not to try creating multiple phone providers on the same tenant.

    !> If you are using the auth0.PhoneProvider resource to create a custom phone provider, you must ensure an action is created first with custom-phone-provider as the supported_triggers

    Example Usage

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

// This is an example on how to set up the phone provider with Twilio.
const twilioPhoneProvider = new auth0.PhoneProvider("twilio_phone_provider", {
    name: "twilio",
    disabled: false,
    credentials: {
        authToken: "secretAuthToken",
    },
    configuration: {
        deliveryMethods: [
            "text",
            "voice",
        ],
        defaultFrom: "+1234567890",
        sid: "ACXXXXXXXXXXXXXXXX",
        mssid: "MSXXXXXXXXXXXXXXXX",
    },
});
// This is an example on how to set up the phone provider with a custom action.
// Make sure a corresponding action exists with custom-phone-provider as supported triggers
const sendCustomPhone = new auth0.Action("send_custom_phone", {
    name: "Custom Phone Provider",
    runtime: "node18",
    deploy: true,
    code: `/**
 * Handler to be executed while sending a phone notification
 * @param {Event} event - Details about the user and the context in which they are logging in.
 * @param {CustomPhoneProviderAPI} api - Methods and utilities to help change the behavior of sending a phone notification.
 */
exports.onExecuteCustomPhoneProvider = async (event, api) => {
    // Code goes here
    return;
};
`,
    supportedTriggers: {
        id: "custom-phone-provider",
        version: "v1",
    },
});
const customPhoneProvider = new auth0.PhoneProvider("custom_phone_provider", {
    name: "custom",
    disabled: false,
    configuration: {
        deliveryMethods: [
            "text",
            "voice",
        ],
    },
    credentials: {},
}, {
    dependsOn: [sendCustomPhone],
});

    import pulumi
import pulumi_auth0 as auth0

# This is an example on how to set up the phone provider with Twilio.
twilio_phone_provider = auth0.PhoneProvider("twilio_phone_provider",
    name="twilio",
    disabled=False,
    credentials={
        "auth_token": "secretAuthToken",
    },
    configuration={
        "delivery_methods": [
            "text",
            "voice",
        ],
        "default_from": "+1234567890",
        "sid": "ACXXXXXXXXXXXXXXXX",
        "mssid": "MSXXXXXXXXXXXXXXXX",
    })
# This is an example on how to set up the phone provider with a custom action.
# Make sure a corresponding action exists with custom-phone-provider as supported triggers
send_custom_phone = auth0.Action("send_custom_phone",
    name="Custom Phone Provider",
    runtime="node18",
    deploy=True,
    code="""/**
 * Handler to be executed while sending a phone notification
 * @param {Event} event - Details about the user and the context in which they are logging in.
 * @param {CustomPhoneProviderAPI} api - Methods and utilities to help change the behavior of sending a phone notification.
 */
exports.onExecuteCustomPhoneProvider = async (event, api) => {
    // Code goes here
    return;
};
""",
    supported_triggers={
        "id": "custom-phone-provider",
        "version": "v1",
    })
custom_phone_provider = auth0.PhoneProvider("custom_phone_provider",
    name="custom",
    disabled=False,
    configuration={
        "delivery_methods": [
            "text",
            "voice",
        ],
    },
    credentials={},
    opts = pulumi.ResourceOptions(depends_on=[send_custom_phone]))

    package main

import (
	"github.com/pulumi/pulumi-auth0/sdk/v3/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// This is an example on how to set up the phone provider with Twilio.
		_, err := auth0.NewPhoneProvider(ctx, "twilio_phone_provider", &auth0.PhoneProviderArgs{
			Name:     pulumi.String("twilio"),
			Disabled: pulumi.Bool(false),
			Credentials: &auth0.PhoneProviderCredentialsArgs{
				AuthToken: pulumi.String("secretAuthToken"),
			},
			Configuration: &auth0.PhoneProviderConfigurationArgs{
				DeliveryMethods: pulumi.StringArray{
					pulumi.String("text"),
					pulumi.String("voice"),
				},
				DefaultFrom: pulumi.String("+1234567890"),
				Sid:         pulumi.String("ACXXXXXXXXXXXXXXXX"),
				Mssid:       pulumi.String("MSXXXXXXXXXXXXXXXX"),
			},
		})
		if err != nil {
			return err
		}
		// This is an example on how to set up the phone provider with a custom action.
		// Make sure a corresponding action exists with custom-phone-provider as supported triggers
		sendCustomPhone, err := auth0.NewAction(ctx, "send_custom_phone", &auth0.ActionArgs{
			Name:    pulumi.String("Custom Phone Provider"),
			Runtime: pulumi.String("node18"),
			Deploy:  pulumi.Bool(true),
			Code: pulumi.String(`/**
 * Handler to be executed while sending a phone notification
 * @param {Event} event - Details about the user and the context in which they are logging in.
 * @param {CustomPhoneProviderAPI} api - Methods and utilities to help change the behavior of sending a phone notification.
 */
exports.onExecuteCustomPhoneProvider = async (event, api) => {
    // Code goes here
    return;
};
`),
			SupportedTriggers: &auth0.ActionSupportedTriggersArgs{
				Id:      pulumi.String("custom-phone-provider"),
				Version: pulumi.String("v1"),
			},
		})
		if err != nil {
			return err
		}
		_, err = auth0.NewPhoneProvider(ctx, "custom_phone_provider", &auth0.PhoneProviderArgs{
			Name:     pulumi.String("custom"),
			Disabled: pulumi.Bool(false),
			Configuration: &auth0.PhoneProviderConfigurationArgs{
				DeliveryMethods: pulumi.StringArray{
					pulumi.String("text"),
					pulumi.String("voice"),
				},
			},
			Credentials: &auth0.PhoneProviderCredentialsArgs{},
		}, pulumi.DependsOn([]pulumi.Resource{
			sendCustomPhone,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // This is an example on how to set up the phone provider with Twilio.
    var twilioPhoneProvider = new Auth0.PhoneProvider("twilio_phone_provider", new()
    {
        Name = "twilio",
        Disabled = false,
        Credentials = new Auth0.Inputs.PhoneProviderCredentialsArgs
        {
            AuthToken = "secretAuthToken",
        },
        Configuration = new Auth0.Inputs.PhoneProviderConfigurationArgs
        {
            DeliveryMethods = new[]
            {
                "text",
                "voice",
            },
            DefaultFrom = "+1234567890",
            Sid = "ACXXXXXXXXXXXXXXXX",
            Mssid = "MSXXXXXXXXXXXXXXXX",
        },
    });

    // This is an example on how to set up the phone provider with a custom action.
    // Make sure a corresponding action exists with custom-phone-provider as supported triggers
    var sendCustomPhone = new Auth0.Action("send_custom_phone", new()
    {
        Name = "Custom Phone Provider",
        Runtime = "node18",
        Deploy = true,
        Code = @"/**
 * Handler to be executed while sending a phone notification
 * @param {Event} event - Details about the user and the context in which they are logging in.
 * @param {CustomPhoneProviderAPI} api - Methods and utilities to help change the behavior of sending a phone notification.
 */
exports.onExecuteCustomPhoneProvider = async (event, api) => {
    // Code goes here
    return;
};
",
        SupportedTriggers = new Auth0.Inputs.ActionSupportedTriggersArgs
        {
            Id = "custom-phone-provider",
            Version = "v1",
        },
    });

    var customPhoneProvider = new Auth0.PhoneProvider("custom_phone_provider", new()
    {
        Name = "custom",
        Disabled = false,
        Configuration = new Auth0.Inputs.PhoneProviderConfigurationArgs
        {
            DeliveryMethods = new[]
            {
                "text",
                "voice",
            },
        },
        Credentials = null,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            sendCustomPhone,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.PhoneProvider;
import com.pulumi.auth0.PhoneProviderArgs;
import com.pulumi.auth0.inputs.PhoneProviderCredentialsArgs;
import com.pulumi.auth0.inputs.PhoneProviderConfigurationArgs;
import com.pulumi.auth0.Action;
import com.pulumi.auth0.ActionArgs;
import com.pulumi.auth0.inputs.ActionSupportedTriggersArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
        // This is an example on how to set up the phone provider with Twilio.
        var twilioPhoneProvider = new PhoneProvider("twilioPhoneProvider", PhoneProviderArgs.builder()
            .name("twilio")
            .disabled(false)
            .credentials(PhoneProviderCredentialsArgs.builder()
                .authToken("secretAuthToken")
                .build())
            .configuration(PhoneProviderConfigurationArgs.builder()
                .deliveryMethods(                
                    "text",
                    "voice")
                .defaultFrom("+1234567890")
                .sid("ACXXXXXXXXXXXXXXXX")
                .mssid("MSXXXXXXXXXXXXXXXX")
                .build())
            .build());

        // This is an example on how to set up the phone provider with a custom action.
        // Make sure a corresponding action exists with custom-phone-provider as supported triggers
        var sendCustomPhone = new Action("sendCustomPhone", ActionArgs.builder()
            .name("Custom Phone Provider")
            .runtime("node18")
            .deploy(true)
            .code("""
/**
 * Handler to be executed while sending a phone notification
 * @param {Event} event - Details about the user and the context in which they are logging in.
 * @param {CustomPhoneProviderAPI} api - Methods and utilities to help change the behavior of sending a phone notification.
 */
exports.onExecuteCustomPhoneProvider = async (event, api) => {
    // Code goes here
    return;
};
            """)
            .supportedTriggers(ActionSupportedTriggersArgs.builder()
                .id("custom-phone-provider")
                .version("v1")
                .build())
            .build());

        var customPhoneProvider = new PhoneProvider("customPhoneProvider", PhoneProviderArgs.builder()
            .name("custom")
            .disabled(false)
            .configuration(PhoneProviderConfigurationArgs.builder()
                .deliveryMethods(                
                    "text",
                    "voice")
                .build())
            .credentials()
            .build(), CustomResourceOptions.builder()
                .dependsOn(sendCustomPhone)
                .build());

    }
}

    resources:
  # This is an example on how to set up the phone provider with Twilio.
  twilioPhoneProvider:
    type: auth0:PhoneProvider
    name: twilio_phone_provider
    properties:
      name: twilio
      disabled: false
      credentials:
        authToken: secretAuthToken
      configuration:
        deliveryMethods:
          - text
          - voice
        defaultFrom: '+1234567890'
        sid: ACXXXXXXXXXXXXXXXX
        mssid: MSXXXXXXXXXXXXXXXX
  # This is an example on how to set up the phone provider with a custom action.
  # Make sure a corresponding action exists with custom-phone-provider as supported triggers
  sendCustomPhone:
    type: auth0:Action
    name: send_custom_phone
    properties:
      name: Custom Phone Provider
      runtime: node18
      deploy: true
      code: |
        /**
         * Handler to be executed while sending a phone notification
         * @param {Event} event - Details about the user and the context in which they are logging in.
         * @param {CustomPhoneProviderAPI} api - Methods and utilities to help change the behavior of sending a phone notification.
         */
        exports.onExecuteCustomPhoneProvider = async (event, api) => {
            // Code goes here
            return;
        };        
      supportedTriggers:
        id: custom-phone-provider
        version: v1
  customPhoneProvider:
    type: auth0:PhoneProvider
    name: custom_phone_provider
    properties:
      name: custom
      disabled: false # Disable the default phone provider
      configuration:
        deliveryMethods:
          - text
          - voice
      credentials: {}
    options:
      dependsOn:
        - ${sendCustomPhone}

    Create PhoneProvider Resource

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

    Constructor syntax

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

@overload
def PhoneProvider(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  configuration: Optional[PhoneProviderConfigurationArgs] = None,
                  credentials: Optional[PhoneProviderCredentialsArgs] = None,
                  disabled: Optional[bool] = None,
                  name: Optional[str] = None)
    func NewPhoneProvider(ctx *Context, name string, args PhoneProviderArgs, opts ...ResourceOption) (*PhoneProvider, error)
    public PhoneProvider(string name, PhoneProviderArgs args, CustomResourceOptions? opts = null)
    public PhoneProvider(String name, PhoneProviderArgs args)
public PhoneProvider(String name, PhoneProviderArgs args, CustomResourceOptions options)

    type: auth0:PhoneProvider
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 PhoneProviderArgs
    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 PhoneProviderArgs
    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 PhoneProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PhoneProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PhoneProviderArgs
    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 phoneProviderResource = new Auth0.PhoneProvider("phoneProviderResource", new()
{
    Configuration = new Auth0.Inputs.PhoneProviderConfigurationArgs
    {
        DeliveryMethods = new[]
        {
            "string",
        },
        DefaultFrom = "string",
        Mssid = "string",
        Sid = "string",
    },
    Credentials = new Auth0.Inputs.PhoneProviderCredentialsArgs
    {
        AuthToken = "string",
    },
    Disabled = false,
    Name = "string",
});

    example, err := auth0.NewPhoneProvider(ctx, "phoneProviderResource", &auth0.PhoneProviderArgs{
	Configuration: &auth0.PhoneProviderConfigurationArgs{
		DeliveryMethods: pulumi.StringArray{
			pulumi.String("string"),
		},
		DefaultFrom: pulumi.String("string"),
		Mssid:       pulumi.String("string"),
		Sid:         pulumi.String("string"),
	},
	Credentials: &auth0.PhoneProviderCredentialsArgs{
		AuthToken: pulumi.String("string"),
	},
	Disabled: pulumi.Bool(false),
	Name:     pulumi.String("string"),
})

    var phoneProviderResource = new PhoneProvider("phoneProviderResource", PhoneProviderArgs.builder()
    .configuration(PhoneProviderConfigurationArgs.builder()
        .deliveryMethods("string")
        .defaultFrom("string")
        .mssid("string")
        .sid("string")
        .build())
    .credentials(PhoneProviderCredentialsArgs.builder()
        .authToken("string")
        .build())
    .disabled(false)
    .name("string")
    .build());

    phone_provider_resource = auth0.PhoneProvider("phoneProviderResource",
    configuration={
        "delivery_methods": ["string"],
        "default_from": "string",
        "mssid": "string",
        "sid": "string",
    },
    credentials={
        "auth_token": "string",
    },
    disabled=False,
    name="string")

    const phoneProviderResource = new auth0.PhoneProvider("phoneProviderResource", {
    configuration: {
        deliveryMethods: ["string"],
        defaultFrom: "string",
        mssid: "string",
        sid: "string",
    },
    credentials: {
        authToken: "string",
    },
    disabled: false,
    name: "string",
});

    type: auth0:PhoneProvider
properties:
    configuration:
        defaultFrom: string
        deliveryMethods:
            - string
        mssid: string
        sid: string
    credentials:
        authToken: string
    disabled: false
    name: string

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

    Configuration PhoneProviderConfiguration
    Specific phone provider settings.
    Credentials PhoneProviderCredentials
    Provider credentials required to use authenticate to the provider.
    Disabled bool
    Indicates whether the phone provider is enabled (false) or disabled (true).
    Name string
    Name of the phone provider. Options include twilio, custom.
    Configuration PhoneProviderConfigurationArgs
    Specific phone provider settings.
    Credentials PhoneProviderCredentialsArgs
    Provider credentials required to use authenticate to the provider.
    Disabled bool
    Indicates whether the phone provider is enabled (false) or disabled (true).
    Name string
    Name of the phone provider. Options include twilio, custom.
    configuration PhoneProviderConfiguration
    Specific phone provider settings.
    credentials PhoneProviderCredentials
    Provider credentials required to use authenticate to the provider.
    disabled Boolean
    Indicates whether the phone provider is enabled (false) or disabled (true).
    name String
    Name of the phone provider. Options include twilio, custom.
    configuration PhoneProviderConfiguration
    Specific phone provider settings.
    credentials PhoneProviderCredentials
    Provider credentials required to use authenticate to the provider.
    disabled boolean
    Indicates whether the phone provider is enabled (false) or disabled (true).
    name string
    Name of the phone provider. Options include twilio, custom.
    configuration PhoneProviderConfigurationArgs
    Specific phone provider settings.
    credentials PhoneProviderCredentialsArgs
    Provider credentials required to use authenticate to the provider.
    disabled bool
    Indicates whether the phone provider is enabled (false) or disabled (true).
    name str
    Name of the phone provider. Options include twilio, custom.
    configuration Property Map
    Specific phone provider settings.
    credentials Property Map
    Provider credentials required to use authenticate to the provider.
    disabled Boolean
    Indicates whether the phone provider is enabled (false) or disabled (true).
    name String
    Name of the phone provider. Options include twilio, custom.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PhoneProvider resource produces the following output properties:

    Channel string
    The channel of the phone provider.
    Id string
    The provider-assigned unique ID for this managed resource.
    Tenant string
    The tenant of the phone provider.
    Channel string
    The channel of the phone provider.
    Id string
    The provider-assigned unique ID for this managed resource.
    Tenant string
    The tenant of the phone provider.
    channel String
    The channel of the phone provider.
    id String
    The provider-assigned unique ID for this managed resource.
    tenant String
    The tenant of the phone provider.
    channel string
    The channel of the phone provider.
    id string
    The provider-assigned unique ID for this managed resource.
    tenant string
    The tenant of the phone provider.
    channel str
    The channel of the phone provider.
    id str
    The provider-assigned unique ID for this managed resource.
    tenant str
    The tenant of the phone provider.
    channel String
    The channel of the phone provider.
    id String
    The provider-assigned unique ID for this managed resource.
    tenant String
    The tenant of the phone provider.

    Look up Existing PhoneProvider Resource

    Get an existing PhoneProvider 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?: PhoneProviderState, opts?: CustomResourceOptions): PhoneProvider
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        channel: Optional[str] = None,
        configuration: Optional[PhoneProviderConfigurationArgs] = None,
        credentials: Optional[PhoneProviderCredentialsArgs] = None,
        disabled: Optional[bool] = None,
        name: Optional[str] = None,
        tenant: Optional[str] = None) -> PhoneProvider
    func GetPhoneProvider(ctx *Context, name string, id IDInput, state *PhoneProviderState, opts ...ResourceOption) (*PhoneProvider, error)
    public static PhoneProvider Get(string name, Input<string> id, PhoneProviderState? state, CustomResourceOptions? opts = null)
    public static PhoneProvider get(String name, Output<String> id, PhoneProviderState state, CustomResourceOptions options)
    resources:  _:    type: auth0:PhoneProvider    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:
    Channel string
    The channel of the phone provider.
    Configuration PhoneProviderConfiguration
    Specific phone provider settings.
    Credentials PhoneProviderCredentials
    Provider credentials required to use authenticate to the provider.
    Disabled bool
    Indicates whether the phone provider is enabled (false) or disabled (true).
    Name string
    Name of the phone provider. Options include twilio, custom.
    Tenant string
    The tenant of the phone provider.
    Channel string
    The channel of the phone provider.
    Configuration PhoneProviderConfigurationArgs
    Specific phone provider settings.
    Credentials PhoneProviderCredentialsArgs
    Provider credentials required to use authenticate to the provider.
    Disabled bool
    Indicates whether the phone provider is enabled (false) or disabled (true).
    Name string
    Name of the phone provider. Options include twilio, custom.
    Tenant string
    The tenant of the phone provider.
    channel String
    The channel of the phone provider.
    configuration PhoneProviderConfiguration
    Specific phone provider settings.
    credentials PhoneProviderCredentials
    Provider credentials required to use authenticate to the provider.
    disabled Boolean
    Indicates whether the phone provider is enabled (false) or disabled (true).
    name String
    Name of the phone provider. Options include twilio, custom.
    tenant String
    The tenant of the phone provider.
    channel string
    The channel of the phone provider.
    configuration PhoneProviderConfiguration
    Specific phone provider settings.
    credentials PhoneProviderCredentials
    Provider credentials required to use authenticate to the provider.
    disabled boolean
    Indicates whether the phone provider is enabled (false) or disabled (true).
    name string
    Name of the phone provider. Options include twilio, custom.
    tenant string
    The tenant of the phone provider.
    channel str
    The channel of the phone provider.
    configuration PhoneProviderConfigurationArgs
    Specific phone provider settings.
    credentials PhoneProviderCredentialsArgs
    Provider credentials required to use authenticate to the provider.
    disabled bool
    Indicates whether the phone provider is enabled (false) or disabled (true).
    name str
    Name of the phone provider. Options include twilio, custom.
    tenant str
    The tenant of the phone provider.
    channel String
    The channel of the phone provider.
    configuration Property Map
    Specific phone provider settings.
    credentials Property Map
    Provider credentials required to use authenticate to the provider.
    disabled Boolean
    Indicates whether the phone provider is enabled (false) or disabled (true).
    name String
    Name of the phone provider. Options include twilio, custom.
    tenant String
    The tenant of the phone provider.

    Supporting Types

    PhoneProviderConfiguration, PhoneProviderConfigurationArgs

    DeliveryMethods List<string>
    Media set supported by a given provider to deliver a notification
    DefaultFrom string
    Default sender subject as "from" when no other value is specified.
    Mssid string
    Twilio Messaging Service SID
    Sid string
    Twilio Account SID.
    DeliveryMethods []string
    Media set supported by a given provider to deliver a notification
    DefaultFrom string
    Default sender subject as "from" when no other value is specified.
    Mssid string
    Twilio Messaging Service SID
    Sid string
    Twilio Account SID.
    deliveryMethods List<String>
    Media set supported by a given provider to deliver a notification
    defaultFrom String
    Default sender subject as "from" when no other value is specified.
    mssid String
    Twilio Messaging Service SID
    sid String
    Twilio Account SID.
    deliveryMethods string[]
    Media set supported by a given provider to deliver a notification
    defaultFrom string
    Default sender subject as "from" when no other value is specified.
    mssid string
    Twilio Messaging Service SID
    sid string
    Twilio Account SID.
    delivery_methods Sequence[str]
    Media set supported by a given provider to deliver a notification
    default_from str
    Default sender subject as "from" when no other value is specified.
    mssid str
    Twilio Messaging Service SID
    sid str
    Twilio Account SID.
    deliveryMethods List<String>
    Media set supported by a given provider to deliver a notification
    defaultFrom String
    Default sender subject as "from" when no other value is specified.
    mssid String
    Twilio Messaging Service SID
    sid String
    Twilio Account SID.

    PhoneProviderCredentials, PhoneProviderCredentialsArgs

    AuthToken string
    The Auth Token for the phone provider.
    AuthToken string
    The Auth Token for the phone provider.
    authToken String
    The Auth Token for the phone provider.
    authToken string
    The Auth Token for the phone provider.
    auth_token str
    The Auth Token for the phone provider.
    authToken String
    The Auth Token for the phone provider.

    Import

    This resource can be imported by specifying the phone Provider ID.

    Example:

    $ pulumi import auth0:index/phoneProvider:PhoneProvider my_phone_provider "pro_XXXXXXXXXXXXXXXX"

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

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo
    Auth0 v3.16.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-auth0