1. Packages
  2. Auth0 Provider
  3. API Docs
  4. getSelfServiceProfile
Auth0 v3.7.1 published on Thursday, Sep 12, 2024 by Pulumi

auth0.getSelfServiceProfile

Explore with Pulumi AI

auth0 logo
Auth0 v3.7.1 published on Thursday, Sep 12, 2024 by Pulumi

    Data source to retrieve a specific Auth0 Self-Service Profile by id

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as auth0 from "@pulumi/auth0";
    
    // An Auth0 Self-Service- Profile loaded using it's ID.
    const auth0SelfServiceProfile = auth0.getSelfServiceProfile({
        id: "some-profile-id",
    });
    
    import pulumi
    import pulumi_auth0 as auth0
    
    # An Auth0 Self-Service- Profile loaded using it's ID.
    auth0_self_service_profile = auth0.get_self_service_profile(id="some-profile-id")
    
    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 {
    		// An Auth0 Self-Service- Profile loaded using it's ID.
    		_, err := auth0.LookupSelfServiceProfile(ctx, &auth0.LookupSelfServiceProfileArgs{
    			Id: "some-profile-id",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Auth0 = Pulumi.Auth0;
    
    return await Deployment.RunAsync(() => 
    {
        // An Auth0 Self-Service- Profile loaded using it's ID.
        var auth0SelfServiceProfile = Auth0.GetSelfServiceProfile.Invoke(new()
        {
            Id = "some-profile-id",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.auth0.Auth0Functions;
    import com.pulumi.auth0.inputs.GetSelfServiceProfileArgs;
    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) {
            // An Auth0 Self-Service- Profile loaded using it's ID.
            final var auth0SelfServiceProfile = Auth0Functions.getSelfServiceProfile(GetSelfServiceProfileArgs.builder()
                .id("some-profile-id")
                .build());
    
        }
    }
    
    variables:
      # An Auth0 Self-Service- Profile loaded using it's ID.
      auth0SelfServiceProfile:
        fn::invoke:
          Function: auth0:getSelfServiceProfile
          Arguments:
            id: some-profile-id
    

    Using getSelfServiceProfile

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSelfServiceProfile(args: GetSelfServiceProfileArgs, opts?: InvokeOptions): Promise<GetSelfServiceProfileResult>
    function getSelfServiceProfileOutput(args: GetSelfServiceProfileOutputArgs, opts?: InvokeOptions): Output<GetSelfServiceProfileResult>
    def get_self_service_profile(id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetSelfServiceProfileResult
    def get_self_service_profile_output(id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetSelfServiceProfileResult]
    func LookupSelfServiceProfile(ctx *Context, args *LookupSelfServiceProfileArgs, opts ...InvokeOption) (*LookupSelfServiceProfileResult, error)
    func LookupSelfServiceProfileOutput(ctx *Context, args *LookupSelfServiceProfileOutputArgs, opts ...InvokeOption) LookupSelfServiceProfileResultOutput

    > Note: This function is named LookupSelfServiceProfile in the Go SDK.

    public static class GetSelfServiceProfile 
    {
        public static Task<GetSelfServiceProfileResult> InvokeAsync(GetSelfServiceProfileArgs args, InvokeOptions? opts = null)
        public static Output<GetSelfServiceProfileResult> Invoke(GetSelfServiceProfileInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSelfServiceProfileResult> getSelfServiceProfile(GetSelfServiceProfileArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: auth0:index/getSelfServiceProfile:getSelfServiceProfile
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The id of the Self Service Profile
    Id string
    The id of the Self Service Profile
    id String
    The id of the Self Service Profile
    id string
    The id of the Self Service Profile
    id str
    The id of the Self Service Profile
    id String
    The id of the Self Service Profile

    getSelfServiceProfile Result

    The following output properties are available:

    Brandings List<GetSelfServiceProfileBranding>
    Field can be used to customize the look and feel of the wizard.
    CreatedAt string
    The ISO 8601 formatted date the profile was created.
    Id string
    The id of the Self Service Profile
    UpdatedAt string
    The ISO 8601 formatted date the profile was updated.
    UserAttributes List<GetSelfServiceProfileUserAttribute>
    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.
    Brandings []GetSelfServiceProfileBranding
    Field can be used to customize the look and feel of the wizard.
    CreatedAt string
    The ISO 8601 formatted date the profile was created.
    Id string
    The id of the Self Service Profile
    UpdatedAt string
    The ISO 8601 formatted date the profile was updated.
    UserAttributes []GetSelfServiceProfileUserAttribute
    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.
    brandings List<GetSelfServiceProfileBranding>
    Field can be used to customize the look and feel of the wizard.
    createdAt String
    The ISO 8601 formatted date the profile was created.
    id String
    The id of the Self Service Profile
    updatedAt String
    The ISO 8601 formatted date the profile was updated.
    userAttributes List<GetSelfServiceProfileUserAttribute>
    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.
    brandings GetSelfServiceProfileBranding[]
    Field can be used to customize the look and feel of the wizard.
    createdAt string
    The ISO 8601 formatted date the profile was created.
    id string
    The id of the Self Service Profile
    updatedAt string
    The ISO 8601 formatted date the profile was updated.
    userAttributes GetSelfServiceProfileUserAttribute[]
    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.
    brandings Sequence[GetSelfServiceProfileBranding]
    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.
    id str
    The id of the Self Service Profile
    updated_at str
    The ISO 8601 formatted date the profile was updated.
    user_attributes Sequence[GetSelfServiceProfileUserAttribute]
    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.
    brandings List<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.
    id String
    The id 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

    GetSelfServiceProfileBranding

    Colors List<GetSelfServiceProfileBrandingColor>
    Configuration settings for colors for branding.
    LogoUrl string
    URL of logo to display on login page.
    Colors []GetSelfServiceProfileBrandingColor
    Configuration settings for colors for branding.
    LogoUrl string
    URL of logo to display on login page.
    colors List<GetSelfServiceProfileBrandingColor>
    Configuration settings for colors for branding.
    logoUrl String
    URL of logo to display on login page.
    colors GetSelfServiceProfileBrandingColor[]
    Configuration settings for colors for branding.
    logoUrl string
    URL of logo to display on login page.
    colors Sequence[GetSelfServiceProfileBrandingColor]
    Configuration settings for colors for branding.
    logo_url str
    URL of logo to display on login page.
    colors List<Property Map>
    Configuration settings for colors for branding.
    logoUrl String
    URL of logo to display on login page.

    GetSelfServiceProfileBrandingColor

    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.

    GetSelfServiceProfileUserAttribute

    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

    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.7.1 published on Thursday, Sep 12, 2024 by Pulumi