Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
  3. API Docs
  4. SelfServiceProfileCustomText
Auth0 v3.17.1 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-auth0

auth0.SelfServiceProfileCustomText

Explore with Pulumi AI

Auth0 v3.17.1 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-auth0

With this resource, you can set custom text for Self-Service Profile

Example Usage

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

const ssoCustomText = new auth0.SelfServiceProfileCustomText("sso_custom_text", {
    ssoId: "some-sso-id",
    language: "en",
    page: "get-started",
    body: JSON.stringify({
        introduction: "Welcome! With only a few steps you'll be able to setup your new custom text.",
    }),
});
Copy
import pulumi
import json
import pulumi_auth0 as auth0

sso_custom_text = auth0.SelfServiceProfileCustomText("sso_custom_text",
    sso_id="some-sso-id",
    language="en",
    page="get-started",
    body=json.dumps({
        "introduction": "Welcome! With only a few steps you'll be able to setup your new custom text.",
    }))
Copy
package main

import (
	"encoding/json"

	"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 {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"introduction": "Welcome! With only a few steps you'll be able to setup your new custom text.",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = auth0.NewSelfServiceProfileCustomText(ctx, "sso_custom_text", &auth0.SelfServiceProfileCustomTextArgs{
			SsoId:    pulumi.String("some-sso-id"),
			Language: pulumi.String("en"),
			Page:     pulumi.String("get-started"),
			Body:     pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    var ssoCustomText = new Auth0.SelfServiceProfileCustomText("sso_custom_text", new()
    {
        SsoId = "some-sso-id",
        Language = "en",
        Page = "get-started",
        Body = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["introduction"] = "Welcome! With only a few steps you'll be able to setup your new custom text.",
        }),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.SelfServiceProfileCustomText;
import com.pulumi.auth0.SelfServiceProfileCustomTextArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 ssoCustomText = new SelfServiceProfileCustomText("ssoCustomText", SelfServiceProfileCustomTextArgs.builder()
            .ssoId("some-sso-id")
            .language("en")
            .page("get-started")
            .body(serializeJson(
                jsonObject(
                    jsonProperty("introduction", "Welcome! With only a few steps you'll be able to setup your new custom text.")
                )))
            .build());

    }
}
Copy
resources:
  ssoCustomText:
    type: auth0:SelfServiceProfileCustomText
    name: sso_custom_text
    properties:
      ssoId: some-sso-id
      language: en
      page: get-started
      body:
        fn::toJSON:
          introduction: Welcome! With only a few steps you'll be able to setup your new custom text.
Copy

Create SelfServiceProfileCustomText Resource

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

Constructor syntax

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

@overload
def SelfServiceProfileCustomText(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 body: Optional[str] = None,
                                 language: Optional[str] = None,
                                 page: Optional[str] = None,
                                 sso_id: Optional[str] = None)
func NewSelfServiceProfileCustomText(ctx *Context, name string, args SelfServiceProfileCustomTextArgs, opts ...ResourceOption) (*SelfServiceProfileCustomText, error)
public SelfServiceProfileCustomText(string name, SelfServiceProfileCustomTextArgs args, CustomResourceOptions? opts = null)
public SelfServiceProfileCustomText(String name, SelfServiceProfileCustomTextArgs args)
public SelfServiceProfileCustomText(String name, SelfServiceProfileCustomTextArgs args, CustomResourceOptions options)

type: auth0:SelfServiceProfileCustomText
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SelfServiceProfileCustomTextArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SelfServiceProfileCustomTextArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SelfServiceProfileCustomTextArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SelfServiceProfileCustomTextArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SelfServiceProfileCustomTextArgs
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 selfServiceProfileCustomTextResource = new Auth0.SelfServiceProfileCustomText("selfServiceProfileCustomTextResource", new()
{
    Body = "string",
    Language = "string",
    Page = "string",
    SsoId = "string",
});
Copy
example, err := auth0.NewSelfServiceProfileCustomText(ctx, "selfServiceProfileCustomTextResource", &auth0.SelfServiceProfileCustomTextArgs{
	Body:     pulumi.String("string"),
	Language: pulumi.String("string"),
	Page:     pulumi.String("string"),
	SsoId:    pulumi.String("string"),
})
Copy
var selfServiceProfileCustomTextResource = new SelfServiceProfileCustomText("selfServiceProfileCustomTextResource", SelfServiceProfileCustomTextArgs.builder()
    .body("string")
    .language("string")
    .page("string")
    .ssoId("string")
    .build());
Copy
self_service_profile_custom_text_resource = auth0.SelfServiceProfileCustomText("selfServiceProfileCustomTextResource",
    body="string",
    language="string",
    page="string",
    sso_id="string")
Copy
const selfServiceProfileCustomTextResource = new auth0.SelfServiceProfileCustomText("selfServiceProfileCustomTextResource", {
    body: "string",
    language: "string",
    page: "string",
    ssoId: "string",
});
Copy
type: auth0:SelfServiceProfileCustomText
properties:
    body: string
    language: string
    page: string
    ssoId: string
