Module types/input

APIs

interface ClientAddonsSamlp

interface ClientAddonsSamlp

property audience

audience?: pulumi.Input<string>;

String. Audience of the SAML Assertion. Default will be the Issuer on SAMLRequest.

property authnContextClassRef

authnContextClassRef?: pulumi.Input<string>;

String. Class reference of the authentication context.

property binding

binding?: pulumi.Input<string>;

String. Protocol binding used for SAML logout responses.

property createUpnClaim

createUpnClaim?: pulumi.Input<boolean>;

Boolean, (Default=true) Indicates whether or not a UPN claim should be created.

property destination

destination?: pulumi.Input<string>;

String. Destination of the SAML Response. If not specified, it will be AssertionConsumerUrlof SAMLRequest or Callback URL if there was no SAMLRequest.

property digestAlgorithm

digestAlgorithm?: pulumi.Input<string>;

String, (Default=sha1). Algorithm used to calculate the digest of the SAML Assertion or response. Options include defaultsha1 and sha256.

property includeAttributeNameFormat

includeAttributeNameFormat?: pulumi.Input<boolean>;

Boolean,(Default=true). Indicates whether or not we should infer the NameFormat based on the attribute name. If set to false, the attribute NameFormat is not set in the assertion.

property lifetimeInSeconds

lifetimeInSeconds?: pulumi.Input<number>;

Integer, (Default=3600). Number of seconds during which the token is valid.

property logout

logout?: pulumi.Input<ClientAddonsSamlpLogout>;

Map(Resource). Configuration settings for logout. For details, see Logout.

property mapIdentities

mapIdentities?: pulumi.Input<boolean>;

Boolean, (Default=true). Indicates whether or not to add additional identity information in the token, such as the provider used and the access_token, if available.

property mapUnknownClaimsAsIs

mapUnknownClaimsAsIs?: pulumi.Input<boolean>;

Boolean, (Default=false). Indicates whether or not to add a prefix of http://schema.auth0.com to any claims that are not mapped to the common profile when passed through in the output assertion.

property mappings

mappings?: pulumi.Input<{[key: string]: any}>;

Map(String). Mappings between the Auth0 user profile property name (name) and the output attributes on the SAML attribute in the assertion (value).

property nameIdentifierFormat

nameIdentifierFormat?: pulumi.Input<string>;

String, (Default=urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified). Format of the name identifier.

property nameIdentifierProbes

nameIdentifierProbes?: pulumi.Input<pulumi.Input<string>[]>;

List(String). Attributes that can be used for Subject/NameID. Auth0 will try each of the attributes of this array in order and use the first value it finds.

property passthroughClaimsWithNoMapping

passthroughClaimsWithNoMapping?: pulumi.Input<boolean>;

Boolean, (Default=true). Indicates whether or not to passthrough claims that are not mapped to the common profile in the output assertion.

property recipient

recipient?: pulumi.Input<string>;

String. Recipient of the SAML Assertion (SubjectConfirmationData). Default is AssertionConsumerUrl on SAMLRequest or Callback URL if no SAMLRequest was sent.

property signResponse

signResponse?: pulumi.Input<boolean>;

Boolean. Indicates whether or not the SAML Response should be signed instead of the SAML Assertion.

property signatureAlgorithm

signatureAlgorithm?: pulumi.Input<string>;

String, (Default=rsa-sha1). Algorithm used to sign the SAML Assertion or response. Options include rsa-sha1 and rsa-sha256.

property typedAttributes

typedAttributes?: pulumi.Input<boolean>;

Boolean, (Default=true). Indicates whether or not we should infer the xs:type of the element. Types include xs:string, xs:boolean, xs:double, and xs:anyType. When set to false, all xs:type are xs:anyType.

interface ClientAddonsSamlpLogout

interface ClientAddonsSamlpLogout

property callback

callback?: pulumi.Input<string>;

String. Service provider’s Single Logout Service URL, to which Auth0 will send logout requests and responses.

property sloEnabled

sloEnabled?: pulumi.Input<boolean>;

