Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
  3. API Docs
  4. SelfServiceProfile
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
pulumi/pulumi-auth0

auth0.SelfServiceProfile

Explore with Pulumi AI

auth0 logo
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 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",
        },
    },
});

    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",
        },
    })

    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
	})
}

    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",
            },
        },
    });

});

    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());

    }
}

    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'

    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,
                       branding: Optional[SelfServiceProfileBrandingArgs] = 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 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 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 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 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 String
    The unique name of the resource.
    args 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()
{
    Branding = new Auth0.Inputs.SelfServiceProfileBrandingArgs
    {
        Colors = new Auth0.Inputs.SelfServiceProfileBrandingColorsArgs
        {
            Primary = "string",
        },
        LogoUrl = "string",
    },
    UserAttributes = new[]
    {
        new Auth0.Inputs.SelfServiceProfileUserAttributeArgs
        {
            Description = "string",
            IsOptional = false,
            Name = "string",
        },
    },
});

    example, err := auth0.NewSelfServiceProfile(ctx, "selfServiceProfileResource", &auth0.SelfServiceProfileArgs{
	Branding: &auth0.SelfServiceProfileBrandingArgs{
		Colors: &auth0.SelfServiceProfileBrandingColorsArgs{
			Primary: pulumi.String("string"),
		},
		LogoUrl: pulumi.String("string"),
	},
	UserAttributes: auth0.SelfServiceProfileUserAttributeArray{
		&auth0.SelfServiceProfileUserAttributeArgs{
			Description: pulumi.String("string"),
			IsOptional:  pulumi.Bool(false),
			Name:        pulumi.String("string"),
		},
	},
})

    var selfServiceProfileResource = new SelfServiceProfile("selfServiceProfileResource", SelfServiceProfileArgs.builder()
    .branding(SelfServiceProfileBrandingArgs.builder()
        .colors(SelfServiceProfileBrandingColorsArgs.builder()
            .primary("string")
            .build())
        .logoUrl("string")
        .build())
    .userAttributes(SelfServiceProfileUserAttributeArgs.builder()
        .description("string")
        .isOptional(false)
        .name("string")
        .build())
    .build());

    self_service_profile_resource = auth0.SelfServiceProfile("selfServiceProfileResource",
    branding={
        "colors": {
            "primary": "string",
        },
        "logo_url": "string",
    },
    user_attributes=[{
        "description": "string",
        "is_optional": False,
        "name": "string",
    }])

    const selfServiceProfileResource = new auth0.SelfServiceProfile("selfServiceProfileResource", {
    branding: {
        colors: {
            primary: "string",
        },
        logoUrl: "string",
    },
    userAttributes: [{
        description: "string",
        isOptional: false,
        name: "string",
    }],
});

    type: auth0:SelfServiceProfile
properties:
    branding:
        colors:
            primary: string
        logoUrl: string
    userAttributes:
        - description: string
          isOptional: false
          name: string

    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:

    Branding SelfServiceProfileBranding
    Field can be used to customize the look and feel of the wizard.
    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.
    Branding SelfServiceProfileBrandingArgs
    Field can be used to customize the look and feel of the wizard.
    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.
    branding SelfServiceProfileBranding
    Field can be used to customize the look and feel of the wizard.
    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.
    branding SelfServiceProfileBranding
    Field can be used to customize the look and feel of the wizard.
    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.
    branding SelfServiceProfileBrandingArgs
    Field can be used to customize the look and feel of the wizard.
    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.
    branding Property Map
    Field can be used to customize the look and feel of the wizard.
    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,
        branding: Optional[SelfServiceProfileBrandingArgs] = None,
        created_at: 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)
    Resource lookup is not supported in YAML
    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:
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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 string
    A human readable description of the attribute.
    IsOptional bool
    Indicates if this attribute is optional or if it has to be provided by the customer for the application to function.
    Name string
    Attribute’s name on Auth0 side
    Description string
    A human readable description of the attribute.
    IsOptional bool
    Indicates if this attribute is optional or if it has to be provided by the customer for the application to function.
    Name string
    Attribute’s name on Auth0 side
    description String
    A human readable description of the attribute.
    isOptional Boolean
    Indicates if this attribute is optional or if it has to be provided by the customer for the application to function.
    name String
    Attribute’s name on Auth0 side
    description string
    A human readable description of the attribute.
    isOptional boolean
    Indicates if this attribute is optional or if it has to be provided by the customer for the application to function.
    name string
    Attribute’s name on Auth0 side
    description str
    A human readable description of the attribute.
    is_optional bool
    Indicates if this attribute is optional or if it has to be provided by the customer for the application to function.
    name str
    Attribute’s name on Auth0 side
    description String
    A human readable description of the attribute.
    isOptional Boolean
    Indicates if this attribute is optional or if it has to be provided by the customer for the application to function.
    name 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"

    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.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
    pulumi/pulumi-auth0