Copy

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

Body This property is required. string
The list of text keys and values to customize the self-service SSO page. Values can be plain text or rich HTML content limited to basic styling tags and hyperlinks
Language This property is required. string
The language of the custom text
Page This property is required. string
The page where the custom text is shown
SsoId
This property is required.
Changes to this property will trigger replacement.
string
The id of the self-service profile
Body This property is required. string
The list of text keys and values to customize the self-service SSO page. Values can be plain text or rich HTML content limited to basic styling tags and hyperlinks
Language This property is required. string
The language of the custom text
Page This property is required. string
The page where the custom text is shown
SsoId
This property is required.
Changes to this property will trigger replacement.
string
The id of the self-service profile
body This property is required. String
The list of text keys and values to customize the self-service SSO page. Values can be plain text or rich HTML content limited to basic styling tags and hyperlinks
language This property is required. String
The language of the custom text
page This property is required. String
The page where the custom text is shown
ssoId
This property is required.
Changes to this property will trigger replacement.
String
The id of the self-service profile
body This property is required. string
The list of text keys and values to customize the self-service SSO page. Values can be plain text or rich HTML content limited to basic styling tags and hyperlinks
language This property is required. string
The language of the custom text
page This property is required. string
The page where the custom text is shown
ssoId
This property is required.
Changes to this property will trigger replacement.
string
The id of the self-service profile
body This property is required. str
The list of text keys and values to customize the self-service SSO page. Values can be plain text or rich HTML content limited to basic styling tags and hyperlinks
language This property is required. str
The language of the custom text
page This property is required. str
The page where the custom text is shown
sso_id
This property is required.
Changes to this property will trigger replacement.
str
The id of the self-service profile
body This property is required. String
The list of text keys and values to customize the self-service SSO page. Values can be plain text or rich HTML content limited to basic styling tags and hyperlinks
language This property is required. String
The language of the custom text
page This property is required. String
The page where the custom text is shown
ssoId
This property is required.
Changes to this property will trigger replacement.
String
The id of the self-service profile

Outputs

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

Get an existing SelfServiceProfileCustomText 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?: SelfServiceProfileCustomTextState, opts?: CustomResourceOptions): SelfServiceProfileCustomText
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        body: Optional[str] = None,
        language: Optional[str] = None,
        page: Optional[str] = None,
        sso_id: Optional[str] = None) -> SelfServiceProfileCustomText
func GetSelfServiceProfileCustomText(ctx *Context, name string, id IDInput, state *SelfServiceProfileCustomTextState, opts ...ResourceOption) (*SelfServiceProfileCustomText, error)
public static SelfServiceProfileCustomText Get(string name, Input<string> id, SelfServiceProfileCustomTextState? state, CustomResourceOptions? opts = null)
public static SelfServiceProfileCustomText get(String name, Output<String> id, SelfServiceProfileCustomTextState state, CustomResourceOptions options)
resources:  _:    type: auth0:SelfServiceProfileCustomText    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Body string
The list of text keys and values to customize the self-service SSO page. Values can be plain text or rich HTML content limited to basic styling tags and hyperlinks
Language string
The language of the custom text
Page string
The page where the custom text is shown
SsoId Changes to this property will trigger replacement. string
The id of the self-service profile
Body string
The list of text keys and values to customize the self-service SSO page. Values can be plain text or rich HTML content limited to basic styling tags and hyperlinks
Language string
The language of the custom text
Page string
The page where the custom text is shown
SsoId Changes to this property will trigger replacement. string
The id of the self-service profile
body String
The list of text keys and values to customize the self-service SSO page. Values can be plain text or rich HTML content limited to basic styling tags and hyperlinks
language String
The language of the custom text
page String
The page where the custom text is shown
ssoId Changes to this property will trigger replacement. String
The id of the self-service profile
body string
The list of text keys and values to customize the self-service SSO page. Values can be plain text or rich HTML content limited to basic styling tags and hyperlinks
language string
The language of the custom text
page string
The page where the custom text is shown
ssoId Changes to this property will trigger replacement. string
The id of the self-service profile
body str
The list of text keys and values to customize the self-service SSO page. Values can be plain text or rich HTML content limited to basic styling tags and hyperlinks
language str
The language of the custom text
page str
The page where the custom text is shown
sso_id Changes to this property will trigger replacement. str
The id of the self-service profile
body String
The list of text keys and values to customize the self-service SSO page. Values can be plain text or rich HTML content limited to basic styling tags and hyperlinks
language String
The language of the custom text
page String
The page where the custom text is shown
ssoId Changes to this property will trigger replacement. String
The id of the self-service profile

Import

This resource can be imported by specifying the

sso-profile-id, language and page separated by “::” (note the double colon)

::::

Example

$ pulumi import auth0:index/selfServiceProfileCustomText:SelfServiceProfileCustomText example "some-sso-id::en::get-started"
Copy

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 v3.17.1 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-auth0