Boolean. Indicates whether or not Auth0 should notify service providers of session termination.

interface ClientJwtConfiguration

interface ClientJwtConfiguration

property alg

alg?: pulumi.Input<string>;

String. Algorithm used to sign JWTs.

property lifetimeInSeconds

lifetimeInSeconds?: pulumi.Input<number>;

Integer. Number of seconds during which the JWT will be valid.

property scopes

scopes?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Map(String). Permissions (scopes) included in JWTs.

property secretEncoded

secretEncoded?: pulumi.Input<boolean>;

Boolean. Indicates whether or not the client secret is base64 encoded.

interface ClientMobile

interface ClientMobile

property android

android?: pulumi.Input<ClientMobileAndroid>;

List(Resource). Configuration settings for Android native apps. For details, see Android.

property ios

ios?: pulumi.Input<ClientMobileIos>;

List(Resource). Configuration settings for i0S native apps. For details, see iOS.

interface ClientMobileAndroid

interface ClientMobileAndroid

property appPackageName

appPackageName?: pulumi.Input<string>;

String

property sha256CertFingerprints

sha256CertFingerprints?: pulumi.Input<pulumi.Input<string>[]>;

List(String)

interface ClientMobileIos

interface ClientMobileIos

property appBundleIdentifier

appBundleIdentifier?: pulumi.Input<string>;

String

property teamId

teamId?: pulumi.Input<string>;

String

interface ConnectionOptions

interface ConnectionOptions

property adfsServer

adfsServer?: pulumi.Input<string>;

String. ADFS Metadata source.

property allowedAudiences

allowedAudiences?: pulumi.Input<pulumi.Input<string>[]>;

property apiEnableUsers

apiEnableUsers?: pulumi.Input<boolean>;

Boolean.

property appDomain

appDomain?: pulumi.Input<string>;

String. Azure AD domain name.

property appId

appId?: pulumi.Input<string>;

String

property authorizationEndpoint

authorizationEndpoint?: pulumi.Input<string>;

String.

property bruteForceProtection

bruteForceProtection?: pulumi.Input<boolean>;

Boolean. Indicates whether or not to enable brute force protection, which will limit the number of signups and failed logins from a suspicious IP address.

property clientId

clientId?: pulumi.Input<string>;

String. Client ID given by your OIDC provider.

property clientSecret

clientSecret?: pulumi.Input<string>;

String, Case-sensitive. Client secret given by your OIDC provider.

property communityBaseUrl

communityBaseUrl?: pulumi.Input<string>;

String.

property configuration

configuration?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Map(String), Case-sensitive.

property customScripts

customScripts?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Map(String).

property disableCache

disableCache?: pulumi.Input<boolean>;

property disableSignup

disableSignup?: pulumi.Input<boolean>;

Boolean. Indicates whether or not to allow user sign-ups to your application.

property discoveryUrl

discoveryUrl?: pulumi.Input<string>;

String. Usually an URL ending with /.well-known/openid-configuration

property domain

domain?: pulumi.Input<string>;

property domainAliases

domainAliases?: pulumi.Input<pulumi.Input<string>[]>;

List(String). List of the domains that can be authenticated using the Identity Provider. Only needed for Identifier First authentication flows.

property enabledDatabaseCustomization

enabledDatabaseCustomization?: pulumi.Input<boolean>;

Boolean.

property from

from?: pulumi.Input<string>;

String. SMS number for the sender. Used when SMS Source is From.

property iconUrl

iconUrl?: pulumi.Input<string>;

property identityApi

identityApi?: pulumi.Input<string>;

property importMode

importMode?: pulumi.Input<boolean>;

Boolean. Indicates whether or not you have a legacy user store and want to gradually migrate those users to the Auth0 user store. Learn more.

property ips

ips?: pulumi.Input<pulumi.Input<string>[]>;

property issuer

issuer?: pulumi.Input<string>;

String. URL of the issuer.

property jwksUri

jwksUri?: pulumi.Input<string>;

String.

property keyId

