getTenant

Auth0 v2.24.3 (2.x), Mar 9 26

Viewing docs for Auth0 v2.24.3 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-auth0

Viewing docs for Auth0 v2.24.3 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-auth0

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    var myTenant = Auth0.GetTenant.Invoke();

});

package main

import (
	"github.com/pulumi/pulumi-auth0/sdk/v2/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth0.LookupTenant(ctx, nil, 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 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 myTenant = Auth0Functions.getTenant();

    }
}

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

const myTenant = auth0.getTenant({});

import pulumi
import pulumi_auth0 as auth0

my_tenant = auth0.get_tenant()

variables:
  myTenant:
    fn::invoke:
      Function: auth0:getTenant
      Arguments: {}

Using getTenant

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 getTenant(opts?: InvokeOptions): Promise<GetTenantResult>
function getTenantOutput(opts?: InvokeOptions): Output<GetTenantResult>

def get_tenant(opts: Optional[InvokeOptions] = None) -> GetTenantResult
def get_tenant_output(opts: Optional[InvokeOptions] = None) -> Output[GetTenantResult]

func LookupTenant(ctx *Context, opts ...InvokeOption) (*LookupTenantResult, error)
func LookupTenantOutput(ctx *Context, opts ...InvokeOption) LookupTenantResultOutput

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

public static class GetTenant 
{
    public static Task<GetTenantResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetTenantResult> Invoke(InvokeOptions? opts = null)
}

public static CompletableFuture<GetTenantResult> getTenant(InvokeOptions options)
public static Output<GetTenantResult> getTenant(InvokeOptions options)

fn::invoke:
  function: auth0:index/getTenant:getTenant
  arguments:
    # arguments dictionary

getTenant Result

The following output properties are available:

AllowedLogoutUrls List<string>: URLs that Auth0 may redirect to after logout.
ChangePasswords List<GetTenantChangePassword>
DefaultAudience string: API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.
DefaultDirectory string: Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.
DefaultRedirectionUri string: The default absolute redirection URI. Must be HTTPS or an empty string.
Domain string: Your Auth0 domain name.
EnabledLocales List<string>: Supported locales for the user interface. The first locale in the list will be used to set the default locale.
ErrorPages List<GetTenantErrorPage>
Flags List<GetTenantFlag>: Configuration settings for tenant flags.
FriendlyName string: Friendly name for the tenant.
GuardianMfaPages List<GetTenantGuardianMfaPage>
Id string: The provider-assigned unique ID for this managed resource.
IdleSessionLifetime double: Number of hours during which a session can be inactive before the user must log in again.
ManagementApiIdentifier string: The identifier value of the built-in Management API resource server, which can be used as an audience when configuring client grants.
PictureUrl string: URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.
SandboxVersion string: Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.
SessionCookies List<GetTenantSessionCooky>: Alters behavior of tenant's session cookie. Contains a single mode property.
SessionLifetime double: Number of hours during which a session will stay valid.
SupportEmail string: Support email address for authenticating users.
SupportUrl string: Support URL for authenticating users.
UniversalLogins List<GetTenantUniversalLogin>

AllowedLogoutUrls []string: URLs that Auth0 may redirect to after logout.
ChangePasswords []GetTenantChangePassword
DefaultAudience string: API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.
DefaultDirectory string: Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.
DefaultRedirectionUri string: The default absolute redirection URI. Must be HTTPS or an empty string.
Domain string: Your Auth0 domain name.
EnabledLocales []string: Supported locales for the user interface. The first locale in the list will be used to set the default locale.
ErrorPages []GetTenantErrorPage
Flags []GetTenantFlag: Configuration settings for tenant flags.
FriendlyName string: Friendly name for the tenant.
GuardianMfaPages []GetTenantGuardianMfaPage
Id string: The provider-assigned unique ID for this managed resource.
IdleSessionLifetime float64: Number of hours during which a session can be inactive before the user must log in again.
ManagementApiIdentifier string: The identifier value of the built-in Management API resource server, which can be used as an audience when configuring client grants.
PictureUrl string: URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.
SandboxVersion string: Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.
SessionCookies []GetTenantSessionCooky: Alters behavior of tenant's session cookie. Contains a single mode property.
SessionLifetime float64: Number of hours during which a session will stay valid.
SupportEmail string: Support email address for authenticating users.
SupportUrl string: Support URL for authenticating users.
UniversalLogins []GetTenantUniversalLogin

