1. Packages
  2. Auth0
  3. API Docs
  4. getClient
Auth0 v3.0.0 published on Wednesday, Oct 4, 2023 by Pulumi

auth0.getClient

Explore with Pulumi AI

auth0 logo
Auth0 v3.0.0 published on Wednesday, Oct 4, 2023 by Pulumi

    Data source to retrieve a specific Auth0 application client by client_id or name.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Auth0 = Pulumi.Auth0;
    
    return await Deployment.RunAsync(() => 
    {
        var some_client_by_name = Auth0.GetClient.Invoke(new()
        {
            Name = "Name of my Application",
        });
    
        var some_client_by_id = Auth0.GetClient.Invoke(new()
        {
            ClientId = "abcdefghkijklmnopqrstuvwxyz0123456789",
        });
    
    });
    
    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.LookupClient(ctx, &auth0.LookupClientArgs{
    			Name: pulumi.StringRef("Name of my Application"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = auth0.LookupClient(ctx, &auth0.LookupClientArgs{
    			ClientId: pulumi.StringRef("abcdefghkijklmnopqrstuvwxyz0123456789"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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.GetClientArgs;
    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) {
            final var some-client-by-name = Auth0Functions.getClient(GetClientArgs.builder()
                .name("Name of my Application")
                .build());
    
            final var some-client-by-id = Auth0Functions.getClient(GetClientArgs.builder()
                .clientId("abcdefghkijklmnopqrstuvwxyz0123456789")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_auth0 as auth0
    
    some_client_by_name = auth0.get_client(name="Name of my Application")
    some_client_by_id = auth0.get_client(client_id="abcdefghkijklmnopqrstuvwxyz0123456789")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as auth0 from "@pulumi/auth0";
    
    const some-client-by-name = auth0.getClient({
        name: "Name of my Application",
    });
    const some-client-by-id = auth0.getClient({
        clientId: "abcdefghkijklmnopqrstuvwxyz0123456789",
    });
    
    variables:
      some-client-by-name:
        fn::invoke:
          Function: auth0:getClient
          Arguments:
            name: Name of my Application
      some-client-by-id:
        fn::invoke:
          Function: auth0:getClient
          Arguments:
            clientId: abcdefghkijklmnopqrstuvwxyz0123456789
    

    Using getClient

    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 getClient(args: GetClientArgs, opts?: InvokeOptions): Promise<GetClientResult>
    function getClientOutput(args: GetClientOutputArgs, opts?: InvokeOptions): Output<GetClientResult>
    def get_client(client_id: Optional[str] = None,
                   name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetClientResult
    def get_client_output(client_id: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetClientResult]
    func LookupClient(ctx *Context, args *LookupClientArgs, opts ...InvokeOption) (*LookupClientResult, error)
    func LookupClientOutput(ctx *Context, args *LookupClientOutputArgs, opts ...InvokeOption) LookupClientResultOutput

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

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

    The following arguments are supported:

    ClientId string

    The ID of the client. If not provided, name must be set.

    Name string

    The name of the client. If not provided, client_id must be set.

    ClientId string

    The ID of the client. If not provided, name must be set.

    Name string

    The name of the client. If not provided, client_id must be set.

    clientId String

    The ID of the client. If not provided, name must be set.

    name String

    The name of the client. If not provided, client_id must be set.

    clientId string

    The ID of the client. If not provided, name must be set.

    name string

    The name of the client. If not provided, client_id must be set.

    client_id str

    The ID of the client. If not provided, name must be set.

    name str

    The name of the client. If not provided, client_id must be set.

    clientId String

    The ID of the client. If not provided, name must be set.

    name String

    The name of the client. If not provided, client_id must be set.

    getClient Result

    The following output properties are available:

    Addons List<GetClientAddon>

    Addons enabled for this client and their associated configurations.

    AllowedClients List<string>

    List of applications ID's that will be allowed to make delegation request. By default, all applications will be allowed.

    AllowedLogoutUrls List<string>

    URLs that Auth0 may redirect to after logout.

    AllowedOrigins List<string>

    URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.

    AppType string

    Type of application the client represents. Possible values are: native, spa, regular_web, non_interactive, sso_integration. Specific SSO integrations types accepted as well are: rms, box, cloudbees, concur, dropbox, mscrm, echosign, egnyte, newrelic, office365, salesforce, sentry, sharepoint, slack, springcm, zendesk, zoom.

    Callbacks List<string>

    URLs that Auth0 may call back to after a user authenticates for the client. Make sure to specify the protocol (https://) otherwise the callback may fail in some cases. With the exception of custom URI schemes for native clients, all callbacks should use protocol https://.

    ClientAliases List<string>

    List of audiences/realms for SAML protocol. Used by the wsfed addon.

    ClientMetadata Dictionary<string, object>

    Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters: :,-+=_*?"/\()<>@ [Tab] [Space].

    ClientSecret string
    CrossOriginAuth bool

    Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false).

    CrossOriginLoc string

    URL of the location in your site where the cross-origin verification takes place for the cross-origin auth flow when performing authentication in your own domain instead of Auth0 Universal Login page.

    CustomLoginPage string

    The content (HTML, CSS, JS) of the custom login page.

    CustomLoginPageOn bool

    Indicates whether a custom login page is to be used.

    Description string

    Description of the purpose of the client.

    EncryptionKey Dictionary<string, string>

    Encryption used for WS-Fed responses with this client.

    FormTemplate string

    HTML form template to be used for WS-Federation.

    GrantTypes List<string>

    Types of grants that this client is authorized to use.

    Id string

    The provider-assigned unique ID for this managed resource.

    InitiateLoginUri string

    Initiate login URI. Must be HTTPS or an empty string.

    IsFirstParty bool

    Indicates whether this client is a first-party client.

    IsTokenEndpointIpHeaderTrusted bool

    Indicates whether the token endpoint IP header is trusted. Requires the authentication method to be set to client_secret_post or client_secret_basic. Setting this property when creating the resource, will default the authentication method to client_secret_post. To change the authentication method to client_secret_basic use the auth0.ClientCredentials resource.

    JwtConfigurations List<GetClientJwtConfiguration>

    Configuration settings for the JWTs issued for this client.

    LogoUri string

    URL of the logo for the client. Recommended size is 150px x 150px. If none is set, the default badge for the application type will be shown.

    Mobiles List<GetClientMobile>

    Additional configuration for native mobile apps.

    NativeSocialLogins List<GetClientNativeSocialLogin>

    Configuration settings to toggle native social login for mobile native applications. Once this is set it must stay set, with both resources set to false in order to change the app_type.

    OidcBackchannelLogoutUrls List<string>

    Set of URLs that are valid to call back from Auth0 for OIDC backchannel logout. Currently only one URL is allowed.

    OidcConformant bool

    Indicates whether this client will conform to strict OIDC specifications.

    OrganizationRequireBehavior string

    Defines how to proceed during an authentication transaction when organization_usage = "require". Can be no_prompt (default), pre_login_prompt or post_login_prompt.

    OrganizationUsage string

    Defines how to proceed during an authentication transaction with regards to an organization. Can be deny (default), allow or require.

    RefreshTokens List<GetClientRefreshToken>

    Configuration settings for the refresh tokens issued for this client.

    RequirePushedAuthorizationRequests bool

    Makes the use of Pushed Authorization Requests mandatory for this client.

    SigningKeys List<ImmutableDictionary<string, object>>

    List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.

    Sso bool

    Applies only to SSO clients and determines whether Auth0 will handle Single Sign-On (true) or whether the identity provider will (false).

    SsoDisabled bool

    Indicates whether or not SSO is disabled.

    TokenEndpointAuthMethod string

    The authentication method for the token endpoint. Results include none (public client without a client secret), client_secret_post (client uses HTTP POST parameters), client_secret_basic (client uses HTTP Basic). Managing a client's authentication method can be done via the auth0.ClientCredentials resource.

    WebOrigins List<string>

    URLs that represent valid web origins for use with web message response mode.

    ClientId string

    The ID of the client. If not provided, name must be set.

    Name string

    The name of the client. If not provided, client_id must be set.

    Addons []GetClientAddon

    Addons enabled for this client and their associated configurations.

    AllowedClients []string

    List of applications ID's that will be allowed to make delegation request. By default, all applications will be allowed.

    AllowedLogoutUrls []string

    URLs that Auth0 may redirect to after logout.

    AllowedOrigins []string

    URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.

    AppType string

    Type of application the client represents. Possible values are: native, spa, regular_web, non_interactive, sso_integration. Specific SSO integrations types accepted as well are: rms, box, cloudbees, concur, dropbox, mscrm, echosign, egnyte, newrelic, office365, salesforce, sentry, sharepoint, slack, springcm, zendesk, zoom.

    Callbacks []string

    URLs that Auth0 may call back to after a user authenticates for the client. Make sure to specify the protocol (https://) otherwise the callback may fail in some cases. With the exception of custom URI schemes for native clients, all callbacks should use protocol https://.

    ClientAliases []string

    List of audiences/realms for SAML protocol. Used by the wsfed addon.

    ClientMetadata map[string]interface{}

    Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters: :,-+=_*?"/\()<>@ [Tab] [Space].

    ClientSecret string
    CrossOriginAuth bool

    Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false).

    CrossOriginLoc string

    URL of the location in your site where the cross-origin verification takes place for the cross-origin auth flow when performing authentication in your own domain instead of Auth0 Universal Login page.

    CustomLoginPage string

    The content (HTML, CSS, JS) of the custom login page.

    CustomLoginPageOn bool

    Indicates whether a custom login page is to be used.

    Description string

    Description of the purpose of the client.

    EncryptionKey map[string]string

    Encryption used for WS-Fed responses with this client.

    FormTemplate string

    HTML form template to be used for WS-Federation.

    GrantTypes []string

    Types of grants that this client is authorized to use.

    Id string

    The provider-assigned unique ID for this managed resource.

    InitiateLoginUri string

    Initiate login URI. Must be HTTPS or an empty string.

    IsFirstParty bool

    Indicates whether this client is a first-party client.

    IsTokenEndpointIpHeaderTrusted bool

    Indicates whether the token endpoint IP header is trusted. Requires the authentication method to be set to client_secret_post or client_secret_basic. Setting this property when creating the resource, will default the authentication method to client_secret_post. To change the authentication method to client_secret_basic use the auth0.ClientCredentials resource.

    JwtConfigurations []GetClientJwtConfiguration

    Configuration settings for the JWTs issued for this client.

    LogoUri string

    URL of the logo for the client. Recommended size is 150px x 150px. If none is set, the default badge for the application type will be shown.

    Mobiles []GetClientMobile

    Additional configuration for native mobile apps.

    NativeSocialLogins []GetClientNativeSocialLogin

    Configuration settings to toggle native social login for mobile native applications. Once this is set it must stay set, with both resources set to false in order to change the app_type.

    OidcBackchannelLogoutUrls []string

    Set of URLs that are valid to call back from Auth0 for OIDC backchannel logout. Currently only one URL is allowed.

    OidcConformant bool

    Indicates whether this client will conform to strict OIDC specifications.

    OrganizationRequireBehavior string

    Defines how to proceed during an authentication transaction when organization_usage = "require". Can be no_prompt (default), pre_login_prompt or post_login_prompt.

    OrganizationUsage string

    Defines how to proceed during an authentication transaction with regards to an organization. Can be deny (default), allow or require.

    RefreshTokens []GetClientRefreshToken

    Configuration settings for the refresh tokens issued for this client.

    RequirePushedAuthorizationRequests bool

    Makes the use of Pushed Authorization Requests mandatory for this client.

    SigningKeys []map[string]interface{}

    List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.

    Sso bool

    Applies only to SSO clients and determines whether Auth0 will handle Single Sign-On (true) or whether the identity provider will (false).

    SsoDisabled bool

    Indicates whether or not SSO is disabled.

    TokenEndpointAuthMethod string

    The authentication method for the token endpoint. Results include none (public client without a client secret), client_secret_post (client uses HTTP POST parameters), client_secret_basic (client uses HTTP Basic). Managing a client's authentication method can be done via the auth0.ClientCredentials resource.

    WebOrigins []string

    URLs that represent valid web origins for use with web message response mode.

    ClientId string

    The ID of the client. If not provided, name must be set.

    Name string

    The name of the client. If not provided, client_id must be set.

    addons List<GetClientAddon>

    Addons enabled for this client and their associated configurations.

    allowedClients List<String>

    List of applications ID's that will be allowed to make delegation request. By default, all applications will be allowed.

    allowedLogoutUrls List<String>

    URLs that Auth0 may redirect to after logout.

    allowedOrigins List<String>

    URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.

    appType String

    Type of application the client represents. Possible values are: native, spa, regular_web, non_interactive, sso_integration. Specific SSO integrations types accepted as well are: rms, box, cloudbees, concur, dropbox, mscrm, echosign, egnyte, newrelic, office365, salesforce, sentry, sharepoint, slack, springcm, zendesk, zoom.

    callbacks List<String>

    URLs that Auth0 may call back to after a user authenticates for the client. Make sure to specify the protocol (https://) otherwise the callback may fail in some cases. With the exception of custom URI schemes for native clients, all callbacks should use protocol https://.

    clientAliases List<String>

    List of audiences/realms for SAML protocol. Used by the wsfed addon.

    clientMetadata Map<String,Object>

    Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters: :,-+=_*?"/\()<>@ [Tab] [Space].

    clientSecret String
    crossOriginAuth Boolean

    Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false).

    crossOriginLoc String

    URL of the location in your site where the cross-origin verification takes place for the cross-origin auth flow when performing authentication in your own domain instead of Auth0 Universal Login page.

    customLoginPage String

    The content (HTML, CSS, JS) of the custom login page.

    customLoginPageOn Boolean

    Indicates whether a custom login page is to be used.

    description String

    Description of the purpose of the client.

    encryptionKey Map<String,String>

    Encryption used for WS-Fed responses with this client.

    formTemplate String

    HTML form template to be used for WS-Federation.

    grantTypes List<String>

    Types of grants that this client is authorized to use.

    id String

    The provider-assigned unique ID for this managed resource.

    initiateLoginUri String

    Initiate login URI. Must be HTTPS or an empty string.

    isFirstParty Boolean

    Indicates whether this client is a first-party client.

    isTokenEndpointIpHeaderTrusted Boolean

    Indicates whether the token endpoint IP header is trusted. Requires the authentication method to be set to client_secret_post or client_secret_basic. Setting this property when creating the resource, will default the authentication method to client_secret_post. To change the authentication method to client_secret_basic use the auth0.ClientCredentials resource.

    jwtConfigurations List<GetClientJwtConfiguration>

    Configuration settings for the JWTs issued for this client.

    logoUri String

    URL of the logo for the client. Recommended size is 150px x 150px. If none is set, the default badge for the application type will be shown.

    mobiles List<GetClientMobile>

    Additional configuration for native mobile apps.

    nativeSocialLogins List<GetClientNativeSocialLogin>

    Configuration settings to toggle native social login for mobile native applications. Once this is set it must stay set, with both resources set to false in order to change the app_type.

    oidcBackchannelLogoutUrls List<String>

    Set of URLs that are valid to call back from Auth0 for OIDC backchannel logout. Currently only one URL is allowed.

    oidcConformant Boolean

    Indicates whether this client will conform to strict OIDC specifications.

    organizationRequireBehavior String

    Defines how to proceed during an authentication transaction when organization_usage = "require". Can be no_prompt (default), pre_login_prompt or post_login_prompt.

    organizationUsage String

    Defines how to proceed during an authentication transaction with regards to an organization. Can be deny (default), allow or require.

    refreshTokens List<GetClientRefreshToken>

    Configuration settings for the refresh tokens issued for this client.

    requirePushedAuthorizationRequests Boolean

    Makes the use of Pushed Authorization Requests mandatory for this client.

    signingKeys List<Map<String,Object>>

    List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.

    sso Boolean

    Applies only to SSO clients and determines whether Auth0 will handle Single Sign-On (true) or whether the identity provider will (false).

    ssoDisabled Boolean

    Indicates whether or not SSO is disabled.

    tokenEndpointAuthMethod String

    The authentication method for the token endpoint. Results include none (public client without a client secret), client_secret_post (client uses HTTP POST parameters), client_secret_basic (client uses HTTP Basic). Managing a client's authentication method can be done via the auth0.ClientCredentials resource.

    webOrigins List<String>

    URLs that represent valid web origins for use with web message response mode.

    clientId String

    The ID of the client. If not provided, name must be set.

    name String

    The name of the client. If not provided, client_id must be set.

    addons GetClientAddon[]

    Addons enabled for this client and their associated configurations.

    allowedClients string[]

    List of applications ID's that will be allowed to make delegation request. By default, all applications will be allowed.

    allowedLogoutUrls string[]

    URLs that Auth0 may redirect to after logout.

    allowedOrigins string[]

    URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.

    appType string

    Type of application the client represents. Possible values are: native, spa, regular_web, non_interactive, sso_integration. Specific SSO integrations types accepted as well are: rms, box, cloudbees, concur, dropbox, mscrm, echosign, egnyte, newrelic, office365, salesforce, sentry, sharepoint, slack, springcm, zendesk, zoom.

    callbacks string[]

    URLs that Auth0 may call back to after a user authenticates for the client. Make sure to specify the protocol (https://) otherwise the callback may fail in some cases. With the exception of custom URI schemes for native clients, all callbacks should use protocol https://.

    clientAliases string[]

    List of audiences/realms for SAML protocol. Used by the wsfed addon.

    clientMetadata {[key: string]: any}

    Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters: :,-+=_*?"/\()<>@ [Tab] [Space].

    clientSecret string
    crossOriginAuth boolean

    Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false).

    crossOriginLoc string

    URL of the location in your site where the cross-origin verification takes place for the cross-origin auth flow when performing authentication in your own domain instead of Auth0 Universal Login page.

    customLoginPage string

    The content (HTML, CSS, JS) of the custom login page.

    customLoginPageOn boolean

    Indicates whether a custom login page is to be used.

    description string

    Description of the purpose of the client.

    encryptionKey {[key: string]: string}

    Encryption used for WS-Fed responses with this client.

    formTemplate string

    HTML form template to be used for WS-Federation.

    grantTypes string[]

    Types of grants that this client is authorized to use.

    id string

    The provider-assigned unique ID for this managed resource.

    initiateLoginUri string

    Initiate login URI. Must be HTTPS or an empty string.

    isFirstParty boolean

    Indicates whether this client is a first-party client.

    isTokenEndpointIpHeaderTrusted boolean

    Indicates whether the token endpoint IP header is trusted. Requires the authentication method to be set to client_secret_post or client_secret_basic. Setting this property when creating the resource, will default the authentication method to client_secret_post. To change the authentication method to client_secret_basic use the auth0.ClientCredentials resource.

    jwtConfigurations GetClientJwtConfiguration[]

    Configuration settings for the JWTs issued for this client.

    logoUri string

    URL of the logo for the client. Recommended size is 150px x 150px. If none is set, the default badge for the application type will be shown.

    mobiles GetClientMobile[]

    Additional configuration for native mobile apps.

    nativeSocialLogins GetClientNativeSocialLogin[]

    Configuration settings to toggle native social login for mobile native applications. Once this is set it must stay set, with both resources set to false in order to change the app_type.

    oidcBackchannelLogoutUrls string[]

    Set of URLs that are valid to call back from Auth0 for OIDC backchannel logout. Currently only one URL is allowed.

    oidcConformant boolean

    Indicates whether this client will conform to strict OIDC specifications.

    organizationRequireBehavior string

    Defines how to proceed during an authentication transaction when organization_usage = "require". Can be no_prompt (default), pre_login_prompt or post_login_prompt.

    organizationUsage string

    Defines how to proceed during an authentication transaction with regards to an organization. Can be deny (default), allow or require.

    refreshTokens GetClientRefreshToken[]

    Configuration settings for the refresh tokens issued for this client.

    requirePushedAuthorizationRequests boolean

    Makes the use of Pushed Authorization Requests mandatory for this client.

    signingKeys {[key: string]: any}[]

    List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.

    sso boolean

    Applies only to SSO clients and determines whether Auth0 will handle Single Sign-On (true) or whether the identity provider will (false).

    ssoDisabled boolean

    Indicates whether or not SSO is disabled.

    tokenEndpointAuthMethod string

    The authentication method for the token endpoint. Results include none (public client without a client secret), client_secret_post (client uses HTTP POST parameters), client_secret_basic (client uses HTTP Basic). Managing a client's authentication method can be done via the auth0.ClientCredentials resource.

    webOrigins string[]

    URLs that represent valid web origins for use with web message response mode.

    clientId string

    The ID of the client. If not provided, name must be set.

    name string

    The name of the client. If not provided, client_id must be set.

    addons Sequence[GetClientAddon]

    Addons enabled for this client and their associated configurations.

    allowed_clients Sequence[str]

    List of applications ID's that will be allowed to make delegation request. By default, all applications will be allowed.

    allowed_logout_urls Sequence[str]

    URLs that Auth0 may redirect to after logout.

    allowed_origins Sequence[str]

    URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.

    app_type str

    Type of application the client represents. Possible values are: native, spa, regular_web, non_interactive, sso_integration. Specific SSO integrations types accepted as well are: rms, box, cloudbees, concur, dropbox, mscrm, echosign, egnyte, newrelic, office365, salesforce, sentry, sharepoint, slack, springcm, zendesk, zoom.

    callbacks Sequence[str]

    URLs that Auth0 may call back to after a user authenticates for the client. Make sure to specify the protocol (https://) otherwise the callback may fail in some cases. With the exception of custom URI schemes for native clients, all callbacks should use protocol https://.

    client_aliases Sequence[str]

    List of audiences/realms for SAML protocol. Used by the wsfed addon.

    client_metadata Mapping[str, Any]

    Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters: :,-+=_*?"/\()<>@ [Tab] [Space].

    client_secret str
    cross_origin_auth bool

    Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false).

    cross_origin_loc str

    URL of the location in your site where the cross-origin verification takes place for the cross-origin auth flow when performing authentication in your own domain instead of Auth0 Universal Login page.

    custom_login_page str

    The content (HTML, CSS, JS) of the custom login page.

    custom_login_page_on bool

    Indicates whether a custom login page is to be used.

    description str

    Description of the purpose of the client.

    encryption_key Mapping[str, str]

    Encryption used for WS-Fed responses with this client.

    form_template str

    HTML form template to be used for WS-Federation.

    grant_types Sequence[str]

    Types of grants that this client is authorized to use.

    id str

    The provider-assigned unique ID for this managed resource.

    initiate_login_uri str

    Initiate login URI. Must be HTTPS or an empty string.

    is_first_party bool

    Indicates whether this client is a first-party client.

    is_token_endpoint_ip_header_trusted bool

    Indicates whether the token endpoint IP header is trusted. Requires the authentication method to be set to client_secret_post or client_secret_basic. Setting this property when creating the resource, will default the authentication method to client_secret_post. To change the authentication method to client_secret_basic use the auth0.ClientCredentials resource.

    jwt_configurations Sequence[GetClientJwtConfiguration]

    Configuration settings for the JWTs issued for this client.

    logo_uri str

    URL of the logo for the client. Recommended size is 150px x 150px. If none is set, the default badge for the application type will be shown.

    mobiles Sequence[GetClientMobile]

    Additional configuration for native mobile apps.

    native_social_logins Sequence[GetClientNativeSocialLogin]

    Configuration settings to toggle native social login for mobile native applications. Once this is set it must stay set, with both resources set to false in order to change the app_type.

    oidc_backchannel_logout_urls Sequence[str]

    Set of URLs that are valid to call back from Auth0 for OIDC backchannel logout. Currently only one URL is allowed.

    oidc_conformant bool

    Indicates whether this client will conform to strict OIDC specifications.

    organization_require_behavior str

    Defines how to proceed during an authentication transaction when organization_usage = "require". Can be no_prompt (default), pre_login_prompt or post_login_prompt.

    organization_usage str

    Defines how to proceed during an authentication transaction with regards to an organization. Can be deny (default), allow or require.

    refresh_tokens Sequence[GetClientRefreshToken]

    Configuration settings for the refresh tokens issued for this client.

    require_pushed_authorization_requests bool

    Makes the use of Pushed Authorization Requests mandatory for this client.

    signing_keys Sequence[Mapping[str, Any]]

    List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.

    sso bool

    Applies only to SSO clients and determines whether Auth0 will handle Single Sign-On (true) or whether the identity provider will (false).

    sso_disabled bool

    Indicates whether or not SSO is disabled.

    token_endpoint_auth_method str

    The authentication method for the token endpoint. Results include none (public client without a client secret), client_secret_post (client uses HTTP POST parameters), client_secret_basic (client uses HTTP Basic). Managing a client's authentication method can be done via the auth0.ClientCredentials resource.

    web_origins Sequence[str]

    URLs that represent valid web origins for use with web message response mode.

    client_id str

    The ID of the client. If not provided, name must be set.

    name str

    The name of the client. If not provided, client_id must be set.

    addons List<Property Map>

    Addons enabled for this client and their associated configurations.

    allowedClients List<String>

    List of applications ID's that will be allowed to make delegation request. By default, all applications will be allowed.

    allowedLogoutUrls List<String>

    URLs that Auth0 may redirect to after logout.

    allowedOrigins List<String>

    URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed.

    appType String

    Type of application the client represents. Possible values are: native, spa, regular_web, non_interactive, sso_integration. Specific SSO integrations types accepted as well are: rms, box, cloudbees, concur, dropbox, mscrm, echosign, egnyte, newrelic, office365, salesforce, sentry, sharepoint, slack, springcm, zendesk, zoom.

    callbacks List<String>

    URLs that Auth0 may call back to after a user authenticates for the client. Make sure to specify the protocol (https://) otherwise the callback may fail in some cases. With the exception of custom URI schemes for native clients, all callbacks should use protocol https://.

    clientAliases List<String>

    List of audiences/realms for SAML protocol. Used by the wsfed addon.

    clientMetadata Map<Any>

    Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters: :,-+=_*?"/\()<>@ [Tab] [Space].

    clientSecret String
    crossOriginAuth Boolean

    Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false).

    crossOriginLoc String

    URL of the location in your site where the cross-origin verification takes place for the cross-origin auth flow when performing authentication in your own domain instead of Auth0 Universal Login page.

    customLoginPage String

    The content (HTML, CSS, JS) of the custom login page.

    customLoginPageOn Boolean

    Indicates whether a custom login page is to be used.

    description String

    Description of the purpose of the client.

    encryptionKey Map<String>

    Encryption used for WS-Fed responses with this client.

    formTemplate String

    HTML form template to be used for WS-Federation.

    grantTypes List<String>

    Types of grants that this client is authorized to use.

    id String

    The provider-assigned unique ID for this managed resource.

    initiateLoginUri String

    Initiate login URI. Must be HTTPS or an empty string.

    isFirstParty Boolean

    Indicates whether this client is a first-party client.

    isTokenEndpointIpHeaderTrusted Boolean

    Indicates whether the token endpoint IP header is trusted. Requires the authentication method to be set to client_secret_post or client_secret_basic. Setting this property when creating the resource, will default the authentication method to client_secret_post. To change the authentication method to client_secret_basic use the auth0.ClientCredentials resource.

    jwtConfigurations List<Property Map>

    Configuration settings for the JWTs issued for this client.

    logoUri String

    URL of the logo for the client. Recommended size is 150px x 150px. If none is set, the default badge for the application type will be shown.

    mobiles List<Property Map>

    Additional configuration for native mobile apps.

    nativeSocialLogins List<Property Map>

    Configuration settings to toggle native social login for mobile native applications. Once this is set it must stay set, with both resources set to false in order to change the app_type.

    oidcBackchannelLogoutUrls List<String>

    Set of URLs that are valid to call back from Auth0 for OIDC backchannel logout. Currently only one URL is allowed.

    oidcConformant Boolean

    Indicates whether this client will conform to strict OIDC specifications.

    organizationRequireBehavior String

    Defines how to proceed during an authentication transaction when organization_usage = "require". Can be no_prompt (default), pre_login_prompt or post_login_prompt.

    organizationUsage String

    Defines how to proceed during an authentication transaction with regards to an organization. Can be deny (default), allow or require.

    refreshTokens List<Property Map>

    Configuration settings for the refresh tokens issued for this client.

    requirePushedAuthorizationRequests Boolean

    Makes the use of Pushed Authorization Requests mandatory for this client.

    signingKeys List<Map<Any>>

    List containing a map of the public cert of the signing key and the public cert of the signing key in PKCS7.

    sso Boolean

    Applies only to SSO clients and determines whether Auth0 will handle Single Sign-On (true) or whether the identity provider will (false).

    ssoDisabled Boolean

    Indicates whether or not SSO is disabled.

    tokenEndpointAuthMethod String

    The authentication method for the token endpoint. Results include none (public client without a client secret), client_secret_post (client uses HTTP POST parameters), client_secret_basic (client uses HTTP Basic). Managing a client's authentication method can be done via the auth0.ClientCredentials resource.

    webOrigins List<String>

    URLs that represent valid web origins for use with web message response mode.

    clientId String

    The ID of the client. If not provided, name must be set.

    name String

    The name of the client. If not provided, client_id must be set.

    Supporting Types

    GetClientAddon

    Aws List<GetClientAddonAw>
    AzureBlobs List<GetClientAddonAzureBlob>
    AzureSbs List<GetClientAddonAzureSb>
    Boxes List<GetClientAddonBox>
    Cloudbees List<GetClientAddonCloudbee>
    Concurs List<GetClientAddonConcur>
    Dropboxes List<GetClientAddonDropbox>
    Echosigns List<GetClientAddonEchosign>
    Egnytes List<GetClientAddonEgnyte>
    Firebases List<GetClientAddonFirebase>
    Layers List<GetClientAddonLayer>
    Mscrms List<GetClientAddonMscrm>
    Newrelics List<GetClientAddonNewrelic>
    Office365s List<GetClientAddonOffice365>
    Rms List<GetClientAddonRm>
    SalesforceApis List<GetClientAddonSalesforceApi>
    SalesforceSandboxApis List<GetClientAddonSalesforceSandboxApi>
    Salesforces List<GetClientAddonSalesforce>
    Samlps List<GetClientAddonSamlp>
    SapApis List<GetClientAddonSapApi>
    Sentries List<GetClientAddonSentry>
    Sharepoints List<GetClientAddonSharepoint>
    Slacks List<GetClientAddonSlack>
    Springcms List<GetClientAddonSpringcm>
    SsoIntegrations List<GetClientAddonSsoIntegration>
    Wams List<GetClientAddonWam>
    Wsfeds List<GetClientAddonWsfed>
    Zendesks List<GetClientAddonZendesk>
    Zooms List<GetClientAddonZoom>
    Aws []GetClientAddonAw
    AzureBlobs []GetClientAddonAzureBlob
    AzureSbs []GetClientAddonAzureSb
    Boxes []GetClientAddonBox
    Cloudbees []GetClientAddonCloudbee
    Concurs []GetClientAddonConcur
    Dropboxes []GetClientAddonDropbox
    Echosigns []GetClientAddonEchosign
    Egnytes []GetClientAddonEgnyte
    Firebases []GetClientAddonFirebase
    Layers []GetClientAddonLayer
    Mscrms []GetClientAddonMscrm
    Newrelics []GetClientAddonNewrelic
    Office365s []GetClientAddonOffice365
    Rms []GetClientAddonRm
    SalesforceApis []GetClientAddonSalesforceApi
    SalesforceSandboxApis []GetClientAddonSalesforceSandboxApi
    Salesforces []GetClientAddonSalesforce
    Samlps []GetClientAddonSamlp
    SapApis []GetClientAddonSapApi
    Sentries []GetClientAddonSentry
    Sharepoints []GetClientAddonSharepoint
    Slacks []GetClientAddonSlack
    Springcms []GetClientAddonSpringcm
    SsoIntegrations []GetClientAddonSsoIntegration
    Wams []GetClientAddonWam
    Wsfeds []GetClientAddonWsfed
    Zendesks []GetClientAddonZendesk
    Zooms []GetClientAddonZoom
    aws List<GetClientAddonAw>
    azureBlobs List<GetClientAddonAzureBlob>
    azureSbs List<GetClientAddonAzureSb>
    boxes List<GetClientAddonBox>
    cloudbees List<GetClientAddonCloudbee>
    concurs List<GetClientAddonConcur>
    dropboxes List<GetClientAddonDropbox>
    echosigns List<GetClientAddonEchosign>
    egnytes List<GetClientAddonEgnyte>
    firebases List<GetClientAddonFirebase>
    layers List<GetClientAddonLayer>
    mscrms List<GetClientAddonMscrm>
    newrelics List<GetClientAddonNewrelic>
    office365s List<GetClientAddonOffice365>
    rms List<GetClientAddonRm>
    salesforceApis List<GetClientAddonSalesforceApi>
    salesforceSandboxApis List<GetClientAddonSalesforceSandboxApi>
    salesforces List<GetClientAddonSalesforce>
    samlps List<GetClientAddonSamlp>
    sapApis List<GetClientAddonSapApi>
    sentries List<GetClientAddonSentry>
    sharepoints List<GetClientAddonSharepoint>
    slacks List<GetClientAddonSlack>
    springcms List<GetClientAddonSpringcm>
    ssoIntegrations List<GetClientAddonSsoIntegration>
    wams List<GetClientAddonWam>
    wsfeds List<GetClientAddonWsfed>
    zendesks List<GetClientAddonZendesk>
    zooms List<GetClientAddonZoom>
    aws GetClientAddonAw[]
    azureBlobs GetClientAddonAzureBlob[]
    azureSbs GetClientAddonAzureSb[]
    boxes GetClientAddonBox[]
    cloudbees GetClientAddonCloudbee[]
    concurs GetClientAddonConcur[]
    dropboxes GetClientAddonDropbox[]
    echosigns GetClientAddonEchosign[]
    egnytes GetClientAddonEgnyte[]
    firebases GetClientAddonFirebase[]
    layers GetClientAddonLayer[]
    mscrms GetClientAddonMscrm[]
    newrelics GetClientAddonNewrelic[]
    office365s GetClientAddonOffice365[]
    rms GetClientAddonRm[]
    salesforceApis GetClientAddonSalesforceApi[]
    salesforceSandboxApis GetClientAddonSalesforceSandboxApi[]
    salesforces GetClientAddonSalesforce[]
    samlps GetClientAddonSamlp[]
    sapApis GetClientAddonSapApi[]
    sentries GetClientAddonSentry[]
    sharepoints GetClientAddonSharepoint[]
    slacks GetClientAddonSlack[]
    springcms GetClientAddonSpringcm[]
    ssoIntegrations GetClientAddonSsoIntegration[]
    wams GetClientAddonWam[]
    wsfeds GetClientAddonWsfed[]
    zendesks GetClientAddonZendesk[]
    zooms GetClientAddonZoom[]
    aws Sequence[GetClientAddonAw]
    azure_blobs Sequence[GetClientAddonAzureBlob]
    azure_sbs Sequence[GetClientAddonAzureSb]
    boxes Sequence[GetClientAddonBox]
    cloudbees Sequence[GetClientAddonCloudbee]
    concurs Sequence[GetClientAddonConcur]
    dropboxes Sequence[GetClientAddonDropbox]
    echosigns Sequence[GetClientAddonEchosign]
    egnytes Sequence[GetClientAddonEgnyte]
    firebases Sequence[GetClientAddonFirebase]
    layers Sequence[GetClientAddonLayer]
    mscrms Sequence[GetClientAddonMscrm]
    newrelics Sequence[GetClientAddonNewrelic]
    office365s Sequence[GetClientAddonOffice365]
    rms Sequence[GetClientAddonRm]
    salesforce_apis Sequence[GetClientAddonSalesforceApi]
    salesforce_sandbox_apis Sequence[GetClientAddonSalesforceSandboxApi]
    salesforces Sequence[GetClientAddonSalesforce]
    samlps Sequence[GetClientAddonSamlp]
    sap_apis Sequence[GetClientAddonSapApi]
    sentries Sequence[GetClientAddonSentry]
    sharepoints Sequence[GetClientAddonSharepoint]
    slacks Sequence[GetClientAddonSlack]
    springcms Sequence[GetClientAddonSpringcm]
    sso_integrations Sequence[GetClientAddonSsoIntegration]
    wams Sequence[GetClientAddonWam]
    wsfeds Sequence[GetClientAddonWsfed]
    zendesks Sequence[GetClientAddonZendesk]
    zooms Sequence[GetClientAddonZoom]

    GetClientAddonAw

    lifetimeInSeconds Integer
    principal String
    role String
    lifetimeInSeconds number
    principal string
    role string
    lifetimeInSeconds Number
    principal String
    role String

    GetClientAddonAzureBlob

    GetClientAddonAzureSb

    EntityPath string
    Expiration int
    Namespace string
    SasKey string
    SasKeyName string
    EntityPath string
    Expiration int
    Namespace string
    SasKey string
    SasKeyName string
    entityPath String
    expiration Integer
    namespace String
    sasKey String
    sasKeyName String
    entityPath string
    expiration number
    namespace string
    sasKey string
    sasKeyName string
    entityPath String
    expiration Number
    namespace String
    sasKey String
    sasKeyName String

    GetClientAddonEchosign

    Domain string
    Domain string
    domain String
    domain string
    domain str
    domain String

    GetClientAddonEgnyte

    Domain string
    Domain string
    domain String
    domain string
    domain str
    domain String

    GetClientAddonFirebase

    GetClientAddonLayer

    Expiration int
    KeyId string
    Principal string
    PrivateKey string
    ProviderId string
    Expiration int
    KeyId string
    Principal string
    PrivateKey string
    ProviderId string
    expiration Integer
    keyId String
    principal String
    privateKey String
    providerId String
    expiration number
    keyId string
    principal string
    privateKey string
    providerId string
    expiration Number
    keyId String
    principal String
    privateKey String
    providerId String

    GetClientAddonMscrm

    Url string
    Url string
    url String
    url string
    url str
    url String

    GetClientAddonNewrelic

    Account string
    Account string
    account String
    account string
    account String

    GetClientAddonOffice365

    Connection string
    Domain string
    Connection string
    Domain string
    connection String
    domain String
    connection string
    domain string
    connection String
    domain String

    GetClientAddonRm

    Url string
    Url string
    url String
    url string
    url str
    url String

    GetClientAddonSalesforce

    EntityId string
    EntityId string
    entityId String
    entityId string
    entityId String

    GetClientAddonSalesforceApi

    ClientId string

    The ID of the client. If not provided, name must be set.

    CommunityName string
    CommunityUrlSection string
    Principal string
    ClientId string

    The ID of the client. If not provided, name must be set.

    CommunityName string
    CommunityUrlSection string
    Principal string
    clientId String

    The ID of the client. If not provided, name must be set.

    communityName String
    communityUrlSection String
    principal String
    clientId string

    The ID of the client. If not provided, name must be set.

    communityName string
    communityUrlSection string
    principal string
    client_id str

    The ID of the client. If not provided, name must be set.

    community_name str
    community_url_section str
    principal str
    clientId String

    The ID of the client. If not provided, name must be set.

    communityName String
    communityUrlSection String
    principal String

    GetClientAddonSalesforceSandboxApi

    ClientId string

    The ID of the client. If not provided, name must be set.

    CommunityName string
    CommunityUrlSection string
    Principal string
    ClientId string

    The ID of the client. If not provided, name must be set.

    CommunityName string
    CommunityUrlSection string
    Principal string
    clientId String

    The ID of the client. If not provided, name must be set.

    communityName String
    communityUrlSection String
    principal String
    clientId string

    The ID of the client. If not provided, name must be set.

    communityName string
    communityUrlSection string
    principal string
    client_id str

    The ID of the client. If not provided, name must be set.

    community_name str
    community_url_section str
    principal str
    clientId String

    The ID of the client. If not provided, name must be set.

    communityName String
    communityUrlSection String
    principal String

    GetClientAddonSamlp

    GetClientAddonSamlpLogout

    Callback string
    SloEnabled bool
    Callback string
    SloEnabled bool
    callback String
    sloEnabled Boolean
    callback string
    sloEnabled boolean
    callback String
    sloEnabled Boolean

    GetClientAddonSapApi

    ClientId string

    The ID of the client. If not provided, name must be set.

    NameIdentifierFormat string
    Scope string
    ServicePassword string
    TokenEndpointUrl string
    UsernameAttribute string
    ClientId string

    The ID of the client. If not provided, name must be set.

    NameIdentifierFormat string
    Scope string
    ServicePassword string
    TokenEndpointUrl string
    UsernameAttribute string
    clientId String

    The ID of the client. If not provided, name must be set.

    nameIdentifierFormat String
    scope String
    servicePassword String
    tokenEndpointUrl String
    usernameAttribute String
    clientId string

    The ID of the client. If not provided, name must be set.

    nameIdentifierFormat string
    scope string
    servicePassword string
    tokenEndpointUrl string
    usernameAttribute string
    client_id str

    The ID of the client. If not provided, name must be set.

    name_identifier_format str
    scope str
    service_password str
    token_endpoint_url str
    username_attribute str
    clientId String

    The ID of the client. If not provided, name must be set.

    nameIdentifierFormat String
    scope String
    servicePassword String
    tokenEndpointUrl String
    usernameAttribute String

    GetClientAddonSentry

    BaseUrl string
    OrgSlug string
    BaseUrl string
    OrgSlug string
    baseUrl String
    orgSlug String
    baseUrl string
    orgSlug string
    baseUrl String
    orgSlug String

    GetClientAddonSharepoint

    ExternalUrls List<string>
    Url string
    ExternalUrls []string
    Url string
    externalUrls List<String>
    url String
    externalUrls string[]
    url string
    external_urls Sequence[str]
    url str
    externalUrls List<String>
    url String

    GetClientAddonSlack

    Team string
    Team string
    team String
    team string
    team str
    team String

    GetClientAddonSpringcm

    AcsUrl string
    AcsUrl string
    acsUrl String
    acsUrl string
    acsUrl String

    GetClientAddonSsoIntegration

    Name string

    The name of the client. If not provided, client_id must be set.

    Version string
    Name string

    The name of the client. If not provided, client_id must be set.

    Version string
    name String

    The name of the client. If not provided, client_id must be set.

    version String
    name string

    The name of the client. If not provided, client_id must be set.

    version string
    name str

    The name of the client. If not provided, client_id must be set.

    version str
    name String

    The name of the client. If not provided, client_id must be set.

    version String

    GetClientAddonWam

    MasterKey string
    MasterKey string
    masterKey String
    masterKey string
    masterKey String

    GetClientAddonZendesk

    GetClientAddonZoom

    Account string
    Account string
    account String
    account string
    account String

    GetClientJwtConfiguration

    Alg string
    LifetimeInSeconds int
    Scopes Dictionary<string, string>
    SecretEncoded bool
    Alg string
    LifetimeInSeconds int
    Scopes map[string]string
    SecretEncoded bool
    alg String
    lifetimeInSeconds Integer
    scopes Map<String,String>
    secretEncoded Boolean
    alg string
    lifetimeInSeconds number
    scopes {[key: string]: string}
    secretEncoded boolean
    alg str
    lifetime_in_seconds int
    scopes Mapping[str, str]
    secret_encoded bool
    alg String
    lifetimeInSeconds Number
    scopes Map<String>
    secretEncoded Boolean

    GetClientMobile

    GetClientMobileAndroid

    GetClientMobileIo

    GetClientNativeSocialLogin

    GetClientNativeSocialLoginApple

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    GetClientNativeSocialLoginFacebook

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    GetClientRefreshToken

    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.0.0 published on Wednesday, Oct 4, 2023 by Pulumi