keyId?: pulumi.Input<string>;

property maxGroupsToRetrieve

maxGroupsToRetrieve?: pulumi.Input<string>;

String. Maximum number of groups to retrieve.

property messagingServiceSid

messagingServiceSid?: pulumi.Input<string>;

String. SID for Copilot. Used when SMS Source is Copilot.

property name

name?: pulumi.Input<string>;

String.

property passwordComplexityOptions

passwordComplexityOptions?: pulumi.Input<ConnectionOptionsPasswordComplexityOptions>;

List(Resource). Configuration settings for password complexity. For details, see Password Complexity Options.

property passwordDictionary

passwordDictionary?: pulumi.Input<ConnectionOptionsPasswordDictionary>;

List(Resource). Configuration settings for the password dictionary check, which does not allow passwords that are part of the password dictionary. For details, see Password Dictionary.

property passwordHistories

passwordHistories?: pulumi.Input<pulumi.Input<ConnectionOptionsPasswordHistory>[]>;

List(Resource). Configuration settings for the password history that is maintained for each user to prevent the reuse of passwords. For details, see Password History.

property passwordNoPersonalInfo

passwordNoPersonalInfo?: pulumi.Input<ConnectionOptionsPasswordNoPersonalInfo>;

List(Resource). Configuration settings for the password personal info check, which does not allow passwords that contain any part of the user’s personal data, including user’s name, username, nickname, user_metadata.name, user_metadata.first, user_metadata.last, user’s email, or first part of the user’s email. For details, see Password No Personal Info.

property passwordPolicy

passwordPolicy?: pulumi.Input<string>;

String. Indicates level of password strength to enforce during authentication. A strong password policy will make it difficult, if not improbable, for someone to guess a password through either manual or automated means. Options include none, low, fair, good, excellent.

property requiresUsername

requiresUsername?: pulumi.Input<boolean>;

Boolean. Indicates whether or not the user is required to provide a username in addition to an email address.

property scopes

scopes?: pulumi.Input<pulumi.Input<string>[]>;

List(String). Value must be a list of scopes. For example ["openid", "profile", "email"]

property strategyVersion

strategyVersion?: pulumi.Input<number>;

Int. Version 1 is deprecated, use version 2.

property subject

subject?: pulumi.Input<string>;

property syntax

syntax?: pulumi.Input<string>;

String. Syntax of the SMS. Options include markdown and liquid.

property teamId

teamId?: pulumi.Input<string>;

property template

template?: pulumi.Input<string>;

String. Template for the SMS. You can use @@password@@ as a placeholder for the password value.

property tenantDomain

tenantDomain?: pulumi.Input<string>;

String

property tokenEndpoint

tokenEndpoint?: pulumi.Input<string>;

String.

property totp

totp?: pulumi.Input<ConnectionOptionsTotp>;

Map(Resource). Configuration options for one-time passwords. For details, see TOTP.

property twilioSid

twilioSid?: pulumi.Input<string>;

String. SID for your Twilio account.

property twilioToken

twilioToken?: pulumi.Input<string>;

String, Case-sensitive. AuthToken for your Twilio account.

property type

type?: pulumi.Input<string>;

String. Value must be backChannel or frontChannel

property useCertAuth

useCertAuth?: pulumi.Input<boolean>;

property useKerberos

useKerberos?: pulumi.Input<boolean>;

property useWsfed

useWsfed?: pulumi.Input<boolean>;

Bool

property userinfoEndpoint

userinfoEndpoint?: pulumi.Input<string>;

String.

property validation

validation?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

String.

property waadCommonEndpoint

waadCommonEndpoint?: pulumi.Input<boolean>;

Boolean. Indicates whether or not to use the common endpoint rather than the default endpoint. Typically enabled if you’re using this for a multi-tenant application in Azure AD.

property waadProtocol

waadProtocol?: pulumi.Input<string>;

String

interface ConnectionOptionsPasswordComplexityOptions

interface ConnectionOptionsPasswordComplexityOptions

property minLength

minLength?: pulumi.Input<number>;