allowedLogoutUrls List<String>: URLs that Auth0 may redirect to after logout.
changePasswords List<GetTenantChangePassword>
defaultAudience String: API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.
defaultDirectory String: Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.
defaultRedirectionUri String: The default absolute redirection URI. Must be HTTPS or an empty string.
domain String: Your Auth0 domain name.
enabledLocales List<String>: Supported locales for the user interface. The first locale in the list will be used to set the default locale.
errorPages List<GetTenantErrorPage>
flags List<GetTenantFlag>: Configuration settings for tenant flags.
friendlyName String: Friendly name for the tenant.
guardianMfaPages List<GetTenantGuardianMfaPage>
id String: The provider-assigned unique ID for this managed resource.
idleSessionLifetime Double: Number of hours during which a session can be inactive before the user must log in again.
managementApiIdentifier String: The identifier value of the built-in Management API resource server, which can be used as an audience when configuring client grants.
pictureUrl String: URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.
sandboxVersion String: Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.
sessionCookies List<GetTenantSessionCooky>: Alters behavior of tenant's session cookie. Contains a single mode property.
sessionLifetime Double: Number of hours during which a session will stay valid.
supportEmail String: Support email address for authenticating users.
supportUrl String: Support URL for authenticating users.
universalLogins List<GetTenantUniversalLogin>

allowedLogoutUrls string[]: URLs that Auth0 may redirect to after logout.
changePasswords GetTenantChangePassword[]
defaultAudience string: API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.
defaultDirectory string: Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.
defaultRedirectionUri string: The default absolute redirection URI. Must be HTTPS or an empty string.
domain string: Your Auth0 domain name.
enabledLocales string[]: Supported locales for the user interface. The first locale in the list will be used to set the default locale.
errorPages GetTenantErrorPage[]
flags GetTenantFlag[]: Configuration settings for tenant flags.
friendlyName string: Friendly name for the tenant.
guardianMfaPages GetTenantGuardianMfaPage[]
id string: The provider-assigned unique ID for this managed resource.
idleSessionLifetime number: Number of hours during which a session can be inactive before the user must log in again.
managementApiIdentifier string: The identifier value of the built-in Management API resource server, which can be used as an audience when configuring client grants.
pictureUrl string: URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.
sandboxVersion string: Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.
sessionCookies GetTenantSessionCooky[]: Alters behavior of tenant's session cookie. Contains a single mode property.
sessionLifetime number: Number of hours during which a session will stay valid.
supportEmail string: Support email address for authenticating users.
supportUrl string: Support URL for authenticating users.
universalLogins GetTenantUniversalLogin[]

allowed_logout_urls Sequence[str]: URLs that Auth0 may redirect to after logout.
change_passwords Sequence[GetTenantChangePassword]
default_audience str: API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.
default_directory str: Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.
default_redirection_uri str: The default absolute redirection URI. Must be HTTPS or an empty string.
domain str: Your Auth0 domain name.
enabled_locales Sequence[str]: Supported locales for the user interface. The first locale in the list will be used to set the default locale.
error_pages Sequence[GetTenantErrorPage]
flags Sequence[GetTenantFlag]: Configuration settings for tenant flags.
friendly_name str: Friendly name for the tenant.
guardian_mfa_pages Sequence[GetTenantGuardianMfaPage]
id str: The provider-assigned unique ID for this managed resource.
idle_session_lifetime float: Number of hours during which a session can be inactive before the user must log in again.
management_api_identifier str: The identifier value of the built-in Management API resource server, which can be used as an audience when configuring client grants.
picture_url str: URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.
sandbox_version str: Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.
session_cookies Sequence[GetTenantSessionCooky]: Alters behavior of tenant's session cookie. Contains a single mode property.
session_lifetime float: Number of hours during which a session will stay valid.
support_email str: Support email address for authenticating users.
support_url str: Support URL for authenticating users.
universal_logins Sequence[GetTenantUniversalLogin]

allowedLogoutUrls List<String>: URLs that Auth0 may redirect to after logout.
changePasswords List<Property Map>
defaultAudience String: API Audience to use by default for API Authorization flows. This setting is equivalent to appending the audience to every authorization request made to the tenant for every application.
defaultDirectory String: Name of the connection to be used for Password Grant exchanges. Options include auth0-adldap, ad, auth0, email, sms, waad, and adfs.
defaultRedirectionUri String: The default absolute redirection URI. Must be HTTPS or an empty string.
domain String: Your Auth0 domain name.
enabledLocales List<String>: Supported locales for the user interface. The first locale in the list will be used to set the default locale.
errorPages List<Property Map>
flags List<Property Map>: Configuration settings for tenant flags.
friendlyName String: Friendly name for the tenant.
guardianMfaPages List<Property Map>
id String: The provider-assigned unique ID for this managed resource.
idleSessionLifetime Number: Number of hours during which a session can be inactive before the user must log in again.
managementApiIdentifier String: The identifier value of the built-in Management API resource server, which can be used as an audience when configuring client grants.
pictureUrl String: URL of logo to be shown for the tenant. Recommended size is 150px x 150px. If no URL is provided, the Auth0 logo will be used.
sandboxVersion String: Selected sandbox version for the extensibility environment, which allows you to use custom scripts to extend parts of Auth0's functionality.
sessionCookies List<Property Map>: Alters behavior of tenant's session cookie. Contains a single mode property.
sessionLifetime Number: Number of hours during which a session will stay valid.
supportEmail String: Support email address for authenticating users.
supportUrl String: Support URL for authenticating users.
universalLogins List<Property Map>