Set custom text for a self-service profile

Updates text customizations for a given self-service profile, language and Self-Service Enterprise Configuration flow page.

PUT https://{tenantDomain}/api/v2/self-service-profiles/{id}/custom-text/{language}/{page}

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using System.Collections.Generic;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.SelfServiceProfiles.CustomText.SetAsync(
            id: "id",
            language: "en",
            page: "get-started",
            request: new Dictionary<string, string>(){
                ["key"] = "value",
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v2/management"
    client "github.com/auth0/go-auth0/v2/management/client"
    option "github.com/auth0/go-auth0/v2/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := map[string]any{
        "key": "value",
    }
    mgmt.SelfServiceProfiles.CustomText.Set(
        context.TODO(),
        "id",
        management.SelfServiceProfileCustomTextLanguageEnum(
            "en",
        ),
        management.SelfServiceProfileCustomTextPageEnum(
            "get-started",
        ),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import java.util.HashMap;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.selfServiceProfiles().customText().set(
            "id",
            "en",
            "get-started",
            new HashMap<String, String>() {{
                put("key", "value");
            }}
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->selfServiceProfiles->customText->set(
    'id',
    'en',
    'get-started',
    [
        'key' => 'value',
    ],
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.self_service_profiles.custom_text.set(
    id="id",
    request={
        "key": "value"
    },
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.self_service_profiles.custom_text.set(
  id: "id",
  language: "en",
  page: "get-started",
  request: {
    key: "value"
  }
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.selfServiceProfiles.customText.set("id", "en", "get-started", {
        "key": "value",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.selfServiceProfiles.customText.set("id", "en", "get-started", {
        "key": "value",
    });
}
main();

curl --request PUT \
  --url https://{tenantDomain}/api/v2/self-service-profiles/{id}/custom-text/{language}/{page} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

id · string · 必須

The id of the self-service profile.

language · enum<string> · 必須

The language of the custom text.

利用可能なオプション: en

page · enum<string> · 必須

The page where the custom text is shown.

利用可能なオプション: get-started

ボディ

application/jsonapplication/x-www-form-urlencoded

The list of text keys and values to customize the Self-Service Enterprise Configuration flow page. Values can be plain text or rich HTML content limited to basic styling tags and hyperlinks.

{key} · string

Maximum string length: 2000

レスポンス

200

application/json

Updated custom text.

The resulting list of custom text keys and values.

{key} · string