Integer. Minimum number of characters allowed in passwords.

interface ConnectionOptionsPasswordDictionary

interface ConnectionOptionsPasswordDictionary

property dictionaries

dictionaries?: pulumi.Input<pulumi.Input<string>[]>;

Set(String), (Maximum=2000 characters). Customized contents of the password dictionary. By default, the password dictionary contains a list of the 10,000 most common passwords; your customized content is used in addition to the default password dictionary. Matching is not case-sensitive.

property enable

enable?: pulumi.Input<boolean>;

Boolean. Indicates whether password history is enabled for the connection. When enabled, any existing users in this connection will be unaffected; the system will maintain their password history going forward.

interface ConnectionOptionsPasswordHistory

interface ConnectionOptionsPasswordHistory

property enable

enable?: pulumi.Input<boolean>;

property size

size?: pulumi.Input<number>;

Integer, (Maximum=24). Indicates the number of passwords to keep in history.

interface ConnectionOptionsPasswordNoPersonalInfo

interface ConnectionOptionsPasswordNoPersonalInfo

property enable

enable?: pulumi.Input<boolean>;

Boolean. Indicates whether the password personal info check is enabled for this connection.

interface ConnectionOptionsTotp

interface ConnectionOptionsTotp

property length

length?: pulumi.Input<number>;

Integer. Length of the one-time password.

property timeStep

timeStep?: pulumi.Input<number>;

Integer. Seconds between allowed generation of new passwords.

interface CustomDomainVerification

interface CustomDomainVerification

property methods

methods?: pulumi.Input<any[]>;

List(Map). Verification methods for the domain.

interface EmailCredentials

interface EmailCredentials

property accessKeyId

accessKeyId?: pulumi.Input<string>;

String, Case-sensitive. AWS Access Key ID. Used only for AWS.

property apiKey

apiKey?: pulumi.Input<string>;

String, Case-sensitive. API Key for your email service. Will always be encrypted in our database.

property apiUser

apiUser?: pulumi.Input<string>;

String. API User for your email service.

property domain

domain?: pulumi.Input<string>;

property region

region?: pulumi.Input<string>;

String. Default region. Used only for AWS, Mailgun, and SparkPost.

property secretAccessKey

secretAccessKey?: pulumi.Input<string>;

String, Case-sensitive. AWS Secret Key. Will always be encrypted in our database. Used only for AWS.

property smtpHost

smtpHost?: pulumi.Input<string>;

String. Hostname or IP address of your SMTP server. Used only for SMTP.

property smtpPass

smtpPass?: pulumi.Input<string>;

String, Case-sensitive. SMTP password. Used only for SMTP.

property smtpPort

smtpPort?: pulumi.Input<number>;

Integer. Port used by your SMTP server. Please avoid using port 25 if possible because many providers have limitations on this port. Used only for SMTP.

property smtpUser

smtpUser?: pulumi.Input<string>;

String. SMTP username. Used only for SMTP.

interface GlobalClientAddons

interface GlobalClientAddons

property aws

aws?: pulumi.Input<{[key: string]: any}>;

property azureBlob

azureBlob?: pulumi.Input<{[key: string]: any}>;

property azureSb

azureSb?: pulumi.Input<{[key: string]: any}>;

property box

box?: pulumi.Input<{[key: string]: any}>;

property cloudbees

cloudbees?: pulumi.Input<{[key: string]: any}>;

property concur

concur?: pulumi.Input<{[key: string]: any}>;

property dropbox

dropbox?: pulumi.Input<{[key: string]: any}>;

property echosign

echosign?: pulumi.Input<{[key: string]: any}>;

property egnyte

egnyte?: pulumi.Input<{[key: string]: any}>;

property firebase

firebase?: pulumi.Input<{[key: string]: any}>;

property layer

layer?: pulumi.Input<{[key: string]: any}>;

property mscrm

mscrm?: pulumi.Input<{[key: string]: any}>;

property newrelic

newrelic?: pulumi.Input<{[key: string]: any}>;

property office365

