Viewing docs for Auth0 v3.56.0
published on Friday, Nov 6, 2026 by Pulumi
published on Friday, Nov 6, 2026 by Pulumi
Viewing docs for Auth0 v3.56.0
published on Friday, Nov 6, 2026 by Pulumi
published on Friday, Nov 6, 2026 by Pulumi
Data source to retrieve a specific Auth0 client profile (application profile) by id. This feature is available in Early Access only and requires the read:client_profiles scope on the Management API client. (EA only)
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";
// An Auth0 client profile (application profile) can be retrieved by its ID.
const myProfile = auth0.getClientProfile({
id: "cpr_XXXXXXXXXXXXXXXXXXXXXX",
});
import pulumi
import pulumi_auth0 as auth0
# An Auth0 client profile (application profile) can be retrieved by its ID.
my_profile = auth0.get_client_profile(id="cpr_XXXXXXXXXXXXXXXXXXXXXX")
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 client profile (application profile) can be retrieved by its ID.
_, err := auth0.GetClientProfile(ctx, &auth0.LookupClientProfileArgs{
Id: "cpr_XXXXXXXXXXXXXXXXXXXXXX",
}, 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 client profile (application profile) can be retrieved by its ID.
var myProfile = Auth0.GetClientProfile.Invoke(new()
{
Id = "cpr_XXXXXXXXXXXXXXXXXXXXXX",
});
});
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.GetClientProfileArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 client profile (application profile) can be retrieved by its ID.
final var myProfile = Auth0Functions.getClientProfile(GetClientProfileArgs.builder()
.id("cpr_XXXXXXXXXXXXXXXXXXXXXX")
.build());
}
}
variables:
# An Auth0 client profile (application profile) can be retrieved by its ID.
myProfile:
fn::invoke:
function: auth0:getClientProfile
arguments:
id: cpr_XXXXXXXXXXXXXXXXXXXXXX
terraform {
required_providers {
auth0 = {
source = "pulumi/auth0"
}
}
}
data "auth0_client_profile" "myProfile" {
id = "cpr_XXXXXXXXXXXXXXXXXXXXXX"
}
# An Auth0 client profile (application profile) can be retrieved by its ID.
Using getClientProfile
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 getClientProfile(args: GetClientProfileArgs, opts?: InvokeOptions): Promise<GetClientProfileResult>
function getClientProfileOutput(args: GetClientProfileOutputArgs, opts?: InvokeOutputOptions): Output<GetClientProfileResult>def get_client_profile(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetClientProfileResult
def get_client_profile_output(id: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetClientProfileResult]func LookupClientProfile(ctx *Context, args *LookupClientProfileArgs, opts ...InvokeOption) (*LookupClientProfileResult, error)
func LookupClientProfileOutput(ctx *Context, args *LookupClientProfileOutputArgs, opts ...InvokeOption) LookupClientProfileResultOutput> Note: This function is named LookupClientProfile in the Go SDK.
public static class GetClientProfile
{
public static Task<GetClientProfileResult> InvokeAsync(GetClientProfileArgs args, InvokeOptions? opts = null)
public static Output<GetClientProfileResult> Invoke(GetClientProfileInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetClientProfileResult> Invoke(GetClientProfileInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetClientProfileResult> getClientProfile(GetClientProfileArgs args, InvokeOptions options)
public static Output<GetClientProfileResult> getClientProfile(GetClientProfileArgs args, InvokeOptions options)
public static Output<GetClientProfileResult> getClientProfile(GetClientProfileArgs args, InvokeOutputOptions options)
fn::invoke:
function: auth0:index/getClientProfile:getClientProfile
arguments:
# arguments dictionarydata "auth0_get_client_profile" "name" {
# arguments
}The following arguments are supported:
- Id string
- The ID of the client profile.
- Id string
- The ID of the client profile.
- id string
- The ID of the client profile.
- id String
- The ID of the client profile.
- id string
- The ID of the client profile.
- id str
- The ID of the client profile.
- id String
- The ID of the client profile.
getClientProfile Result
The following output properties are available:
- Apply
Policies List<GetClient Profile Apply Policy> - Runtime matching rules that determine which clients this profile governs. Defaults to dynamically registered CIMD clients.
- Client
Configurations List<GetClient Profile Client Configuration> - Runtime policy applied to matched clients. Omitted settings fall back to each client's own setting. Auth0 replaces this block as a whole, so removing it clears all of its settings.
- Created
At string - The ISO 8601 formatted date the client profile was created.
- Description string
- The description of the client profile. Removing the attribute clears the description in Auth0.
- Id string
- The ID of the client profile.
- Name string
- The name of the client profile.
- Updated
At string - The ISO 8601 formatted date the client profile was updated.
- Apply
Policies []GetClient Profile Apply Policy - Runtime matching rules that determine which clients this profile governs. Defaults to dynamically registered CIMD clients.
- Client
Configurations []GetClient Profile Client Configuration - Runtime policy applied to matched clients. Omitted settings fall back to each client's own setting. Auth0 replaces this block as a whole, so removing it clears all of its settings.
- Created
At string - The ISO 8601 formatted date the client profile was created.
- Description string
- The description of the client profile. Removing the attribute clears the description in Auth0.
- Id string
- The ID of the client profile.
- Name string
- The name of the client profile.
- Updated
At string - The ISO 8601 formatted date the client profile was updated.
- apply_
policies list(object) - Runtime matching rules that determine which clients this profile governs. Defaults to dynamically registered CIMD clients.
- client_
configurations list(object) - Runtime policy applied to matched clients. Omitted settings fall back to each client's own setting. Auth0 replaces this block as a whole, so removing it clears all of its settings.
- created_
at string - The ISO 8601 formatted date the client profile was created.
- description string
- The description of the client profile. Removing the attribute clears the description in Auth0.
- id string
- The ID of the client profile.
- name string
- The name of the client profile.
- updated_
at string - The ISO 8601 formatted date the client profile was updated.
- apply
Policies List<GetClient Profile Apply Policy> - Runtime matching rules that determine which clients this profile governs. Defaults to dynamically registered CIMD clients.
- client
Configurations List<GetClient Profile Client Configuration> - Runtime policy applied to matched clients. Omitted settings fall back to each client's own setting. Auth0 replaces this block as a whole, so removing it clears all of its settings.
- created
At String - The ISO 8601 formatted date the client profile was created.
- description String
- The description of the client profile. Removing the attribute clears the description in Auth0.
- id String
- The ID of the client profile.
- name String
- The name of the client profile.
- updated
At String - The ISO 8601 formatted date the client profile was updated.
- apply
Policies GetClient Profile Apply Policy[] - Runtime matching rules that determine which clients this profile governs. Defaults to dynamically registered CIMD clients.
- client
Configurations GetClient Profile Client Configuration[] - Runtime policy applied to matched clients. Omitted settings fall back to each client's own setting. Auth0 replaces this block as a whole, so removing it clears all of its settings.
- created
At string - The ISO 8601 formatted date the client profile was created.
- description string
- The description of the client profile. Removing the attribute clears the description in Auth0.
- id string
- The ID of the client profile.
- name string
- The name of the client profile.
- updated
At string - The ISO 8601 formatted date the client profile was updated.
- apply_
policies Sequence[GetClient Profile Apply Policy] - Runtime matching rules that determine which clients this profile governs. Defaults to dynamically registered CIMD clients.
- client_
configurations Sequence[GetClient Profile Client Configuration] - Runtime policy applied to matched clients. Omitted settings fall back to each client's own setting. Auth0 replaces this block as a whole, so removing it clears all of its settings.
- created_
at str - The ISO 8601 formatted date the client profile was created.
- description str
- The description of the client profile. Removing the attribute clears the description in Auth0.
- id str
- The ID of the client profile.
- name str
- The name of the client profile.
- updated_
at str - The ISO 8601 formatted date the client profile was updated.
- apply
Policies List<Property Map> - Runtime matching rules that determine which clients this profile governs. Defaults to dynamically registered CIMD clients.
- client
Configurations List<Property Map> - Runtime policy applied to matched clients. Omitted settings fall back to each client's own setting. Auth0 replaces this block as a whole, so removing it clears all of its settings.
- created
At String - The ISO 8601 formatted date the client profile was created.
- description String
- The description of the client profile. Removing the attribute clears the description in Auth0.
- id String
- The ID of the client profile.
- name String
- The name of the client profile.
- updated
At String - The ISO 8601 formatted date the client profile was updated.
Supporting Types
GetClientProfileApplyPolicy
- External
Metadata stringCreated By - The creator of the clients to match. Defaults to
client, which means the client was registered dynamically. Possible values: [client]. - External
Metadata stringType - The type of external metadata of the clients to match. Defaults to
cimd. Possible values: [cimd].
- External
Metadata stringCreated By - The creator of the clients to match. Defaults to
client, which means the client was registered dynamically. Possible values: [client]. - External
Metadata stringType - The type of external metadata of the clients to match. Defaults to
cimd. Possible values: [cimd].
- external_
metadata_ stringcreated_ by - The creator of the clients to match. Defaults to
client, which means the client was registered dynamically. Possible values: [client]. - external_
metadata_ stringtype - The type of external metadata of the clients to match. Defaults to
cimd. Possible values: [cimd].
- external
Metadata StringCreated By - The creator of the clients to match. Defaults to
client, which means the client was registered dynamically. Possible values: [client]. - external
Metadata StringType - The type of external metadata of the clients to match. Defaults to
cimd. Possible values: [cimd].
- external
Metadata stringCreated By - The creator of the clients to match. Defaults to
client, which means the client was registered dynamically. Possible values: [client]. - external
Metadata stringType - The type of external metadata of the clients to match. Defaults to
cimd. Possible values: [cimd].
- external_
metadata_ strcreated_ by - The creator of the clients to match. Defaults to
client, which means the client was registered dynamically. Possible values: [client]. - external_
metadata_ strtype - The type of external metadata of the clients to match. Defaults to
cimd. Possible values: [cimd].
- external
Metadata StringCreated By - The creator of the clients to match. Defaults to
client, which means the client was registered dynamically. Possible values: [client]. - external
Metadata StringType - The type of external metadata of the clients to match. Defaults to
cimd. Possible values: [cimd].
GetClientProfileClientConfiguration
- Organization
Discovery List<GetMethods Client Profile Client Configuration Organization Discovery Method> - Methods used to discover the organization during login. Requires the
organizationRequireBehaviordefault value to bepreLoginPrompt. - Organization
Require List<GetBehaviors Client Profile Client Configuration Organization Require Behavior> - Defines how to proceed during an authentication transaction when the organization usage is
require. - Organization
Usages List<GetClient Profile Client Configuration Organization Usage> - Whether matched clients can use organizations.
- Refresh
Tokens List<GetClient Profile Client Configuration Refresh Token> - Refresh token settings applied to matched clients. Auth0 replaces this block as a whole, so removing it clears all of its settings.
- Require
Proof List<GetOf Possessions Client Profile Client Configuration Require Proof Of Possession> - Whether matched clients must use proof of possession (DPoP) for their tokens.
- Organization
Discovery []GetMethods Client Profile Client Configuration Organization Discovery Method - Methods used to discover the organization during login. Requires the
organizationRequireBehaviordefault value to bepreLoginPrompt. - Organization
Require []GetBehaviors Client Profile Client Configuration Organization Require Behavior - Defines how to proceed during an authentication transaction when the organization usage is
require. - Organization
Usages []GetClient Profile Client Configuration Organization Usage - Whether matched clients can use organizations.
- Refresh
Tokens []GetClient Profile Client Configuration Refresh Token - Refresh token settings applied to matched clients. Auth0 replaces this block as a whole, so removing it clears all of its settings.
- Require
Proof []GetOf Possessions Client Profile Client Configuration Require Proof Of Possession - Whether matched clients must use proof of possession (DPoP) for their tokens.
- organization_
discovery_ list(object)methods - Methods used to discover the organization during login. Requires the
organizationRequireBehaviordefault value to bepreLoginPrompt. - organization_
require_ list(object)behaviors - Defines how to proceed during an authentication transaction when the organization usage is
require. - organization_
usages list(object) - Whether matched clients can use organizations.
- refresh_
tokens list(object) - Refresh token settings applied to matched clients. Auth0 replaces this block as a whole, so removing it clears all of its settings.
- require_
proof_ list(object)of_ possessions - Whether matched clients must use proof of possession (DPoP) for their tokens.
- organization
Discovery List<GetMethods Client Profile Client Configuration Organization Discovery Method> - Methods used to discover the organization during login. Requires the
organizationRequireBehaviordefault value to bepreLoginPrompt. - organization
Require List<GetBehaviors Client Profile Client Configuration Organization Require Behavior> - Defines how to proceed during an authentication transaction when the organization usage is
require. - organization
Usages List<GetClient Profile Client Configuration Organization Usage> - Whether matched clients can use organizations.
- refresh
Tokens List<GetClient Profile Client Configuration Refresh Token> - Refresh token settings applied to matched clients. Auth0 replaces this block as a whole, so removing it clears all of its settings.
- require
Proof List<GetOf Possessions Client Profile Client Configuration Require Proof Of Possession> - Whether matched clients must use proof of possession (DPoP) for their tokens.
- organization
Discovery GetMethods Client Profile Client Configuration Organization Discovery Method[] - Methods used to discover the organization during login. Requires the
organizationRequireBehaviordefault value to bepreLoginPrompt. - organization
Require GetBehaviors Client Profile Client Configuration Organization Require Behavior[] - Defines how to proceed during an authentication transaction when the organization usage is
require. - organization
Usages GetClient Profile Client Configuration Organization Usage[] - Whether matched clients can use organizations.
- refresh
Tokens GetClient Profile Client Configuration Refresh Token[] - Refresh token settings applied to matched clients. Auth0 replaces this block as a whole, so removing it clears all of its settings.
- require
Proof GetOf Possessions Client Profile Client Configuration Require Proof Of Possession[] - Whether matched clients must use proof of possession (DPoP) for their tokens.
- organization_
discovery_ Sequence[Getmethods Client Profile Client Configuration Organization Discovery Method] - Methods used to discover the organization during login. Requires the
organizationRequireBehaviordefault value to bepreLoginPrompt. - organization_
require_ Sequence[Getbehaviors Client Profile Client Configuration Organization Require Behavior] - Defines how to proceed during an authentication transaction when the organization usage is
require. - organization_
usages Sequence[GetClient Profile Client Configuration Organization Usage] - Whether matched clients can use organizations.
- refresh_
tokens Sequence[GetClient Profile Client Configuration Refresh Token] - Refresh token settings applied to matched clients. Auth0 replaces this block as a whole, so removing it clears all of its settings.
- require_
proof_ Sequence[Getof_ possessions Client Profile Client Configuration Require Proof Of Possession] - Whether matched clients must use proof of possession (DPoP) for their tokens.
- organization
Discovery List<Property Map>Methods - Methods used to discover the organization during login. Requires the
organizationRequireBehaviordefault value to bepreLoginPrompt. - organization
Require List<Property Map>Behaviors - Defines how to proceed during an authentication transaction when the organization usage is
require. - organization
Usages List<Property Map> - Whether matched clients can use organizations.
- refresh
Tokens List<Property Map> - Refresh token settings applied to matched clients. Auth0 replaces this block as a whole, so removing it clears all of its settings.
- require
Proof List<Property Map>Of Possessions - Whether matched clients must use proof of possession (DPoP) for their tokens.
GetClientProfileClientConfigurationOrganizationDiscoveryMethod
- Default
Values List<string> - Possible values: [email organizationName].
- Default
Values []string - Possible values: [email organizationName].
- default_
values list(string) - Possible values: [email organizationName].
- default
Values List<String> - Possible values: [email organizationName].
- default
Values string[] - Possible values: [email organizationName].
- default_
values Sequence[str] - Possible values: [email organizationName].
- default
Values List<String> - Possible values: [email organizationName].
GetClientProfileClientConfigurationOrganizationRequireBehavior
- Default
Value string - Possible values: [noPrompt pre_login_prompt postLoginPrompt].
- Default
Value string - Possible values: [noPrompt pre_login_prompt postLoginPrompt].
- default_
value string - Possible values: [noPrompt pre_login_prompt postLoginPrompt].
- default
Value String - Possible values: [noPrompt pre_login_prompt postLoginPrompt].
- default
Value string - Possible values: [noPrompt pre_login_prompt postLoginPrompt].
- default_
value str - Possible values: [noPrompt pre_login_prompt postLoginPrompt].
- default
Value String - Possible values: [noPrompt pre_login_prompt postLoginPrompt].
GetClientProfileClientConfigurationOrganizationUsage
- Default
Value string - Possible values: [deny allow require].
- Default
Value string - Possible values: [deny allow require].
- default_
value string - Possible values: [deny allow require].
- default
Value String - Possible values: [deny allow require].
- default
Value string - Possible values: [deny allow require].
- default_
value str - Possible values: [deny allow require].
- default
Value String - Possible values: [deny allow require].
GetClientProfileClientConfigurationRefreshToken
- Idle
Token List<GetLifetimes Client Profile Client Configuration Refresh Token Idle Token Lifetime> - The inactivity lifetime of a refresh token. It must not exceed
tokenLifetime. If only one oftokenLifetimeandidleTokenLifetimeis set, Auth0 derives the other. - Leeways
List<Get
Client Profile Client Configuration Refresh Token Leeway> - The period in which a refresh token may be reused without triggering reuse detection.
- Token
Lifetimes List<GetClient Profile Client Configuration Refresh Token Token Lifetime> - The absolute lifetime of a refresh token. If only one of
tokenLifetimeandidleTokenLifetimeis set, Auth0 derives the other.
- Idle
Token []GetLifetimes Client Profile Client Configuration Refresh Token Idle Token Lifetime - The inactivity lifetime of a refresh token. It must not exceed
tokenLifetime. If only one oftokenLifetimeandidleTokenLifetimeis set, Auth0 derives the other. - Leeways
[]Get
Client Profile Client Configuration Refresh Token Leeway - The period in which a refresh token may be reused without triggering reuse detection.
- Token
Lifetimes []GetClient Profile Client Configuration Refresh Token Token Lifetime - The absolute lifetime of a refresh token. If only one of
tokenLifetimeandidleTokenLifetimeis set, Auth0 derives the other.
- idle_
token_ list(object)lifetimes - The inactivity lifetime of a refresh token. It must not exceed
tokenLifetime. If only one oftokenLifetimeandidleTokenLifetimeis set, Auth0 derives the other. - leeways list(object)
- The period in which a refresh token may be reused without triggering reuse detection.
- token_
lifetimes list(object) - The absolute lifetime of a refresh token. If only one of
tokenLifetimeandidleTokenLifetimeis set, Auth0 derives the other.
- idle
Token List<GetLifetimes Client Profile Client Configuration Refresh Token Idle Token Lifetime> - The inactivity lifetime of a refresh token. It must not exceed
tokenLifetime. If only one oftokenLifetimeandidleTokenLifetimeis set, Auth0 derives the other. - leeways
List<Get
Client Profile Client Configuration Refresh Token Leeway> - The period in which a refresh token may be reused without triggering reuse detection.
- token
Lifetimes List<GetClient Profile Client Configuration Refresh Token Token Lifetime> - The absolute lifetime of a refresh token. If only one of
tokenLifetimeandidleTokenLifetimeis set, Auth0 derives the other.
- idle
Token GetLifetimes Client Profile Client Configuration Refresh Token Idle Token Lifetime[] - The inactivity lifetime of a refresh token. It must not exceed
tokenLifetime. If only one oftokenLifetimeandidleTokenLifetimeis set, Auth0 derives the other. - leeways
Get
Client Profile Client Configuration Refresh Token Leeway[] - The period in which a refresh token may be reused without triggering reuse detection.
- token
Lifetimes GetClient Profile Client Configuration Refresh Token Token Lifetime[] - The absolute lifetime of a refresh token. If only one of
tokenLifetimeandidleTokenLifetimeis set, Auth0 derives the other.
- idle_
token_ Sequence[Getlifetimes Client Profile Client Configuration Refresh Token Idle Token Lifetime] - The inactivity lifetime of a refresh token. It must not exceed
tokenLifetime. If only one oftokenLifetimeandidleTokenLifetimeis set, Auth0 derives the other. - leeways
Sequence[Get
Client Profile Client Configuration Refresh Token Leeway] - The period in which a refresh token may be reused without triggering reuse detection.
- token_
lifetimes Sequence[GetClient Profile Client Configuration Refresh Token Token Lifetime] - The absolute lifetime of a refresh token. If only one of
tokenLifetimeandidleTokenLifetimeis set, Auth0 derives the other.
- idle
Token List<Property Map>Lifetimes - The inactivity lifetime of a refresh token. It must not exceed
tokenLifetime. If only one oftokenLifetimeandidleTokenLifetimeis set, Auth0 derives the other. - leeways List<Property Map>
- The period in which a refresh token may be reused without triggering reuse detection.
- token
Lifetimes List<Property Map> - The absolute lifetime of a refresh token. If only one of
tokenLifetimeandidleTokenLifetimeis set, Auth0 derives the other.
GetClientProfileClientConfigurationRefreshTokenIdleTokenLifetime
- Default
Value int - The lifetime in seconds.
- Default
Value int - The lifetime in seconds.
- default_
value number - The lifetime in seconds.
- default
Value Integer - The lifetime in seconds.
- default
Value number - The lifetime in seconds.
- default_
value int - The lifetime in seconds.
- default
Value Number - The lifetime in seconds.
GetClientProfileClientConfigurationRefreshTokenLeeway
- Default
Value int - The leeway in seconds.
0disables the leeway.
- Default
Value int - The leeway in seconds.
0disables the leeway.
- default_
value number - The leeway in seconds.
0disables the leeway.
- default
Value Integer - The leeway in seconds.
0disables the leeway.
- default
Value number - The leeway in seconds.
0disables the leeway.
- default_
value int - The leeway in seconds.
0disables the leeway.
- default
Value Number - The leeway in seconds.
0disables the leeway.
GetClientProfileClientConfigurationRefreshTokenTokenLifetime
- Default
Value int - The lifetime in seconds.
- Default
Value int - The lifetime in seconds.
- default_
value number - The lifetime in seconds.
- default
Value Integer - The lifetime in seconds.
- default
Value number - The lifetime in seconds.
- default_
value int - The lifetime in seconds.
- default
Value Number - The lifetime in seconds.
GetClientProfileClientConfigurationRequireProofOfPossession
- Default
Value bool - Whether proof of possession is required.
- Default
Value bool - Whether proof of possession is required.
- default_
value bool - Whether proof of possession is required.
- default
Value Boolean - Whether proof of possession is required.
- default
Value boolean - Whether proof of possession is required.
- default_
value bool - Whether proof of possession is required.
- default
Value Boolean - Whether proof of possession is required.
Package Details
- Repository
- Auth0 pulumi/pulumi-auth0
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
auth0Terraform Provider.
Viewing docs for Auth0 v3.56.0
published on Friday, Nov 6, 2026 by Pulumi
published on Friday, Nov 6, 2026 by Pulumi