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

auth0.SelfServiceProfile

Explore with Pulumi AI

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

With this resource, you can create and manage Self-Service Profile for a tenant.

Example Usage

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

const mySelfServiceProfile = new auth0.SelfServiceProfile("my_self_service_profile", {
    userAttributes: [{
        name: "sample-name",
        description: "sample-description",
        isOptional: true,
    }],
    branding: {
        logoUrl: "https://mycompany.org/v2/logo.png",
        colors: {
            primary: "#0059d6",
        },
    },
});
Copy
import pulumi
import pulumi_auth0 as auth0

my_self_service_profile = auth0.SelfServiceProfile("my_self_service_profile",
    user_attributes=[{
        "name": "sample-name",
        "description": "sample-description",
        "is_optional": True,
    }],
    branding={
        "logo_url": "https://mycompany.org/v2/logo.png",
        "colors": {
            "primary": "#0059d6",
        },
    })
Copy
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 {
		_, err := auth0.NewSelfServiceProfile(ctx, "my_self_service_profile", &auth0.SelfServiceProfileArgs{
			UserAttributes: auth0.SelfServiceProfileUserAttributeArray{
				&auth0.SelfServiceProfileUserAttributeArgs{
					Name:        pulumi.String("sample-name"),
					Description: pulumi.String("sample-description"),
					IsOptional:  pulumi.Bool(true),
				},
			},
			Branding: &auth0.SelfServiceProfileBrandingArgs{
				LogoUrl: pulumi.String("https://mycompany.org/v2/logo.png"),
				Colors: &auth0.SelfServiceProfileBrandingColorsArgs{
					Primary: pulumi.String("#0059d6"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    var mySelfServiceProfile = new Auth0.SelfServiceProfile("my_self_service_profile", new()
    {
        UserAttributes = new[]
        {
            new Auth0.Inputs.SelfServiceProfileUserAttributeArgs
            {
                Name = "sample-name",
                Description = "sample-description",
                IsOptional = true,
            },
        },
        Branding = new Auth0.Inputs.SelfServiceProfileBrandingArgs
        {
            LogoUrl = "https://mycompany.org/v2/logo.png",
            Colors = new Auth0.Inputs.SelfServiceProfileBrandingColorsArgs
            {
                Primary = "#0059d6",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.SelfServiceProfile;
import com.pulumi.auth0.SelfServiceProfileArgs;
import com.pulumi.auth0.inputs.SelfServiceProfileUserAttributeArgs;
import com.pulumi.auth0.inputs.SelfServiceProfileBrandingArgs;
import com.pulumi.auth0.inputs.SelfServiceProfileBrandingColorsArgs;
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 mySelfServiceProfile = new SelfServiceProfile("mySelfServiceProfile", SelfServiceProfileArgs.builder()
            .userAttributes(SelfServiceProfileUserAttributeArgs.builder()
                .name("sample-name")
                .description("sample-description")
                .isOptional(true)
                .build())
            .branding(SelfServiceProfileBrandingArgs.builder()
                .logoUrl("https://mycompany.org/v2/logo.png")
                .colors(SelfServiceProfileBrandingColorsArgs.builder()
                    .primary("#0059d6")
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  mySelfServiceProfile:
    type: auth0:SelfServiceProfile
    name: my_self_service_profile
    properties:
      userAttributes:
        - name: sample-name
          description: sample-description
          isOptional: true
      branding:
        logoUrl: https://mycompany.org/v2/logo.png
        colors:
          primary: '#0059d6'
Copy

Create SelfServiceProfile Resource

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

Constructor syntax

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

@overload
def SelfServiceProfile(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       allowed_strategies: Optional[Sequence[str]] = None,
                       branding: Optional[SelfServiceProfileBrandingArgs] = None,
                       description: Optional[str] = None,
                       name: Optional[str] = None,
                       user_attributes: Optional[Sequence[SelfServiceProfileUserAttributeArgs]] = None)
func NewSelfServiceProfile(ctx *Context, name string, args *SelfServiceProfileArgs, opts ...ResourceOption) (*SelfServiceProfile, error)
public SelfServiceProfile(string name, SelfServiceProfileArgs? args = null, CustomResourceOptions? opts = null)
public SelfServiceProfile(String name, SelfServiceProfileArgs args)
public SelfServiceProfile(String name, SelfServiceProfileArgs args, CustomResourceOptions options)

type: auth0:SelfServiceProfile
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 SelfServiceProfileArgs
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 SelfServiceProfileArgs
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 SelfServiceProfileArgs
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 SelfServiceProfileArgs
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. SelfServiceProfileArgs
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 selfServiceProfileResource = new Auth0.SelfServiceProfile("selfServiceProfileResource", new()
{
    AllowedStrategies = new[]
    {
        "string",
    },
    Branding = new Auth0.Inputs.SelfServiceProfileBrandingArgs
    {
        Colors = new Auth0.Inputs.SelfServiceProfileBrandingColorsArgs
        {
            Primary = "string",
        },
        LogoUrl = "string",
    },
    Description = "string",
    Name = "string",
    UserAttributes = new[]
    {
        new Auth0.Inputs.SelfServiceProfileUserAttributeArgs
        {
            Description = "string",
            IsOptional = false,
            Name = "string",
        },
    },
});
Copy
example, err := auth0.NewSelfServiceProfile(ctx, "selfServiceProfileResource", &auth0.SelfServiceProfileArgs{
	AllowedStrategies: pulumi.StringArray{
		pulumi.String("string"),
	},
	Branding: &auth0.SelfServiceProfileBrandingArgs{
		Colors: &auth0.SelfServiceProfileBrandingColorsArgs{
			Primary: pulumi.String("string"),
		},
		LogoUrl: pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	UserAttributes: auth0.SelfServiceProfileUserAttributeArray{
		&auth0.SelfServiceProfileUserAttributeArgs{
			Description: pulumi.String("string"),
			IsOptional:  pulumi.Bool(false),
			Name:        pulumi.String("string"),
		},
	},
})
Copy
var selfServiceProfileResource = new SelfServiceProfile("selfServiceProfileResource", SelfServiceProfileArgs.builder()
    .allowedStrategies("string")
    .branding(SelfServiceProfileBrandingArgs.builder()
        .colors(SelfServiceProfileBrandingColorsArgs.builder()
            .primary("string")
            .build())
        .logoUrl("string")
        .build())
    .description("string")
    .name("string")
    .userAttributes(SelfServiceProfileUserAttributeArgs.builder()
        .description("string")
        .isOptional(false)
        .name("string")
        .build())
    .build());
Copy
self_service_profile_resource = auth0.SelfServiceProfile("selfServiceProfileResource",
    allowed_strategies=["string"],
    branding={
        "colors": {
            "primary": "string",
        },
        "logo_url": "string",
    },
    description="string",
    name="string",
    user_attributes=[{
        "description": "string",
        "is_optional": False,
        "name": "string",
    }])
Copy
const selfServiceProfileResource = new auth0.SelfServiceProfile("selfServiceProfileResource", {
    allowedStrategies: ["string"],
    branding: {
        colors: {
            primary: "string",
        },
        logoUrl: "string",
    },
    description: "string",
    name: "string",
    userAttributes: [{
        description: "string",
        isOptional: false,
        name: "string",
    }],
});
Copy
type: auth0:SelfServiceProfile
properties:
    allowedStrategies:
        - string
    branding:
        colors:
            primary: string
        logoUrl: string
    description: string
    name: string
    userAttributes:
        - description: string
          isOptional: false
          name: string
Copy

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

AllowedStrategies List<string>
List of IdP strategies that will be shown to users during the Self-Service SSO flow.
Branding SelfServiceProfileBranding
Field can be used to customize the look and feel of the wizard.
Description string
The description of the self-service Profile
Name string
The name of the self-service Profile
UserAttributes List<SelfServiceProfileUserAttribute>
This array stores the mapping information that will be shown to the user during the SS-SSO flow. The user will be prompted to map the attributes on their identity provider to ensure the specified attributes get passed to Auth0.
AllowedStrategies []string
List of IdP strategies that will be shown to users during the Self-Service SSO flow.
Branding SelfServiceProfileBrandingArgs
Field can be used to customize the look and feel of the wizard.
Description string
The description of the self-service Profile
Name string
The name of the self-service Profile
UserAttributes []SelfServiceProfileUserAttributeArgs
This array stores the mapping information that will be shown to the user during the SS-SSO flow. The user will be prompted to map the attributes on their identity provider to ensure the specified attributes get passed to Auth0.
allowedStrategies List<String>
List of IdP strategies that will be shown to users during the Self-Service SSO flow.
branding SelfServiceProfileBranding
Field can be used to customize the look and feel of the wizard.
description String
The description of the self-service Profile
name String
The name of the self-service Profile
userAttributes List<SelfServiceProfileUserAttribute>
This array stores the mapping information that will be shown to the user during the SS-SSO flow. The user will be prompted to map the attributes on their identity provider to ensure the specified attributes get passed to Auth0.
allowedStrategies string[]
List of IdP strategies that will be shown to users during the Self-Service SSO flow.
branding SelfServiceProfileBranding
Field can be used to customize the look and feel of the wizard.
description string
The description of the self-service Profile
name string
The name of the self-service Profile
userAttributes SelfServiceProfileUserAttribute[]
This array stores the mapping information that will be shown to the user during the SS-SSO flow. The user will be prompted to map the attributes on their identity provider to ensure the specified attributes get passed to Auth0.
allowed_strategies Sequence[str]
List of IdP strategies that will be shown to users during the Self-Service SSO flow.
branding SelfServiceProfileBrandingArgs
Field can be used to customize the look and feel of the wizard.
description str
The description of the self-service Profile
name str
The name of the self-service Profile
user_attributes Sequence[SelfServiceProfileUserAttributeArgs]
This array stores the mapping information that will be shown to the user during the SS-SSO flow. The user will be prompted to map the attributes on their identity provider to ensure the specified attributes get passed to Auth0.
allowedStrategies List<String>
List of IdP strategies that will be shown to users during the Self-Service SSO flow.
branding Property Map
Field can be used to customize the look and feel of the wizard.
description String
The description of the self-service Profile
name String
The name of the self-service Profile
userAttributes List<Property Map>
This array stores the mapping information that will be shown to the user during the SS-SSO flow. The user will be prompted to map the attributes on their identity provider to ensure the specified attributes get passed to Auth0.

Outputs

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

CreatedAt string
The ISO 8601 formatted date the profile was created.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
The ISO 8601 formatted date the profile was updated.
CreatedAt string
The ISO 8601 formatted date the profile was created.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
The ISO 8601 formatted date the profile was updated.
createdAt String
The ISO 8601 formatted date the profile was created.
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
The ISO 8601 formatted date the profile was updated.
createdAt string
The ISO 8601 formatted date the profile was created.
id string
The provider-assigned unique ID for this managed resource.
updatedAt string
The ISO 8601 formatted date the profile was updated.
created_at str
The ISO 8601 formatted date the profile was created.
id str
The provider-assigned unique ID for this managed resource.
updated_at str
The ISO 8601 formatted date the profile was updated.
createdAt String
The ISO 8601 formatted date the profile was created.
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
The ISO 8601 formatted date the profile was updated.

Look up Existing SelfServiceProfile Resource

Get an existing SelfServiceProfile 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?: SelfServiceProfileState, opts?: CustomResourceOptions): SelfServiceProfile
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_strategies: Optional[Sequence[str]] = None,
        branding: Optional[SelfServiceProfileBrandingArgs] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        updated_at: Optional[str] = None,
        user_attributes: Optional[Sequence[SelfServiceProfileUserAttributeArgs]] = None) -> SelfServiceProfile
func GetSelfServiceProfile(ctx *Context, name string, id IDInput, state *SelfServiceProfileState, opts ...ResourceOption) (*SelfServiceProfile, error)
public static SelfServiceProfile Get(string name, Input<string> id, SelfServiceProfileState? state, CustomResourceOptions? opts = null)
public static SelfServiceProfile get(String name, Output<String> id, SelfServiceProfileState state, CustomResourceOptions options)
resources:  _:    type: auth0:SelfServiceProfile    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:
AllowedStrategies List<string>
List of IdP strategies that will be shown to users during the Self-Service SSO flow.
Branding SelfServiceProfileBranding
Field can be used to customize the look and feel of the wizard.
CreatedAt string
The ISO 8601 formatted date the profile was created.
Description string
The description of the self-service Profile
Name string
The name of the self-service Profile
UpdatedAt string
The ISO 8601 formatted date the profile was updated.
UserAttributes List<SelfServiceProfileUserAttribute>
This array stores the mapping information that will be shown to the user during the SS-SSO flow. The user will be prompted to map the attributes on their identity provider to ensure the specified attributes get passed to Auth0.
AllowedStrategies []string
List of IdP strategies that will be shown to users during the Self-Service SSO flow.
Branding SelfServiceProfileBrandingArgs
Field can be used to customize the look and feel of the wizard.
CreatedAt string
The ISO 8601 formatted date the profile was created.
Description string
The description of the self-service Profile
Name string
The name of the self-service Profile
UpdatedAt string
The ISO 8601 formatted date the profile was updated.
UserAttributes []SelfServiceProfileUserAttributeArgs
This array stores the mapping information that will be shown to the user during the SS-SSO flow. The user will be prompted to map the attributes on their identity provider to ensure the specified attributes get passed to Auth0.
allowedStrategies List<String>
List of IdP strategies that will be shown to users during the Self-Service SSO flow.
branding SelfServiceProfileBranding
Field can be used to customize the look and feel of the wizard.
createdAt String
The ISO 8601 formatted date the profile was created.
description String
The description of the self-service Profile
name String
The name of the self-service Profile
updatedAt String
The ISO 8601 formatted date the profile was updated.
userAttributes List<SelfServiceProfileUserAttribute>
This array stores the mapping information that will be shown to the user during the SS-SSO flow. The user will be prompted to map the attributes on their identity provider to ensure the specified attributes get passed to Auth0.
allowedStrategies string[]
List of IdP strategies that will be shown to users during the Self-Service SSO flow.
branding SelfServiceProfileBranding
Field can be used to customize the look and feel of the wizard.
createdAt string
The ISO 8601 formatted date the profile was created.
description string
The description of the self-service Profile
name string
The name of the self-service Profile
updatedAt string
The ISO 8601 formatted date the profile was updated.
userAttributes SelfServiceProfileUserAttribute[]
This array stores the mapping information that will be shown to the user during the SS-SSO flow. The user will be prompted to map the attributes on their identity provider to ensure the specified attributes get passed to Auth0.
allowed_strategies Sequence[str]
List of IdP strategies that will be shown to users during the Self-Service SSO flow.
branding SelfServiceProfileBrandingArgs
Field can be used to customize the look and feel of the wizard.
created_at str
The ISO 8601 formatted date the profile was created.
description str
The description of the self-service Profile
name str
The name of the self-service Profile
updated_at str
The ISO 8601 formatted date the profile was updated.
user_attributes Sequence[SelfServiceProfileUserAttributeArgs]
This array stores the mapping information that will be shown to the user during the SS-SSO flow. The user will be prompted to map the attributes on their identity provider to ensure the specified attributes get passed to Auth0.
allowedStrategies List<String>
List of IdP strategies that will be shown to users during the Self-Service SSO flow.
branding Property Map
Field can be used to customize the look and feel of the wizard.
createdAt String
The ISO 8601 formatted date the profile was created.
description String
The description of the self-service Profile
name String
The name of the self-service Profile
updatedAt String
The ISO 8601 formatted date the profile was updated.
userAttributes List<Property Map>
This array stores the mapping information that will be shown to the user during the SS-SSO flow. The user will be prompted to map the attributes on their identity provider to ensure the specified attributes get passed to Auth0.

Supporting Types

SelfServiceProfileBranding
, SelfServiceProfileBrandingArgs

Colors SelfServiceProfileBrandingColors
Configuration settings for colors for branding.
LogoUrl string
URL of logo to display on login page.
Colors SelfServiceProfileBrandingColors
Configuration settings for colors for branding.
LogoUrl string
URL of logo to display on login page.
colors SelfServiceProfileBrandingColors
Configuration settings for colors for branding.
logoUrl String
URL of logo to display on login page.
colors SelfServiceProfileBrandingColors
Configuration settings for colors for branding.
logoUrl string
URL of logo to display on login page.
colors SelfServiceProfileBrandingColors
Configuration settings for colors for branding.
logo_url str
URL of logo to display on login page.
colors Property Map
Configuration settings for colors for branding.
logoUrl String
URL of logo to display on login page.

SelfServiceProfileBrandingColors
, SelfServiceProfileBrandingColorsArgs

Primary string
Primary button background color in hexadecimal.
Primary string
Primary button background color in hexadecimal.
primary String
Primary button background color in hexadecimal.
primary string
Primary button background color in hexadecimal.
primary str
Primary button background color in hexadecimal.
primary String
Primary button background color in hexadecimal.

SelfServiceProfileUserAttribute
, SelfServiceProfileUserAttributeArgs

Description This property is required. string
A human readable description of the attribute.
IsOptional This property is required. bool
Indicates if this attribute is optional or if it has to be provided by the customer for the application to function.
Name This property is required. string
Attribute’s name on Auth0 side
Description This property is required. string
A human readable description of the attribute.
IsOptional This property is required. bool
Indicates if this attribute is optional or if it has to be provided by the customer for the application to function.
Name This property is required. string
Attribute’s name on Auth0 side
description This property is required. String
A human readable description of the attribute.
isOptional This property is required. Boolean
Indicates if this attribute is optional or if it has to be provided by the customer for the application to function.
name This property is required. String
Attribute’s name on Auth0 side
description This property is required. string
A human readable description of the attribute.
isOptional This property is required. boolean
Indicates if this attribute is optional or if it has to be provided by the customer for the application to function.
name This property is required. string
Attribute’s name on Auth0 side
description This property is required. str
A human readable description of the attribute.
is_optional This property is required. bool
Indicates if this attribute is optional or if it has to be provided by the customer for the application to function.
name This property is required. str
Attribute’s name on Auth0 side
description This property is required. String
A human readable description of the attribute.
isOptional This property is required. Boolean
Indicates if this attribute is optional or if it has to be provided by the customer for the application to function.
name This property is required. String
Attribute’s name on Auth0 side

Import

This resource can be imported using the id

Example:

$ pulumi import auth0:index/selfServiceProfile:SelfServiceProfile id "ssp_32oi5unksja93124"
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