office365?: pulumi.Input<{[key: string]: any}>;

property rms

rms?: pulumi.Input<{[key: string]: any}>;

property salesforce

salesforce?: pulumi.Input<{[key: string]: any}>;

property salesforceApi

salesforceApi?: pulumi.Input<{[key: string]: any}>;

property salesforceSandboxApi

salesforceSandboxApi?: pulumi.Input<{[key: string]: any}>;

property samlp

samlp?: pulumi.Input<GlobalClientAddonsSamlp>;

property sapApi

sapApi?: pulumi.Input<{[key: string]: any}>;

property sentry

sentry?: pulumi.Input<{[key: string]: any}>;

property sharepoint

sharepoint?: pulumi.Input<{[key: string]: any}>;

property slack

slack?: pulumi.Input<{[key: string]: any}>;

property springcm

springcm?: pulumi.Input<{[key: string]: any}>;

property wams

wams?: pulumi.Input<{[key: string]: any}>;

property wsfed

wsfed?: pulumi.Input<{[key: string]: any}>;

property zendesk

zendesk?: pulumi.Input<{[key: string]: any}>;

property zoom

zoom?: pulumi.Input<{[key: string]: any}>;

interface GlobalClientAddonsSamlp

interface GlobalClientAddonsSamlp

property audience

audience?: pulumi.Input<string>;

property authnContextClassRef

authnContextClassRef?: pulumi.Input<string>;

property binding

binding?: pulumi.Input<string>;

property createUpnClaim

createUpnClaim?: pulumi.Input<boolean>;

property destination

destination?: pulumi.Input<string>;

property digestAlgorithm

digestAlgorithm?: pulumi.Input<string>;

property includeAttributeNameFormat

includeAttributeNameFormat?: pulumi.Input<boolean>;

property lifetimeInSeconds

lifetimeInSeconds?: pulumi.Input<number>;

property logout

logout?: pulumi.Input<GlobalClientAddonsSamlpLogout>;

property mapIdentities

mapIdentities?: pulumi.Input<boolean>;

property mapUnknownClaimsAsIs

mapUnknownClaimsAsIs?: pulumi.Input<boolean>;

property mappings

mappings?: pulumi.Input<{[key: string]: any}>;

property nameIdentifierFormat

nameIdentifierFormat?: pulumi.Input<string>;

property nameIdentifierProbes

nameIdentifierProbes?: pulumi.Input<pulumi.Input<string>[]>;

property passthroughClaimsWithNoMapping

passthroughClaimsWithNoMapping?: pulumi.Input<boolean>;

property recipient

recipient?: pulumi.Input<string>;

property signResponse

signResponse?: pulumi.Input<boolean>;

property signatureAlgorithm

signatureAlgorithm?: pulumi.Input<string>;

property typedAttributes

typedAttributes?: pulumi.Input<boolean>;

interface GlobalClientAddonsSamlpLogout

interface GlobalClientAddonsSamlpLogout

property callback

callback?: pulumi.Input<string>;

property sloEnabled

sloEnabled?: pulumi.Input<boolean>;

interface GlobalClientJwtConfiguration

interface GlobalClientJwtConfiguration

property alg

alg?: pulumi.Input<string>;

property lifetimeInSeconds

lifetimeInSeconds?: pulumi.Input<number>;

property scopes

scopes?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

property secretEncoded

secretEncoded?: pulumi.Input<boolean>;

interface GlobalClientMobile

interface GlobalClientMobile

property android

android?: pulumi.Input<GlobalClientMobileAndroid>;

property ios

ios?: pulumi.Input<GlobalClientMobileIos>;

interface GlobalClientMobileAndroid

interface GlobalClientMobileAndroid

property appPackageName

appPackageName?: pulumi.Input<string>;

property sha256CertFingerprints

sha256CertFingerprints?: pulumi.Input<pulumi.Input<string>[]>;

interface GlobalClientMobileIos

interface GlobalClientMobileIos

property appBundleIdentifier

appBundleIdentifier?: pulumi.Input<string>;

property teamId

teamId?: pulumi.Input<string>;

interface ResourceServerScope

interface ResourceServerScope

property description

description?: pulumi.Input<string>;

String. Description of the permission (scope).

property value

value: pulumi.Input<string>;

String. Name of the permission (scope). Examples include read:appointments or delete:appointments.

interface RolePermission

interface RolePermission

property name

name: pulumi.Input<string>;

String. Name of the permission (scope).

property resourceServerIdentifier

resourceServerIdentifier: pulumi.Input<string>;

String. Unique identifier for the resource server.

interface TenantChangePassword

interface TenantChangePassword

property enabled

enabled: pulumi.Input<boolean>;

Boolean. Indicates whether or not to use the custom change password page.

property html

html: pulumi.Input<string>;

String, HTML format with supported Liquid syntax. Customized content of the change password page.

interface TenantErrorPage

interface TenantErrorPage

property html

html: pulumi.Input<string>;

String, HTML format with supported Liquid syntax. Customized content of the error page.

property showLogLink

showLogLink: pulumi.Input<boolean>;

Boolean. Indicates whether or not to show the link to logs as part of the default error page.

property url

url: pulumi.Input<string>;

String. URL to redirect to when an error occurs rather than showing the default error page.

interface TenantFlags

interface TenantFlags

property changePwdFlowV1

changePwdFlowV1?: pulumi.Input<boolean>;

Boolean. Indicates whether or not to use the older v1 change password flow. Not recommended except for backward compatibility.

property disableClickjackProtectionHeaders

disableClickjackProtectionHeaders?: pulumi.Input<boolean>;

Boolean. Indicated whether or not classic Universal Login prompts include additional security headers to prevent clickjacking.

property enableApisSection

enableApisSection?: pulumi.Input<boolean>;

Boolean. Indicates whether or not the APIs section is enabled for the tenant.

property enableClientConnections

enableClientConnections?: pulumi.Input<boolean>;

Boolean. Indicates whether or not all current connections should be enabled when a new client is created.

property enableCustomDomainInEmails

enableCustomDomainInEmails?: pulumi.Input<boolean>;

Boolean. Indicates whether or not the tenant allows custom domains in emails.

property enableDynamicClientRegistration

enableDynamicClientRegistration?: pulumi.Input<boolean>;

Boolean. Indicates whether or not the tenant allows dynamic client registration.

property enableLegacyLogsSearchV2

enableLegacyLogsSearchV2?: pulumi.Input<boolean>;

Boolean. Indicates whether or not to use the older v2 legacy logs search.

property enablePipeline2

enablePipeline2?: pulumi.Input<boolean>;

Boolean. Indicates whether or not advanced API Authorization scenarios are enabled.

property enablePublicSignupUserExistsError

enablePublicSignupUserExistsError?: pulumi.Input<boolean>;

Boolean. Indicates whether or not the public sign up process shows a userExists error if the user already exists.

property universalLogin

universalLogin?: pulumi.Input<boolean>;

Boolean. Indicates whether or not the tenant uses universal login.

property useScopeDescriptionsForConsent

useScopeDescriptionsForConsent?: pulumi.Input<boolean>;

interface TenantGuardianMfaPage

interface TenantGuardianMfaPage

property enabled

enabled: pulumi.Input<boolean>;

Boolean. Indicates whether or not to use the custom Guardian page.

property html

html: pulumi.Input<string>;

String, HTML format with supported Liquid syntax. Customized content of the Guardian page.

interface TenantUniversalLogin

interface TenantUniversalLogin

property colors

colors?: pulumi.Input<TenantUniversalLoginColors>;

List(Resource). Configuration settings for Universal Login colors. See Universal Login - Colors.

interface TenantUniversalLoginColors

interface TenantUniversalLoginColors

property pageBackground

pageBackground?: pulumi.Input<string>;

String, Hexadecimal. Background color of login pages.

property primary

primary?: pulumi.Input<string>;

String, Hexadecimal. Primary button background color.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module types/input

APIs

APIs