import * as outputs from "../types/output"; export interface ActionDependency { /** * Dependency name, e.g. `lodash`. */ name: string; /** * Dependency version, e.g. `latest` or `4.17.21`. */ version: string; } export interface ActionModule { /** * The unique ID of the module. */ moduleId: string; /** * The name of the module. */ moduleName: string; /** * The ID of the specific module version to use. */ moduleVersionId: string; /** * The version number of the module. */ moduleVersionNumber: number; } export interface ActionModuleDependency { /** * Dependency name, e.g. `lodash`. */ name: string; /** * Dependency version, e.g. `latest` or `4.17.21`. */ version: string; } export interface ActionModuleLatestVersion { /** * The source code of this version. */ code: string; /** * The time when this version was created. */ createdAt: string; /** * List of third party npm modules, and their versions, that this version depends on. */ dependencies: outputs.ActionModuleLatestVersionDependency[]; /** * The unique identifier of the version. */ id: string; /** * List of secrets that are included in this version. */ secrets: outputs.ActionModuleLatestVersionSecret[]; /** * The version number. */ versionNumber: number; } export interface ActionModuleLatestVersionDependency { /** * Dependency name. */ name: string; /** * Dependency version. */ version: string; } export interface ActionModuleLatestVersionSecret { /** * Secret name. */ name: string; /** * The time when this secret was last updated. */ updatedAt: string; } export interface ActionModuleSecret { /** * Secret name. */ name: string; /** * Last update time */ updatedAt: string; /** * Secret value. */ value: string; } export interface ActionSecret { /** * Secret name. */ name: string; /** * Secret value. */ value: string; } export interface ActionSecretsWo { /** * The name of the action. */ name: string; /** * **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. * Secret value (write-only). This value is never stored in Terraform state. */ value: string; } export interface ActionSupportedTriggers { /** * The trigger ID. */ id: string; /** * The trigger version. This regulates which `runtime` versions are supported. */ version: string; } export interface AttackProtectionBotDetection { /** * List of IP addresses or ranges that will not trigger bot detection. */ allowlists: string[]; /** * Bot detection level. Possible values: `low`, `medium`, `high`. */ botDetectionLevel: string; /** * Challenge policy for password flow. Possible values: `never`, `whenRisky`, `always`. */ challengePasswordPolicy: string; /** * Challenge policy for password reset flow. Possible values: `never`, `whenRisky`, `always`. */ challengePasswordResetPolicy: string; /** * Challenge policy for passwordless flow. Possible values: `never`, `whenRisky`, `always`. */ challengePasswordlessPolicy: string; /** * Whether monitoring mode is enabled for bot detection. */ monitoringModeEnabled: boolean; } export interface AttackProtectionBreachedPasswordDetection { /** * When `adminNotification` is enabled within the `shields` property, determines how often email notifications are sent. Possible values: `immediately`, `daily`, `weekly`, `monthly`. */ adminNotificationFrequencies: string[]; /** * Whether breached password detection is active. */ enabled: boolean; /** * The subscription level for breached password detection methods. Use "enhanced" to enable Credential Guard. Possible values: `standard`, `enhanced`. */ method: string; /** * Configuration options that apply before every password change attempt. */ preChangePassword: outputs.AttackProtectionBreachedPasswordDetectionPreChangePassword; /** * Configuration options that apply before every user registration attempt. Only available on public tenants. */ preUserRegistration: outputs.AttackProtectionBreachedPasswordDetectionPreUserRegistration; /** * Action to take when a breached password is detected. Options include: `block` (block compromised user accounts), `userNotification` (send an email to user when we detect that they are using compromised credentials) and `adminNotification` (send an email with a summary of the number of accounts logging in with compromised credentials). */ shields: string[]; } export interface AttackProtectionBreachedPasswordDetectionPreChangePassword { /** * Action to take when a breached password is detected before the password is changed. Possible values: `block` (block compromised credentials for new accounts), `adminNotification` (send an email notification with a summary of compromised credentials in new accounts). */ shields: string[]; } export interface AttackProtectionBreachedPasswordDetectionPreUserRegistration { /** * Action to take when a breached password is detected during a signup. Possible values: `block` (block compromised credentials for new accounts), `adminNotification` (send an email notification with a summary of compromised credentials in new accounts). */ shields: string[]; } export interface AttackProtectionBruteForceProtection { /** * List of trusted IP addresses that will not have attack protection enforced against them. This field allows you to specify multiple IP addresses, or ranges. You can use IPv4 or IPv6 addresses and CIDR notation. */ allowlists: string[]; /** * Whether brute force attack protections are active. */ enabled: boolean; /** * Maximum number of consecutive failed login attempts from a single user before blocking is triggered. Only available on public tenants. */ maxAttempts: number; /** * Determines whether the IP address is used when counting failed attempts. Possible values: `countPerIdentifierAndIp` (lockout an account from a given IP Address) or `countPerIdentifier` (lockout an account regardless of IP Address). */ mode: string; /** * Action to take when a brute force protection threshold is violated. Possible values: `block` (block login attempts for a flagged user account), `userNotification` (send an email to user when their account has been blocked). */ shields: string[]; } export interface AttackProtectionCaptcha { /** * Active CAPTCHA provider ID. Set to empty string to disable CAPTCHA. Possible values: `recaptchaV2`, `recaptchaEnterprise`, `hcaptcha`, `friendlyCaptcha`, `arkose`, `authChallenge`, `simpleCaptcha`. */ activeProviderId: string; /** * Configuration for Arkose Labs. */ arkose: outputs.AttackProtectionCaptchaArkose; /** * Configuration for Auth0's Auth Challenge. */ authChallenge: outputs.AttackProtectionCaptchaAuthChallenge; /** * Configuration for Friendly Captcha. */ friendlyCaptcha: outputs.AttackProtectionCaptchaFriendlyCaptcha; /** * Configuration for hCaptcha. */ hcaptcha: outputs.AttackProtectionCaptchaHcaptcha; /** * Configuration for Google reCAPTCHA Enterprise. */ recaptchaEnterprise: outputs.AttackProtectionCaptchaRecaptchaEnterprise; /** * Configuration for Google reCAPTCHA v2. */ recaptchaV2: outputs.AttackProtectionCaptchaRecaptchaV2; } export interface AttackProtectionCaptchaArkose { /** * Client subdomain for Arkose Labs. */ clientSubdomain: string; /** * Whether the captcha should fail open. */ failOpen: boolean; /** * Secret for Arkose Labs. Required when configuring Arkose Labs. */ secret?: string; /** * Site key for Arkose Labs. */ siteKey: string; /** * Verify subdomain for Arkose Labs. */ verifySubdomain: string; } export interface AttackProtectionCaptchaAuthChallenge { /** * Whether the auth challenge should fail open. */ failOpen: boolean; } export interface AttackProtectionCaptchaFriendlyCaptcha { /** * Secret for Friendly Captcha. Required when configuring Friendly Captcha. */ secret?: string; /** * Site key for Friendly Captcha. */ siteKey: string; } export interface AttackProtectionCaptchaHcaptcha { /** * Secret for hCaptcha. Required when configuring hCaptcha. */ secret?: string; /** * Site key for hCaptcha. */ siteKey: string; } export interface AttackProtectionCaptchaRecaptchaEnterprise { /** * API key for reCAPTCHA Enterprise. Required when configuring reCAPTCHA Enterprise. */ apiKey?: string; /** * Project ID for reCAPTCHA Enterprise. */ projectId: string; /** * Site key for reCAPTCHA Enterprise. */ siteKey: string; } export interface AttackProtectionCaptchaRecaptchaV2 { /** * Secret for reCAPTCHA v2. Required when configuring reCAPTCHA v2. */ secret?: string; /** * Site key for reCAPTCHA v2. */ siteKey: string; } export interface AttackProtectionPhoneProviderProtection { /** * The SMS backoff strategy used during MFA enrollment. Use `exponential` to activate exponential-backoff resend limiting (EA only). */ type: string; } export interface AttackProtectionSuspiciousIpThrottling { /** * List of trusted IP addresses that will not have attack protection enforced against them. This field allows you to specify multiple IP addresses, or ranges. You can use IPv4 or IPv6 addresses and CIDR notation. */ allowlists: string[]; /** * Whether suspicious IP throttling attack protections are active. */ enabled: boolean; /** * Configuration options that apply before every login attempt. Only available on public tenants. */ preLogin: outputs.AttackProtectionSuspiciousIpThrottlingPreLogin; /** * Configuration options that apply before every user registration attempt. Only available on public tenants. */ preUserRegistration: outputs.AttackProtectionSuspiciousIpThrottlingPreUserRegistration; /** * Action to take when a suspicious IP throttling threshold is violated. Possible values: `block` (throttle traffic from an IP address when there is a high number of login attempts targeting too many different accounts), `adminNotification` (send an email notification when traffic is throttled on one or more IP addresses due to high-velocity traffic). */ shields: string[]; } export interface AttackProtectionSuspiciousIpThrottlingPreLogin { /** * The maximum number of failed login attempts allowed from a single IP address. */ maxAttempts: number; /** * Interval of time, given in milliseconds at which new login tokens will become available after they have been used by an IP address. Each login attempt will be added on the defined throttling rate. */ rate: number; } export interface AttackProtectionSuspiciousIpThrottlingPreUserRegistration { /** * The maximum number of sign up attempts allowed from a single IP address. */ maxAttempts: number; /** * Interval of time, given in milliseconds at which new sign up tokens will become available after they have been used by an IP address. Each sign up attempt will be added on the defined throttling rate. */ rate: number; } export interface BrandingColors { /** * Background color of login pages in hexadecimal. */ pageBackground: string; /** * Primary button background color in hexadecimal. */ primary: string; } export interface BrandingFont { /** * URL for the custom font. */ url: string; } export interface BrandingPhoneNotificationTemplateContent { /** * The body content of the phone notification template. */ body: outputs.BrandingPhoneNotificationTemplateContentBody; /** * The sender phone number for SMS or voice notifications. */ from?: string; /** * The syntax of the phone notification template. */ syntax: string; } export interface BrandingPhoneNotificationTemplateContentBody { /** * The text content for SMS notifications. */ text?: string; /** * The voice content for voice notifications. */ voice?: string; } export interface BrandingThemeBorders { /** * Button border radius. Value needs to be between `1` and `10`. Defaults to `3.0`. */ buttonBorderRadius?: number; /** * Button border weight. Value needs to be between `0` and `10`. Defaults to `1.0`. */ buttonBorderWeight?: number; /** * Buttons style. Available options: `pill`, `rounded`, `sharp`. Defaults to `rounded`. */ buttonsStyle?: string; /** * Input border radius. Value needs to be between `0` and `10`. Defaults to `3.0`. */ inputBorderRadius?: number; /** * Input border weight. Value needs to be between `0` and `3`. Defaults to `1.0`. */ inputBorderWeight?: number; /** * Inputs style. Available options: `pill`, `rounded`, `sharp`. Defaults to `rounded`. */ inputsStyle?: string; /** * Show widget shadow. Defaults to `true`. */ showWidgetShadow?: boolean; /** * Widget border weight. Value needs to be between `0` and `10`. Defaults to `0.0`. */ widgetBorderWeight?: number; /** * Widget corner radius. Value needs to be between `0` and `50`. Defaults to `5.0`. */ widgetCornerRadius?: number; } export interface BrandingThemeColors { /** * Base focus color. Defaults to `#635dff`. */ baseFocusColor?: string; /** * Base hover color. Defaults to `#000000`. */ baseHoverColor?: string; /** * Body text. Defaults to `#1e212a`. */ bodyText?: string; /** * Captcha Widget Theme. */ captchaWidgetTheme?: string; /** * Error. Defaults to `#d03c38`. */ error?: string; /** * Header. Defaults to `#1e212a`. */ header?: string; /** * Icons. Defaults to `#65676e`. */ icons?: string; /** * Input background. Defaults to `#ffffff`. */ inputBackground?: string; /** * Input border. Defaults to `#c9cace`. */ inputBorder?: string; /** * Input filled text. Defaults to `#000000`. */ inputFilledText?: string; /** * Input labels & placeholders. Defaults to `#65676e`. */ inputLabelsPlaceholders?: string; /** * Links & focused components. Defaults to `#635dff`. */ linksFocusedComponents?: string; /** * Primary button. Defaults to `#635dff`. */ primaryButton?: string; /** * Primary button label. Defaults to `#ffffff`. */ primaryButtonLabel?: string; /** * Read only background. */ readOnlyBackground?: string; /** * Secondary button border. Defaults to `#c9cace`. */ secondaryButtonBorder?: string; /** * Secondary button label. Defaults to `#1e212a`. */ secondaryButtonLabel?: string; /** * Success. Defaults to `#13a688`. */ success?: string; /** * Widget background. Defaults to `#ffffff`. */ widgetBackground?: string; /** * Widget border. Defaults to `#c9cace`. */ widgetBorder?: string; } export interface BrandingThemeFonts { /** * Body text. */ bodyText: outputs.BrandingThemeFontsBodyText; /** * Buttons text. */ buttonsText: outputs.BrandingThemeFontsButtonsText; /** * Font URL. Defaults to an empty string. */ fontUrl?: string; /** * Input labels. */ inputLabels: outputs.BrandingThemeFontsInputLabels; /** * Links. */ links: outputs.BrandingThemeFontsLinks; /** * Links style. Defaults to `normal`. */ linksStyle?: string; /** * Reference text size. Value needs to be between `12` and `24`. Defaults to `16.0`. */ referenceTextSize?: number; /** * Subtitle. */ subtitle: outputs.BrandingThemeFontsSubtitle; /** * Title. */ title: outputs.BrandingThemeFontsTitle; } export interface BrandingThemeFontsBodyText { /** * Body text bold. Defaults to `false`. */ bold?: boolean; /** * Body text size. Value needs to be between `0` and `150`. Defaults to `87.5`. */ size?: number; } export interface BrandingThemeFontsButtonsText { /** * Buttons text bold. Defaults to `false`. */ bold?: boolean; /** * Buttons text size. Value needs to be between `0` and `150`. Defaults to `100.0`. */ size?: number; } export interface BrandingThemeFontsInputLabels { /** * Input labels bold. Defaults to `false`. */ bold?: boolean; /** * Input labels size. Value needs to be between `0` and `150`. Defaults to `100.0`. */ size?: number; } export interface BrandingThemeFontsLinks { /** * Links bold. Defaults to `true`. */ bold?: boolean; /** * Links size. Value needs to be between `0` and `150`. Defaults to `87.5`. */ size?: number; } export interface BrandingThemeFontsSubtitle { /** * Subtitle bold. Defaults to `false`. */ bold?: boolean; /** * Subtitle size. Value needs to be between `0` and `150`. Defaults to `87.5`. */ size?: number; } export interface BrandingThemeFontsTitle { /** * Title bold. Defaults to `false`. */ bold?: boolean; /** * Title size. Value needs to be between `75` and `150`. Defaults to `150.0`. */ size?: number; } export interface BrandingThemeIdentifiers { /** * Login display style. Available options: `unified`, `separate`. */ loginDisplay: string; /** * Whether OTP autocomplete is enabled. */ otpAutocomplete: boolean; /** * Phone number display settings. */ phoneDisplay: outputs.BrandingThemeIdentifiersPhoneDisplay; } export interface BrandingThemeIdentifiersPhoneDisplay { /** * Phone number formatting. Available options: `international`, `regional`. */ formatting: string; /** * Phone number masking. Available options: `maskDigits`, `hideCountryCode`, `showAll`. */ masking: string; } export interface BrandingThemePageBackground { /** * Background color. Defaults to `#000000`. */ backgroundColor?: string; /** * Background image url. Defaults to an empty string. */ backgroundImageUrl?: string; /** * Page layout. Available options: `center`, `left`, `right`. Defaults to `center`. */ pageLayout?: string; } export interface BrandingThemeWidget { /** * Header text alignment. Available options: `center`, `left`, `right`. Defaults to `center`. */ headerTextAlignment?: string; /** * Logo height. Value needs to be between `1` and `100`. Defaults to `52.0`. */ logoHeight?: number; /** * Logo position. Available options: `center`, `left`, `right`, `none`. Defaults to `center`. */ logoPosition?: string; /** * Logo url. Defaults to an empty string. */ logoUrl?: string; /** * Social buttons layout. Available options: `bottom`, `top`. Defaults to `bottom`. */ socialButtonsLayout?: string; } export interface BrandingUniversalLogin { /** * The html template for the New Universal Login Experience. */ body: string; } export interface ClientAddons { /** * AWS Addon configuration. */ aws?: outputs.ClientAddonsAws; /** * Azure Blob Storage Addon configuration. */ azureBlob?: outputs.ClientAddonsAzureBlob; /** * Azure Storage Bus Addon configuration. */ azureSb?: outputs.ClientAddonsAzureSb; /** * Box SSO indicator (no configuration settings needed for Box SSO). */ box?: outputs.ClientAddonsBox; /** * CloudBees SSO indicator (no configuration settings needed for CloudBees SSO). */ cloudbees?: outputs.ClientAddonsCloudbees; /** * Concur SSO indicator (no configuration settings needed for Concur SSO). */ concur?: outputs.ClientAddonsConcur; /** * Dropbox SSO indicator (no configuration settings needed for Dropbox SSO). */ dropbox?: outputs.ClientAddonsDropbox; /** * Adobe EchoSign SSO configuration. */ echosign?: outputs.ClientAddonsEchosign; /** * Egnyte SSO configuration. */ egnyte?: outputs.ClientAddonsEgnyte; /** * Google Firebase addon configuration. */ firebase?: outputs.ClientAddonsFirebase; /** * Layer addon configuration. */ layer?: outputs.ClientAddonsLayer; /** * Microsoft Dynamics CRM SSO configuration. */ mscrm?: outputs.ClientAddonsMscrm; /** * New Relic SSO configuration. */ newrelic?: outputs.ClientAddonsNewrelic; /** * Microsoft Office 365 SSO configuration. */ office365?: outputs.ClientAddonsOffice365; /** * Active Directory Rights Management Service SSO configuration. */ rms?: outputs.ClientAddonsRms; /** * Salesforce SSO configuration. */ salesforce?: outputs.ClientAddonsSalesforce; /** * Salesforce API addon configuration. */ salesforceApi?: outputs.ClientAddonsSalesforceApi; /** * Salesforce Sandbox addon configuration. */ salesforceSandboxApi?: outputs.ClientAddonsSalesforceSandboxApi; /** * Configuration settings for a SAML add-on. */ samlp?: outputs.ClientAddonsSamlp; /** * SAP API addon configuration. */ sapApi?: outputs.ClientAddonsSapApi; /** * Sentry SSO configuration. */ sentry?: outputs.ClientAddonsSentry; /** * SharePoint SSO configuration. */ sharepoint?: outputs.ClientAddonsSharepoint; /** * Slack team or workspace name usually first segment in your Slack URL, for example `https://acme-org.slack.com` would be `acme-org`. */ slack?: outputs.ClientAddonsSlack; /** * SpringCM SSO configuration. */ springcm?: outputs.ClientAddonsSpringcm; /** * Generic SSO configuration. */ ssoIntegration?: outputs.ClientAddonsSsoIntegration; /** * Windows Azure Mobile Services addon configuration. */ wams?: outputs.ClientAddonsWams; /** * WS-Fed (WIF) addon indicator. Actual configuration is stored in `callback` and `clientAliases` properties on the client. */ wsfed?: outputs.ClientAddonsWsfed; /** * Zendesk SSO configuration. */ zendesk?: outputs.ClientAddonsZendesk; /** * Zoom SSO configuration. */ zoom?: outputs.ClientAddonsZoom; } export interface ClientAddonsAws { /** * AWS token lifetime in seconds. */ lifetimeInSeconds?: number; /** * AWS principal ARN, for example `arn:aws:iam::010616021751:saml-provider/idpname`. */ principal?: string; /** * AWS role ARN, for example `arn:aws:iam::010616021751:role/foo`. */ role?: string; } export interface ClientAddonsAzureBlob { /** * Your Azure storage account name. Usually first segment in your Azure storage URL, for example `https://acme-org.blob.core.windows.net` would be the account name `acme-org`. */ accountName?: string; /** * Indicates if the issued token has permission to delete the blob. */ blobDelete?: boolean; /** * Entity to request a token for, such as `my-blob`. If blank the computed SAS will apply to the entire storage container. */ blobName?: string; /** * Indicates if the issued token has permission to read the content, properties, metadata and block list. Use the blob as the source of a copy operation. */ blobRead?: boolean; /** * Indicates if the issued token has permission to create or write content, properties, metadata, or block list. Snapshot or lease the blob. Resize the blob (page blob only). Use the blob as the destination of a copy operation within the same account. */ blobWrite?: boolean; /** * Indicates if issued token has permission to delete any blob in the container. */ containerDelete?: boolean; /** * Indicates if the issued token has permission to list blobs in the container. */ containerList?: boolean; /** * Container to request a token for, such as `my-container`. */ containerName?: string; /** * Indicates if the issued token has permission to read the content, properties, metadata or block list of any blob in the container. Use any blob in the container as the source of a copy operation. */ containerRead?: boolean; /** * Indicates that for any blob in the container if the issued token has permission to create or write content, properties, metadata, or block list. Snapshot or lease the blob. Resize the blob (page blob only). Use the blob as the destination of a copy operation within the same account. */ containerWrite?: boolean; /** * Expiration in minutes for the generated token (default of 5 minutes). */ expiration?: number; /** * Shared access policy identifier defined in your storage account resource. */ signedIdentifier?: string; /** * Access key associated with this storage account. */ storageAccessKey?: string; } export interface ClientAddonsAzureSb { /** * Entity you want to request a token for, such as `my-queue`. */ entityPath?: string; /** * Optional expiration in minutes for the generated token. Defaults to 5 minutes. */ expiration?: number; /** * Your Azure Service Bus namespace. Usually the first segment of your Service Bus URL (for example `https://acme-org.servicebus.windows.net` would be `acme-org`). */ namespace?: string; /** * Primary Key associated with your shared access policy. */ sasKey?: string; /** * Your shared access policy name defined in your Service Bus entity. */ sasKeyName?: string; } export interface ClientAddonsBox { } export interface ClientAddonsCloudbees { } export interface ClientAddonsConcur { } export interface ClientAddonsDropbox { } export interface ClientAddonsEchosign { /** * Your custom domain found in your EchoSign URL, for example `https://acme-org.echosign.com` would be `acme-org`. */ domain?: string; } export interface ClientAddonsEgnyte { /** * Your custom domain found in your Egnyte URL, for example `https://acme-org.echosign.com` would be `acme-org`. */ domain?: string; } export interface ClientAddonsFirebase { /** * ID of the Service Account you have created (shown as `clientEmail` in the generated JSON file, SDK v3+ tokens only). */ clientEmail?: string; /** * Optional expiration in seconds for the generated token. Defaults to 3600 seconds (SDK v3+ tokens only). */ lifetimeInSeconds?: number; /** * Private Key for signing the token (SDK v3+ tokens only). */ privateKey?: string; /** * Optional ID of the private key to obtain the `kid` header claim from the issued token (SDK v3+ tokens only). */ privateKeyId?: string; /** * Google Firebase Secret. (SDK v2 only). */ secret?: string; } export interface ClientAddonsLayer { /** * Optional expiration in minutes for the generated token. Defaults to 5 minutes. */ expiration?: number; /** * Authentication Key identifier used to sign the Layer token. */ keyId: string; /** * Name of the property used as the unique user ID in Layer. If not specified `userId` is used. */ principal?: string; /** * Private key for signing the Layer token. */ privateKey: string; /** * Provider ID of your Layer account. */ providerId: string; } export interface ClientAddonsMscrm { /** * Microsoft Dynamics CRM application URL. */ url?: string; } export interface ClientAddonsNewrelic { /** * Your New Relic Account ID found in your New Relic URL after the `/accounts/` path, for example `https://rpm.newrelic.com/accounts/123456/query` would be `123456`. */ account?: string; } export interface ClientAddonsOffice365 { /** * Optional Auth0 database connection for testing an already-configured Office 365 tenant. */ connection?: string; /** * Your Office 365 domain name, for example `acme-org.com`. */ domain?: string; } export interface ClientAddonsRms { /** * URL of your Rights Management Server. It can be internal or external, but users will have to be able to reach it. */ url?: string; } export interface ClientAddonsSalesforce { /** * Arbitrary logical URL that identifies the Saleforce resource, for example `https://acme-org.com`. */ entityId?: string; } export interface ClientAddonsSalesforceApi { /** * Consumer Key assigned by Salesforce to the Connected App. */ clientId?: string; /** * Community name. */ communityName?: string; /** * Community URL section. */ communityUrlSection?: string; /** * Name of the property in the user object that maps to a Salesforce username, for example `email`. */ principal?: string; } export interface ClientAddonsSalesforceSandboxApi { /** * Consumer Key assigned by Salesforce to the Connected App. */ clientId?: string; /** * Community name. */ communityName?: string; /** * Community URL section. */ communityUrlSection?: string; /** * Name of the property in the user object that maps to a Salesforce username, for example `email`. */ principal?: string; } export interface ClientAddonsSamlp { /** * Audience of the SAML Assertion. Default will be the Issuer on SAMLRequest. */ audience?: string; /** * Class reference of the authentication context. */ authnContextClassRef?: string; /** * Protocol binding used for SAML logout responses. */ binding?: string; /** * Indicates whether a UPN claim should be created. */ createUpnClaim: boolean; /** * Destination of the SAML Response. If not specified, it will be `AssertionConsumerUrl` of SAMLRequest or callback URL if there was no SAMLRequest. */ destination?: string; /** * Algorithm used to calculate the digest of the SAML Assertion or response. Options include `sha1` and `sha256`. */ digestAlgorithm?: string; /** * This is a supporting attribute to `mappings` field.Please note this is an experimental field. It should only be used when needed to send a map with keys as slices. */ flexibleMappings?: string; /** * 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. */ includeAttributeNameFormat: boolean; /** * Issuer of the SAML Assertion. */ issuer?: string; /** * Number of seconds during which the token is valid. */ lifetimeInSeconds: number; /** * Configuration settings for logout. */ logout?: outputs.ClientAddonsSamlpLogout; /** * Indicates whether or not to add additional identity information in the token, such as the provider used and the `accessToken`, if available. */ mapIdentities: boolean; /** * Indicates whether 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. */ mapUnknownClaimsAsIs?: boolean; /** * Mappings between the Auth0 user profile property name (`name`) and the output attributes on the SAML attribute in the assertion (`value`). */ mappings: { [key: string]: string; }; /** * Format of the name identifier. */ nameIdentifierFormat?: 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. */ nameIdentifierProbes: string[]; /** * Indicates whether or not to passthrough claims that are not mapped to the common profile in the output assertion. */ passthroughClaimsWithNoMapping: boolean; /** * Recipient of the SAML Assertion (SubjectConfirmationData). Default is `AssertionConsumerUrl` on SAMLRequest or callback URL if no SAMLRequest was sent. */ recipient?: string; /** * Indicates whether or not the SAML Response should be signed instead of the SAML Assertion. */ signResponse?: boolean; /** * Algorithm used to sign the SAML Assertion or response. Options include `rsa-sha1` and `rsa-sha256`. */ signatureAlgorithm?: string; /** * Optionally indicates the public key certificate used to validate SAML requests. If set, SAML requests will be required to be signed. A sample value would be `-----BEGIN PUBLIC KEY-----\nMIGf...bpP/t3\n+JGNGIRMj1hF1rnb6QIDAQAB\n-----END PUBLIC KEY-----\n`. */ signingCert?: string; /** * 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`. */ typedAttributes: boolean; } export interface ClientAddonsSamlpLogout { /** * The service provider (client application)'s Single Logout Service URL, where Auth0 will send logout requests and responses. */ callback?: string; /** * Controls whether Auth0 should notify service providers of session termination. */ sloEnabled?: boolean; } export interface ClientAddonsSapApi { /** * If activated in the OAuth 2.0 client configuration (transaction `SOAUTH2) the SAML attribute`client*id`must be set and equal the`client*id` form parameter of the access token request. */ clientId?: string; /** * NameID element of the Subject which can be used to express the user's identity. Defaults to `urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified`. */ nameIdentifierFormat?: string; /** * Requested scope for SAP APIs. */ scope?: string; /** * Service account password to use to authenticate API calls to the token endpoint. */ servicePassword?: string; /** * The OAuth2 token endpoint URL of your SAP OData server. */ tokenEndpointUrl?: string; /** * Name of the property in the user object that maps to a SAP username, for example `email`. */ usernameAttribute?: string; } export interface ClientAddonsSentry { /** * URL prefix only if running Sentry Community Edition, otherwise leave empty. */ baseUrl?: string; /** * Generated slug for your Sentry organization. Found in your Sentry URL, for example `https://sentry.acme.com/acme-org/` would be `acme-org`. */ orgSlug?: string; } export interface ClientAddonsSharepoint { /** * External SharePoint application URLs if exposed to the Internet. */ externalUrls?: string[]; /** * Internal SharePoint application URL. */ url?: string; } export interface ClientAddonsSlack { /** * Slack team name. */ team?: string; } export interface ClientAddonsSpringcm { /** * SpringCM ACS URL, for example `https://na11.springcm.com/atlas/sso/SSOEndpoint.ashx`. */ acsUrl?: string; } export interface ClientAddonsSsoIntegration { /** * SSO integration name. */ name?: string; /** * SSO integration version installed. */ version?: string; } export interface ClientAddonsWams { /** * Your master key for Windows Azure Mobile Services. */ masterKey?: string; } export interface ClientAddonsWsfed { } export interface ClientAddonsZendesk { /** * Zendesk account name. Usually the first segment in your Zendesk URL, for example `https://acme-org.zendesk.com` would be `acme-org`. */ accountName?: string; } export interface ClientAddonsZoom { /** * Zoom account name. Usually the first segment of your Zoom URL, for example `https://acme-org.zoom.us` would be `acme-org`. */ account?: string; } export interface ClientAnonymousSessions { /** * If set to true, this client is allowed to create anonymous sessions. Requires `oidcConformant` to be set to `true`. Set to `false` to disable. (EA only) */ active: boolean; } export interface ClientB2bIntegrationConfiguration { /** * The type of integration used to connect to this B2B integration client. One of custom*auth*server, third_party, application */ integrationType?: string; /** * ID of the self-service SSO profile (an `auth0.SelfServiceProfile` id, in `ssp_...` format) linked to this B2B integration client. Maximum 1. */ ssoProfiles?: string; } export interface ClientCimdDefaultOrganization { /** * Definition of the flow that needs to be configured. Eg. client_credentials */ flows: string[]; /** * The unique identifier of the organization */ organizationId: string; } export interface ClientCimdJwtConfiguration { /** * Algorithm used to sign JWTs. CIMD clients support `RS256`, `RS512`, and `PS256` (asymmetric only). */ alg: string; /** * Number of seconds during which the JWT will be valid. */ lifetimeInSeconds: number; /** * Indicates whether the client secret is Base64-encoded. */ secretEncoded: boolean; } export interface ClientCimdRefreshToken { /** * Refresh token expiration type. Must be `expiring` for CIMD clients. */ expirationType: string; /** * The time in seconds after which inactive refresh tokens will expire. */ idleTokenLifetime: number; /** * Whether inactive refresh tokens should remain valid indefinitely. Must be `false` for CIMD clients. */ infiniteIdleTokenLifetime: boolean; /** * Whether refresh tokens should remain valid indefinitely. If false, `tokenLifetime` should also be set. */ infiniteTokenLifetime: boolean; /** * The amount of time in seconds in which a refresh token may be reused without triggering reuse detection. */ leeway: number; /** * Refresh token rotation type.Valid values are `rotating` and `non-rotating` */ rotationType: string; /** * The absolute lifetime of a refresh token in seconds. */ tokenLifetime: number; } export interface ClientCimdTokenQuota { /** * The token quota configuration for client credentials. */ clientCredentials: outputs.ClientCimdTokenQuotaClientCredentials; } export interface ClientCimdTokenQuotaClientCredentials { /** * If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs. */ enforce?: boolean; /** * Maximum number of issued tokens per day */ perDay?: number; /** * Maximum number of issued tokens per hour */ perHour?: number; } export interface ClientCimdValidation { /** * Whether the metadata document passed validation. */ valid: boolean; /** * Array of validation violation messages, if any. Violations indicate issues that prevented the metadata document from being fully processed. */ violations: string[]; /** * Array of warning messages, if any. Warnings indicate non-critical issues such as unsupported properties being ignored. */ warnings: string[]; } export interface ClientCredentialsPrivateKeyJwt { /** * Client credentials available for use when Private Key JWT is in use as the client authentication method. A maximum of 2 client credentials can be set. */ credentials: outputs.ClientCredentialsPrivateKeyJwtCredential[]; } export interface ClientCredentialsPrivateKeyJwtCredential { /** * Algorithm which will be used with the credential. Can be one of `RS256`, `RS384`, `PS256`. If not specified, `RS256` will be used. */ algorithm?: string; /** * The ISO 8601 formatted date the credential was created. */ createdAt: string; /** * Credential type. Supported types: `publicKey`. */ credentialType: string; /** * The ISO 8601 formatted date representing the expiration of the credential. It is not possible to set this to never expire after it has been set. Recreate the certificate if needed. */ expiresAt: string; /** * The ID of the client credential. */ id: string; /** * The key identifier of the credential, generated on creation. */ keyId: string; /** * Friendly name for a credential. */ name?: string; /** * Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. If also the `expiresAt` is set the credential expiry will be set to the explicit `expiresAt` value. */ parseExpiryFromCert?: boolean; /** * PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped. */ pem: string; /** * The ISO 8601 formatted date the credential was updated. */ updatedAt: string; } export interface ClientCredentialsSelfSignedTlsClientAuth { /** * Credentials that will be enabled on the client for mTLS authentication utilizing self-signed certificates. */ credentials: outputs.ClientCredentialsSelfSignedTlsClientAuthCredential[]; } export interface ClientCredentialsSelfSignedTlsClientAuthCredential { /** * The ISO 8601 formatted date the credential was created. */ createdAt: string; /** * Credential type. Supported types: `x509Cert`. */ credentialType: string; /** * The ISO 8601 formatted date representing the expiration of the credential. */ expiresAt: string; /** * The ID of the client credential. */ id: string; /** * Friendly name for a credential. */ name?: string; /** * PEM-formatted X509 certificate. Must be JSON escaped. */ pem: string; /** * The X509 certificate's SHA256 thumbprint. */ thumbprintSha256: string; /** * The ISO 8601 formatted date the credential was updated. */ updatedAt: string; } export interface ClientCredentialsSignedRequestObject { /** * Client credentials for use with JWT-secured authorization requests. */ credentials: outputs.ClientCredentialsSignedRequestObjectCredential[]; /** * Require JWT-secured authorization requests. */ required: boolean; } export interface ClientCredentialsSignedRequestObjectCredential { /** * Algorithm which will be used with the credential. Can be one of `RS256`, `RS384`, `PS256`. If not specified, `RS256` will be used. */ algorithm?: string; /** * The ISO 8601 formatted date the credential was created. */ createdAt: string; /** * Credential type. Supported types: `publicKey`. */ credentialType: string; /** * The ISO 8601 formatted date representing the expiration of the credential. It is not possible to set this to never expire after it has been set. Recreate the certificate if needed. */ expiresAt: string; /** * The ID of the client credential. */ id: string; /** * The key identifier of the credential, generated on creation. */ keyId: string; /** * Friendly name for a credential. */ name?: string; /** * Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. If also the `expiresAt` is set the credential expiry will be set to the explicit `expiresAt` value. */ parseExpiryFromCert?: boolean; /** * PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped. */ pem: string; /** * The ISO 8601 formatted date the credential was updated. */ updatedAt: string; } export interface ClientCredentialsTlsClientAuth { /** * Credentials that will be enabled on the client for CA-based mTLS authentication. */ credentials: outputs.ClientCredentialsTlsClientAuthCredential[]; } export interface ClientCredentialsTlsClientAuthCredential { /** * The ISO 8601 formatted date the credential was created. */ createdAt: string; /** * Credential type. Supported types: `certSubjectDn`. */ credentialType: string; /** * The ID of the client credential. */ id: string; /** * Friendly name for a credential. */ name?: string; /** * PEM-formatted X509 certificate. Must be JSON escaped. Mutually exlusive with `subjectDn` property. */ pem?: string; /** * Subject Distinguished Name. Mutually exlusive with `pem` property. */ subjectDn: string; /** * The ISO 8601 formatted date the credential was updated. */ updatedAt: string; } export interface ClientCredentialsTokenVaultPrivilegedAccess { /** * Credentials the privileged worker may authenticate with. A maximum of 2 client credentials can be set. */ credentials: outputs.ClientCredentialsTokenVaultPrivilegedAccessCredential[]; /** * Pins the connections, and the scopes within them, that the privileged worker may request tokens for. A maximum of 5 grants can be set, with a maximum of 20 scopes in total across all of them. Omit every `grants` block to clear the grants already configured. */ grants?: outputs.ClientCredentialsTokenVaultPrivilegedAccessGrant[]; /** * Permitted IPv4 or IPv6 addresses, or CIDR ranges, from which the privileged worker may request tokens. A maximum of 10 entries can be set. Set to `[]` to clear the entries already configured. */ ipAllowlists: string[]; } export interface ClientCredentialsTokenVaultPrivilegedAccessCredential { /** * Algorithm which will be used with the credential. Can be one of `RS256`, `RS384`, `PS256`. If not specified, `RS256` will be used. */ algorithm?: string; /** * The ISO 8601 formatted date the credential was created. */ createdAt: string; /** * Credential type. Supported types: `publicKey`. */ credentialType: string; /** * The ISO 8601 formatted date representing the expiration of the credential. It is not possible to set this to never expire after it has been set. Recreate the certificate if needed. */ expiresAt: string; /** * The ID of the client credential. */ id: string; /** * The key identifier of the credential, generated on creation. */ keyId: string; /** * Friendly name for a credential. */ name?: string; /** * Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. If also the `expiresAt` is set the credential expiry will be set to the explicit `expiresAt` value. */ parseExpiryFromCert?: boolean; /** * PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped. */ pem: string; /** * The ISO 8601 formatted date the credential was updated. */ updatedAt: string; } export interface ClientCredentialsTokenVaultPrivilegedAccessGrant { /** * Name of the connection the grant applies to. The connection does not need to exist when the grant is configured; it is validated at runtime. */ connection: string; /** * Scopes the privileged worker may request on the connection. */ scopes: string[]; } export interface ClientDefaultOrganization { /** * If set, the `defaultOrganization` will be removed. */ disable: boolean; /** * Definition of the flow that needs to be configured. Eg. client_credentials */ flows: string[]; /** * The unique identifier of the organization */ organizationId: string; } export interface ClientExpressConfiguration { /** * The domain that admins are expected to log in via for authenticating for express configuration. */ adminLoginDomain?: string; /** * The ID of the connection profile to use for this application. */ connectionProfileId?: string; /** * When true, all connections made via express configuration will be enabled for this application. */ enableClient?: boolean; /** * When true, all connections made via express configuration will have the associated organization enabled. */ enableOrganization?: boolean; /** * The URI users should bookmark to log in to this application. Variable substitution is permitted for: organization*name, organization*id, and connection_name. */ initiateLoginUriTemplate?: string; /** * List of client IDs that are linked to this express configuration (e.g. web or mobile clients). */ linkedClients: outputs.ClientExpressConfigurationLinkedClient[]; /** * The identifier of the published application in the OKTA OIN. */ oinSubmissionId: string; /** * The unique identifier for the Okta OIN Express Configuration Client. */ oktaOinClientId: string; /** * The ID of the user attribute profile to use for this application. */ userAttributeProfileId?: string; } export interface ClientExpressConfigurationLinkedClient { /** * The ID of the linked client. */ clientId?: string; } export interface ClientFedcmLogin { /** * Google FedCM configuration. (EA only) */ google: outputs.ClientFedcmLoginGoogle; } export interface ClientFedcmLoginGoogle { /** * Whether to show the Google FedCM prompt on Login. (EA only) */ isEnabled: boolean; } export interface ClientIdentityAssertionAuthorizationGrant { /** * Whether the client can exchange ID-JAGs for access tokens. (EA only) */ active: boolean; } export interface ClientJwtConfiguration { /** * Algorithm used to sign JWTs. Can be one of `HS256`, `RS256`, `PS256`. */ alg?: string; /** * Number of seconds during which the JWT will be valid. */ lifetimeInSeconds: number; /** * Permissions (scopes) included in JWTs. */ scopes?: { [key: string]: string; }; /** * Indicates whether the client secret is Base64-encoded. */ secretEncoded: boolean; } export interface ClientMobile { /** * Configuration settings for Android native apps. */ android: outputs.ClientMobileAndroid; /** * Configuration settings for i0S native apps. */ ios: outputs.ClientMobileIos; } export interface ClientMobileAndroid { appPackageName?: string; sha256CertFingerprints?: string[]; } export interface ClientMobileIos { appBundleIdentifier?: string; teamId?: string; } export interface ClientMyOrganizationConfiguration { /** * The list of connection strategies that are allowed when creating organizations for this client (e.g. "okta", "samlp"). */ allowedStrategies?: string[]; /** * Controls the behavior when deleting connections associated with organizations for this client. Possible values: `allow`, `allowIfEmpty`. */ connectionDeletionBehavior?: string; /** * The ID of the connection profile to use when creating organizations for this client. */ connectionProfileId?: string; /** * When true, limits the permissions that organization admins can assign to members to only those held by the admin themselves. Requires the `myOrgMemberManagementEa` feature flag. Available in Early Access (EA). */ enforcePermissionCeiling?: boolean; /** * When true, prevents organization admins from assigning permissions to themselves. Requires the `myOrgMemberManagementEa` feature flag. Available in Early Access (EA). */ enforceSelfAssignmentRestriction?: boolean; /** * The client ID used as the invitation landing page when creating invitations through the My Organization API. Requires the tenant to have member management enabled, and the referenced client must allow organizations. */ invitationLandingClientId?: string; /** * Configures third-party client access to organizations created for this client through the My Organization API. Requires the `myOrgsThirdPartyClientSupport` (EA Only) */ thirdPartyClientAccess?: outputs.ClientMyOrganizationConfigurationThirdPartyClientAccess; /** * The ID of the user attribute profile to use when creating organizations for this client. */ userAttributeProfileId?: string; } export interface ClientMyOrganizationConfigurationThirdPartyClientAccess { /** * The third-party client access values that can be set on organizations created for this client through the My Organization API. Required whenever this block is set — the API rejects the block without it. Possible values: `allow`, `block`. Unlike `auth0.ConnectionProfile`'s `crossAppAccessResourceApp`, a single value is accepted here. (EA Only) */ allowedValues: string[]; /** * The default third-party client access value applied to organizations created for this client. The API currently only accepts "block"; "allow" is rejected with a 400 error, so this is exposed as computed-only rather than user-settable. (EA Only) */ defaultValue: string; } export interface ClientNativeSocialLogin { apple: outputs.ClientNativeSocialLoginApple; facebook: outputs.ClientNativeSocialLoginFacebook; google: outputs.ClientNativeSocialLoginGoogle; } export interface ClientNativeSocialLoginApple { enabled?: boolean; } export interface ClientNativeSocialLoginFacebook { enabled?: boolean; } export interface ClientNativeSocialLoginGoogle { enabled?: boolean; } export interface ClientOidcLogout { /** * Configure OIDC logout initiators for the Client */ backchannelLogoutInitiators?: outputs.ClientOidcLogoutBackchannelLogoutInitiators; /** * Controls whether session metadata is included in the logout token. Default value is null. */ backchannelLogoutSessionMetadata?: outputs.ClientOidcLogoutBackchannelLogoutSessionMetadata; /** * Set of URLs that are valid to call back from Auth0 for OIDC backchannel logout. Currently only one URL is allowed. */ backchannelLogoutUrls: string[]; } export interface ClientOidcLogoutBackchannelLogoutInitiators { /** * Determines the configuration method for enabling initiators. `custom` enables only the initiators listed in the backchannel*logout*selected_initiators set, `all` enables all current and future initiators. */ mode: string; /** * Contains the list of initiators to be enabled for the given client. */ selectedInitiators?: string[]; } export interface ClientOidcLogoutBackchannelLogoutSessionMetadata { /** * The `include` property determines whether session metadata is included in the logout token. */ include: boolean; } export interface ClientProfileApplyPolicy { /** * The creator of the clients to match. Defaults to `client`, which means the client was registered dynamically. Possible values: [client]. */ externalMetadataCreatedBy: string; /** * The type of external metadata of the clients to match. Defaults to `cimd`. Possible values: [cimd]. */ externalMetadataType: string; } export interface ClientProfileClientConfiguration { /** * Methods used to discover the organization during login. Requires the `organizationRequireBehavior` default value to be `preLoginPrompt`. */ organizationDiscoveryMethods?: outputs.ClientProfileClientConfigurationOrganizationDiscoveryMethods; /** * Defines how to proceed during an authentication transaction when the organization usage is `require`. */ organizationRequireBehavior?: outputs.ClientProfileClientConfigurationOrganizationRequireBehavior; /** * Whether matched clients can use organizations. */ organizationUsage?: outputs.ClientProfileClientConfigurationOrganizationUsage; /** * Refresh token settings applied to matched clients. Auth0 replaces this block as a whole, so removing it clears all of its settings. */ refreshToken?: outputs.ClientProfileClientConfigurationRefreshToken; /** * Whether matched clients must use proof of possession (DPoP) for their tokens. */ requireProofOfPossession?: outputs.ClientProfileClientConfigurationRequireProofOfPossession; } export interface ClientProfileClientConfigurationOrganizationDiscoveryMethods { /** * Possible values: [email organizationName]. */ defaultValues: string[]; } export interface ClientProfileClientConfigurationOrganizationRequireBehavior { /** * Possible values: [no*prompt pre*login*prompt post*login_prompt]. */ defaultValue: string; } export interface ClientProfileClientConfigurationOrganizationUsage { /** * Possible values: [deny allow require]. */ defaultValue: string; } export interface ClientProfileClientConfigurationRefreshToken { /** * The inactivity lifetime of a refresh token. It must not exceed `tokenLifetime`. If only one of `tokenLifetime` and `idleTokenLifetime` is set, Auth0 derives the other. */ idleTokenLifetime: outputs.ClientProfileClientConfigurationRefreshTokenIdleTokenLifetime; /** * The period in which a refresh token may be reused without triggering reuse detection. */ leeway?: outputs.ClientProfileClientConfigurationRefreshTokenLeeway; /** * The absolute lifetime of a refresh token. If only one of `tokenLifetime` and `idleTokenLifetime` is set, Auth0 derives the other. */ tokenLifetime: outputs.ClientProfileClientConfigurationRefreshTokenTokenLifetime; } export interface ClientProfileClientConfigurationRefreshTokenIdleTokenLifetime { /** * The lifetime in seconds. */ defaultValue: number; } export interface ClientProfileClientConfigurationRefreshTokenLeeway { /** * The leeway in seconds. `0` disables the leeway. */ defaultValue: number; } export interface ClientProfileClientConfigurationRefreshTokenTokenLifetime { /** * The lifetime in seconds. */ defaultValue: number; } export interface ClientProfileClientConfigurationRequireProofOfPossession { /** * Whether proof of possession is required. */ defaultValue: boolean; } export interface ClientRefreshToken { /** * Options include `expiring`, `non-expiring`. Whether a refresh token will expire based on an absolute lifetime, after which the token can no longer be used. If rotation is `rotating`, this must be set to `expiring`. */ expirationType: string; /** * The time in seconds after which inactive refresh tokens will expire. */ idleTokenLifetime: number; /** * Whether inactive refresh tokens should remain valid indefinitely. */ infiniteIdleTokenLifetime: boolean; /** * Whether refresh tokens should remain valid indefinitely. If false, `tokenLifetime` should also be set. */ infiniteTokenLifetime: boolean; /** * The amount of time in seconds in which a refresh token may be reused without triggering reuse detection. */ leeway: number; /** * A collection of policies governing multi-resource refresh token exchange (MRRT), defining how refresh tokens can be used across different resource servers */ policies?: outputs.ClientRefreshTokenPolicy[]; /** * Options include `rotating`, `non-rotating`. When `rotating`, exchanging a refresh token will cause a new refresh token to be issued and the existing token will be invalidated. This allows for automatic detection of token reuse if the token is leaked. */ rotationType: string; /** * The absolute lifetime of a refresh token in seconds. */ tokenLifetime: number; } export interface ClientRefreshTokenPolicy { /** * The identifier of the resource server to which the Multi Resource Refresh Token Policy applies */ audience: string; /** * The resource server permissions granted under the Multi Resource Refresh Token Policy, defining the context in which an access token can be used */ scopes: string[]; } export interface ClientSessionTransfer { /** * Indicates whether the application is allowed to use a refresh token when using a session*transfer*token session. */ allowRefreshToken: boolean; allowedAuthenticationMethods: string[]; /** * Indicates whether the application(Native app) can use the Token Exchange endpoint to create a session*transfer*token */ canCreateSessionTransferToken: boolean; /** * Configuration for delegation (impersonation) access using Session Transfer Tokens. */ delegation?: outputs.ClientSessionTransferDelegation; /** * Indicates whether revoking the parent Refresh Token that initiated a Native to Web flow and was used to issue a Session Transfer Token should trigger a cascade revocation affecting its dependent child entities. Usually configured in the native application. */ enforceCascadeRevocation?: boolean; /** * Configures the level of device binding enforced when a session*transfer*token is consumed. Can be one of `ip`, `asn` or `none`. */ enforceDeviceBinding: string; /** * Indicates whether Refresh Tokens created during a native-to-web session are tied to that session's lifetime. This determines if such refresh tokens should be automatically revoked when their corresponding sessions are. Usually configured in the web application. */ enforceOnlineRefreshTokens?: boolean; } export interface ClientSessionTransferDelegation { /** * Indicates whether delegation (impersonation) access is allowed using Session Transfer Tokens. Defaults to `false`. */ allowDelegatedAccess: boolean; /** * Indicates the device binding enforcement for delegation (impersonation) access. If set to 'ip', device binding is enforced by IP. If set to 'asn', device binding is enforced by ASN. Defaults to `ip`. */ enforceDeviceBinding: string; } export interface ClientTokenExchange { /** * List of allowed profile types for token exchange. Supported values include: custom*authentication, on*behalf*of*token_exchange. */ allowAnyProfileOfTypes: string[]; } export interface ClientTokenQuota { /** * The token quota configuration for client credentials. */ clientCredentials: outputs.ClientTokenQuotaClientCredentials; } export interface ClientTokenQuotaClientCredentials { /** * If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs. */ enforce?: boolean; /** * Maximum number of issued tokens per day */ perDay?: number; /** * Maximum number of issued tokens per hour */ perHour?: number; } export interface ConnectionAuthentication { active: boolean; } export interface ConnectionConnectedAccounts { active: boolean; } export interface ConnectionCrossAppAccessRequestingApp { active: boolean; } export interface ConnectionCrossAppAccessResourceApp { /** * Whether the connection acts as a Cross App Access resource application. One of `enabled` or `disabled`. (EA only) */ status: string; } export interface ConnectionDirectoryMapping { /** * The field location in the Auth0 schema. */ auth0: string; /** * The field location in the IDP schema. */ idp: string; } export interface ConnectionDirectorySynchronizedGroupsGroup { /** * Number of direct members in the Google Workspace Directory group. */ directMembersCount?: number; /** * Google Workspace Directory group email. */ email?: string; /** * Google Workspace Directory group ID. */ id: string; /** * Google Workspace Directory group name. */ name?: string; } export interface ConnectionOptions { /** * URL used to exchange a user-authorized request token for an access token. */ accessTokenUrl?: string; /** * ADFS URL where to fetch the metadata source. */ adfsServer?: string; /** * List of allowed audiences. */ allowedAudiences: string[]; /** * Enable API Access to groups. */ apiEnableGroups?: boolean; /** * Enable API Access to users. */ apiEnableUsers?: boolean; /** * App ID. */ appId?: string; /** * Settings for SAML assertion decryption. Only applicable when strategy=samlp or pingfederate. */ assertionDecryptionSettings: outputs.ConnectionOptionsAssertionDecryptionSettings; /** * OpenID Connect and Okta Workforce connections can automatically map claims received from the identity provider (IdP). You can configure this mapping through a library template provided by Auth0 or by entering your own template directly. Click [here](https://auth0.com/docs/authenticate/identity-providers/enterprise-identity-providers/configure-pkce-claim-mapping-for-oidc#map-claims-for-oidc-connections) for more info. */ attributeMap: outputs.ConnectionOptionsAttributeMap; /** * Order of attributes for precedence in identification.Valid values: email, phone*number, username. If Precedence is set, it must contain all values (email, phone*number, username) in specific order */ attributes?: outputs.ConnectionOptionsAttribute[]; /** * Query string parameters to be included as part of the generated passwordless email link. */ authParams?: { [key: string]: string; }; /** * Specifies the authentication methods and their configuration (enabled or disabled) */ authenticationMethods: outputs.ConnectionOptionsAuthenticationMethod[]; /** * Authorization endpoint. */ authorizationEndpoint: string; /** * Indicates whether to enable brute force protection, which will limit the number of signups and failed logins from a suspicious IP address. */ bruteForceProtection: boolean; /** * The strategy's client ID. */ clientId?: string; /** * The strategy's client secret. **Note:** For better security, consider using `optionsClientSecretWo` instead to avoid storing the secret in Terraform state. */ clientSecret?: string; /** * Salesforce community base URL. */ communityBaseUrl?: string; /** * A case-sensitive map of key value pairs used as configuration variables for the `customScript`. */ configuration?: { [key: string]: string; }; /** * Proof Key for Code Exchange (PKCE) configuration settings for an OIDC or Okta Workforce connection. */ connectionSettings: outputs.ConnectionOptionsConnectionSettings; /** * Identifies the client to the service provider */ consumerKey?: string; /** * Secret used to establish ownership of the consumer key. */ consumerSecret?: string; /** * Configure extra headers to the Token endpoint of an OAuth 2.0 provider */ customHeaders?: outputs.ConnectionOptionsCustomHeader[]; /** * Configure custom password hashing within a connection. (EA only) */ customPasswordHash?: outputs.ConnectionOptionsCustomPasswordHash; /** * A map of scripts used to integrate with a custom database. */ customScripts?: { [key: string]: string; }; /** * When enabled, additional debug information will be generated. */ debug?: boolean; /** * The key used to decrypt encrypted responses from the connection. Uses the `key` and `cert` properties to provide the private key and certificate respectively. */ decryptionKey?: outputs.ConnectionOptionsDecryptionKey; /** * The destination URL for the SAML assertion. Used when configuring a SAML connection for proxy gateways. */ destinationUrl?: string; /** * Sign Request Algorithm Digest. */ digestAlgorithm?: string; /** * Indicates whether to disable the cache or not. */ disableCache?: boolean; /** * Indicates whether to remove the forgot password link within the New Universal Login. */ disableSelfServiceChangePassword?: boolean; /** * When enabled, will disable sign out. */ disableSignOut?: boolean; /** * Indicates whether to allow user sign-ups to your application. */ disableSignup?: boolean; /** * OpenID discovery URL, e.g. `https://auth.example.com/.well-known/openid-configuration`. */ discoveryUrl?: string; /** * Domain name. */ domain?: string; /** * List of the domains that can be authenticated using the identity provider. Only needed for Identifier First authentication flows. */ domainAliases: string[]; /** * The algorithm used to sign the DPoP proof. Allowed values: ES256, ES384, ES512, Ed25519. */ dpopSigningAlg?: string; /** * Indicates whether to request the email scope. Used by some OAuth2 connections (e.g., LINE). */ email: boolean; /** * Set to `true` to inject context into custom DB scripts (warning: cannot be disabled once enabled). */ enableScriptContext?: boolean; /** * Set to `true` to use a legacy user store. */ enabledDatabaseCustomization?: boolean; /** * Custom Entity ID for the connection. */ entityId?: string; /** * Federation Metadata for the ADFS connection. */ fedMetadataXml?: string; /** * Configuration for collecting access tokens and refresh tokens from federated connections. Only applicable for OIDC connections. */ federatedConnectionsAccessTokens: outputs.ConnectionOptionsFederatedConnectionsAccessTokens; /** * If you're configuring a SAML enterprise connection for a non-standard PingFederate Server, you must update the attribute mappings. */ fieldsMap?: string; /** * Specifies whether or not request info should be forwarded to sms gateway. */ forwardRequestInfo?: boolean; /** * Address to use as the sender. */ from?: string; /** * Defines the parameters used to generate the auth token for the custom gateway. */ gatewayAuthentication?: outputs.ConnectionOptionsGatewayAuthentication; /** * Defines a custom sms gateway to use instead of Twilio. */ gatewayUrl?: string; /** * Specifies the issuer of the JWT used for global token revocation for the SAML connection. */ globalTokenRevocationJwtIss?: string; /** * Specifies the subject of the JWT used for global token revocation for the SAML connection. */ globalTokenRevocationJwtSub?: string; /** * Icon URL. */ iconUrl?: string; /** * Indicates whether the identity provider supports session expiry via the id*token. When true, Auth0 will use the session*expiry claim from the upstream IdP's ID token to determine the maximum session lifetime. Only applicable for Okta and OIDC connections. */ idTokenSessionExpirySupported?: boolean; /** * List of allowed algorithms for the ID token signature. If not set or empty, default algorithm(s) will be applied at runtime. (Okta/OIDC Connections) */ idTokenSignedResponseAlgs?: string[]; /** * Azure AD Identity API. Available options are: `microsoft-identity-platform-v2.0` or `azure-active-directory-v1.0`. */ identityApi?: string; /** * Configuration options for IDP Initiated Authentication. This is an object with the properties: `clientId`, `clientProtocol`, and `clientAuthorizeQuery`. */ idpInitiated?: outputs.ConnectionOptionsIdpInitiated; /** * Indicates whether you have a legacy user store and want to gradually migrate those users to the Auth0 user store. */ importMode?: boolean; /** * A list of IPs. */ ips: string[]; /** * Issuer URL, e.g. `https://auth.example.com`. */ issuer: string; /** * JWKS URI. */ jwksUri: string; /** * Apple Key ID. */ keyId?: string; /** * By default Auth0 maps `userId` to `email`. Enabling this setting changes the behavior to map `userId` to 'id' instead. This can only be defined on a new Google Workspace connection and can not be changed once set. */ mapUserIdToId: boolean; /** * Maximum number of groups to retrieve. */ maxGroupsToRetrieve?: string; /** * SID for Copilot. Used when SMS Source is Copilot. */ messagingServiceSid?: string; /** * The URL of the SAML metadata document. */ metadataUrl?: string; /** * The XML content for the SAML metadata document. Values within the xml will take precedence over other attributes set on the options block. */ metadataXml?: string; /** * Configuration options for multifactor authentication. */ mfa: outputs.ConnectionOptionsMfa; /** * The public name of the email or SMS Connection. In most cases this is the same name as the connection name. */ name?: string; /** * If there are user fields that should not be stored in Auth0 databases due to privacy reasons, you can add them to the DenyList here. */ nonPersistentAttrs: string[]; /** * Additional OIDC metadata to include in the discovery document. Only applicable when strategy=oidc, okta, or samlp. On oidc and okta, Auth0 defaults any omitted `claimsParameterSupported`, `requestParameterSupported`, `requestUriParameterSupported`, `requireRequestUriRegistration` field to false. Those defaults are not tracked in provider until set to true explisitly. (EA only) */ oidcMetadata: string; /** * One-time password settings for database (`auth0` strategy) connections, configurable per delivery channel. (EA only) */ otpSettings?: outputs.ConnectionOptionsOtpSettings; /** * Defines options for the passkey authentication method */ passkeyOptions: outputs.ConnectionOptionsPasskeyOptions; /** * Configuration settings for password complexity. */ passwordComplexityOptions: outputs.ConnectionOptionsPasswordComplexityOptions; /** * Configuration settings for the password dictionary check, which does not allow passwords that are part of the password dictionary. */ passwordDictionary: outputs.ConnectionOptionsPasswordDictionary; /** * Configuration settings for the password history that is maintained for each user to prevent the reuse of passwords. */ passwordHistories: outputs.ConnectionOptionsPasswordHistory[]; /** * 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`. */ passwordNoPersonalInfo: outputs.ConnectionOptionsPasswordNoPersonalInfo; /** * Flexible password policy configuration. Only available for `auth0` strategy connections. Cannot be set together with legacy password policy fields (`passwordPolicy`, `passwordComplexityOptions`, `passwordHistory`, `passwordNoPersonalInfo`, `passwordDictionary`). */ passwordOptions: outputs.ConnectionOptionsPasswordOptions; /** * 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`. */ passwordPolicy: string; /** * Ping Federate Server URL. */ pingFederateBaseUrl?: string; /** * Enables Proof Key for Code Exchange (PKCE) functionality for OAuth2 connections. */ pkceEnabled?: boolean; /** * Order of attributes for precedence in identification.Valid values: email, phone*number, username. If Precedence is set, it must contain all values (email, phone*number, username) in specific order */ precedences?: string[]; /** * The SAML Response Binding: how the SAML token is received by Auth0 from the IdP. */ protocolBinding?: string; /** * Defines the custom `smsGateway` provider. */ provider?: string; /** * Allows configuration if connections*realm*fallback flag is enabled for the tenant */ realmFallback?: boolean; /** * The recipient URL for the SAML assertion. Used when configuring a SAML connection for proxy gateways. */ recipientUrl?: string; /** * Template that formats the SAML request. */ requestTemplate?: string; /** * URL used to obtain an unauthorized request token. */ requestTokenUrl?: string; /** * Indicates whether the user is required to provide a username in addition to an email address. */ requiresUsername?: boolean; /** * Permissions to grant to the connection. Within the Auth0 dashboard these appear under the "Attributes" and "Extended Attributes" sections. Some examples: `basicProfile`, `extProfile`, `extNestedGroups`, etc. */ scopes: string[]; /** * A map of scripts used for an OAuth connection. Only accepts a `fetchUserProfile` script. */ scripts?: { [key: string]: string; }; /** * When true and `type` is 'back_channel', includes a cryptographic nonce in authorization requests to prevent replay attacks. The identity provider must include this nonce in the ID token for validation. */ sendBackChannelNonce?: boolean; /** * Session Key for storing the request token. */ sessionKey?: string; /** * Determines whether to sync user profile attributes (`name`, `givenName`, `familyName`, `nickname`, `picture`) at each login or only on the first login. Options include: `onEachLogin`, `onFirstLogin`, `neverOnLogin`. Default value: `onEachLogin`. */ setUserRootAttributes: string; /** * Choose how Auth0 sets the emailVerified field in the user profile. */ shouldTrustEmailVerifiedConnection?: string; /** * SAML single login URL for the connection. */ signInEndpoint: string; /** * SAML single logout URL for the connection. */ signOutEndpoint: string; /** * When enabled, the SAML authentication request will be signed. */ signSamlRequest?: boolean; /** * Sign Request Algorithm. */ signatureAlgorithm?: string; /** * Signature method used to sign the request */ signatureMethod?: string; /** * X.509 signing certificate (encoded in PEM or CER) you retrieved from the IdP, Base64-encoded. */ signingCert: string; /** * The key used to sign requests in the connection. Uses the `key` and `cert` properties to provide the private key and certificate respectively. */ signingKey?: outputs.ConnectionOptionsSigningKey; /** * Version 1 is deprecated, use version 2. */ strategyVersion: number; /** * Subject line of the email. */ subject?: string; /** * Syntax of the template body. */ syntax?: string; /** * Apple Team ID. */ teamId?: string; /** * Body of the template. */ template?: string; /** * Tenant domain name. */ tenantDomain?: string; /** * Token endpoint. */ tokenEndpoint: string; /** * Specifies the authentication method for the token endpoint. (Okta/OIDC Connections) */ tokenEndpointAuthMethod?: string; /** * Specifies the signing algorithm for the token endpoint. (Okta/OIDC Connections) */ tokenEndpointAuthSigningAlg?: string; /** * Specifies the format of the aud (audience) claim in the JWT for client authentication. Accepted values: 'issuer' or 'token_endpoint'. (Okta/OIDC Connections) */ tokenEndpointJwtcaAudFormat?: string; /** * Configuration options for one-time passwords. */ totp?: outputs.ConnectionOptionsTotp; /** * SID for your Twilio account. */ twilioSid?: string; /** * AuthToken for your Twilio account. */ twilioToken?: string; /** * The connection's communication channel type. For OIDC connections, accepted values are `backChannel` and `frontChannel`; for Okta Workforce connections, only `backChannel` is accepted. Front Channel uses the OIDC protocol with `response_mode=form_post` and `response_type=id_token`. Back Channel uses `response_type=code`. */ type: string; /** * You can pass provider-specific parameters to an identity provider during authentication. The values can either be static per connection or dynamic per user. */ upstreamParams?: string; /** * Indicates whether to use cert auth or not. */ useCertAuth?: boolean; /** * Indicates whether to use Kerberos or not. */ useKerberos?: boolean; /** * Enabling this when using the connectionScope parameter, uses space as a delimiter for scopes when calling the IdP's API. */ useOauthSpecScope?: boolean; /** * Whether to use WS-Fed. */ useWsfed?: boolean; /** * URL used to obtain user authorization. */ userAuthorizationUrl?: string; /** * Attribute in the token that will be mapped to the userId property in Auth0. */ userIdAttribute?: string; /** * User info endpoint. */ userinfoEndpoint: string; /** * Validation of the minimum and maximum values allowed for a user to have as username. */ validation?: outputs.ConnectionOptionsValidation; /** * Indicates whether 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. */ waadCommonEndpoint?: boolean; /** * Protocol to use. */ waadProtocol?: string; } export interface ConnectionOptionsAssertionDecryptionSettings { /** * A list of insecure algorithms to allow for SAML assertion decryption. */ algorithmExceptions?: string[]; /** * The algorithm profile to use for decrypting SAML assertions. Options include: `v2026-1`. */ algorithmProfile: string; } export interface ConnectionOptionsAttribute { /** * Connection Options for Email Attribute */ emails?: outputs.ConnectionOptionsAttributeEmail[]; /** * Connection Options for Phone Number Attribute */ phoneNumbers?: outputs.ConnectionOptionsAttributePhoneNumber[]; /** * Connection Options for User Name Attribute */ usernames?: outputs.ConnectionOptionsAttributeUsername[]; } export interface ConnectionOptionsAttributeEmail { /** * Connection Options Email Attribute Identifier */ identifiers: outputs.ConnectionOptionsAttributeEmailIdentifier[]; /** * Defines whether Profile is required */ profileRequired: boolean; /** * Defines signup settings for Email attribute */ signups: outputs.ConnectionOptionsAttributeEmailSignup[]; /** * If set to false, it allow multiple accounts with the same email address. Defaults to `true`. This can only be set when the connection is created: the Auth0 Management API does not allow updating it, so changing it on an existing connection fails at plan time and requires recreating the connection. The API also refuses to add a non-unique email attribute to a connection that does not already have one. */ unique: boolean; /** * Defines whether whether user will receive a link or an OTP during user signup for email verification and password reset for email verification */ verificationMethod: string; } export interface ConnectionOptionsAttributeEmailIdentifier { /** * Defines whether email attribute is active as an identifier */ active: boolean; /** * Gets and Sets the default authentication method for the email identifier type. Valid values: `password`, `emailOtp` */ defaultMethod?: string; } export interface ConnectionOptionsAttributeEmailSignup { /** * Defines signup status for Email Attribute */ status: string; /** * Defines settings for Verification under Email attribute */ verifications: outputs.ConnectionOptionsAttributeEmailSignupVerification[]; } export interface ConnectionOptionsAttributeEmailSignupVerification { /** * Defines verification settings for signup attribute */ active: boolean; } export interface ConnectionOptionsAttributeMap { /** * This property is an object containing mapping information that allows Auth0 to interpret incoming claims from the IdP. Mapping information must be provided as key/value pairs. */ attributes?: string; /** * Method used to map incoming claims. Possible values: `useMap` (Okta or OIDC), `bindAll` (OIDC) or `basicProfile` (Okta). */ mappingMode: string; /** * This property defines the scopes that Auth0 sends to the IdP’s UserInfo endpoint when requested. */ userinfoScope?: string; } export interface ConnectionOptionsAttributePhoneNumber { /** * Connection Options Phone Number Attribute Identifier */ identifiers: outputs.ConnectionOptionsAttributePhoneNumberIdentifier[]; /** * Defines whether Profile is required */ profileRequired: boolean; /** * Defines signup settings for Phone Number attribute */ signups: outputs.ConnectionOptionsAttributePhoneNumberSignup[]; } export interface ConnectionOptionsAttributePhoneNumberIdentifier { /** * Defines whether Phone Number attribute is active as an identifier */ active: boolean; /** * Gets and Sets the default authentication method for the phoneNumber identifier type. Valid values: `password`, `phoneOtp` */ defaultMethod: string; } export interface ConnectionOptionsAttributePhoneNumberSignup { /** * Defines status of signup for Phone Number attribute */ status: string; /** * Defines verification settings for Phone Number attribute */ verifications: outputs.ConnectionOptionsAttributePhoneNumberSignupVerification[]; } export interface ConnectionOptionsAttributePhoneNumberSignupVerification { /** * Defines verification settings for Phone Number attribute */ active: boolean; } export interface ConnectionOptionsAttributeUsername { /** * Connection options for User Name Attribute Identifier */ identifiers: outputs.ConnectionOptionsAttributeUsernameIdentifier[]; /** * Defines whether Profile is required */ profileRequired: boolean; /** * Defines signup settings for User Name attribute */ signups: outputs.ConnectionOptionsAttributeUsernameSignup[]; /** * Defines validation settings for User Name attribute */ validations: outputs.ConnectionOptionsAttributeUsernameValidation[]; } export interface ConnectionOptionsAttributeUsernameIdentifier { /** * Defines whether UserName attribute is active as an identifier */ active: boolean; /** * Gets and Sets the default authentication method for the username identifier type. Valid value: `password` */ defaultMethod?: string; } export interface ConnectionOptionsAttributeUsernameSignup { /** * Defines whether User Name attribute is active as an identifier */ status: string; } export interface ConnectionOptionsAttributeUsernameValidation { /** * Defines allowed types for for UserName attribute */ allowedTypes: outputs.ConnectionOptionsAttributeUsernameValidationAllowedType[]; /** * Defines Max Length for User Name attribute */ maxLength: number; /** * Defines Min Length for User Name attribute */ minLength: number; } export interface ConnectionOptionsAttributeUsernameValidationAllowedType { /** * One of the allowed types for UserName signup attribute */ email: boolean; /** * One of the allowed types for UserName signup attribute */ phoneNumber: boolean; } export interface ConnectionOptionsAuthenticationMethod { /** * Configures Email OTP authentication */ emailOtp: outputs.ConnectionOptionsAuthenticationMethodEmailOtp; /** * Configures passkey authentication */ passkey: outputs.ConnectionOptionsAuthenticationMethodPasskey; /** * Configures password authentication */ password: outputs.ConnectionOptionsAuthenticationMethodPassword; /** * Configures Phone OTP authentication */ phoneOtp: outputs.ConnectionOptionsAuthenticationMethodPhoneOtp; } export interface ConnectionOptionsAuthenticationMethodEmailOtp { /** * Enables Email OTP authentication */ enabled: boolean; } export interface ConnectionOptionsAuthenticationMethodPasskey { /** * Enables passkey authentication */ enabled: boolean; } export interface ConnectionOptionsAuthenticationMethodPassword { /** * Specifies whether password is required or optional when creating users via API. Possible values: "required", "optional". Defaults to "required". */ apiBehavior?: string; /** * Enables password authentication */ enabled: boolean; /** * Specifies whether password is allowed or blocked during signup flows. Possible values: "allow", "block". Defaults to "allow". */ signupBehavior?: string; } export interface ConnectionOptionsAuthenticationMethodPhoneOtp { /** * Enables Phone OTP authentication */ enabled: boolean; } export interface ConnectionOptionsConnectionSettings { /** * PKCE configuration. Possible values: `auto` (uses the strongest algorithm available), `S256` (uses the SHA-256 algorithm), `plain` (uses plaintext as described in the PKCE specification) or `disabled` (disables support for PKCE). */ pkce: string; } export interface ConnectionOptionsCustomHeader { header: string; value: string; } export interface ConnectionOptionsCustomPasswordHash { /** * Id of an existing action that should be invoked when validating a universal password hash. This action must support password-hash-migration trigger */ actionId: string; } export interface ConnectionOptionsDecryptionKey { cert: string; key: string; } export interface ConnectionOptionsFederatedConnectionsAccessTokens { /** * When enabled, Auth0 will collect and store access tokens and refresh tokens obtained from federated connections during authentication. */ active: boolean; } export interface ConnectionOptionsGatewayAuthentication { /** * Audience claim for the HS256 token sent to `gatewayUrl`. */ audience?: string; /** * Authentication method (default is `bearer` token). */ method?: string; /** * Secret used to sign the HS256 token sent to `gatewayUrl`. */ secret?: string; /** * Specifies whether or not the secret is Base64-encoded. */ secretBase64Encoded?: boolean; /** * Subject claim for the HS256 token sent to `gatewayUrl`. */ subject?: string; } export interface ConnectionOptionsIdpInitiated { clientAuthorizeQuery?: string; clientId?: string; clientProtocol?: string; enabled?: boolean; } export interface ConnectionOptionsMfa { /** * Indicates whether multifactor authentication is enabled for this connection. */ active?: boolean; /** * Indicates whether multifactor authentication enrollment settings will be returned. */ returnEnrollSettings?: boolean; } export interface ConnectionOptionsOtpSettings { /** * One-time password settings for the email delivery channel. */ email?: outputs.ConnectionOptionsOtpSettingsEmail; /** * One-time password settings for the phone delivery channel. */ phone?: outputs.ConnectionOptionsOtpSettingsPhone; } export interface ConnectionOptionsOtpSettingsEmail { /** * Number of seconds before the one-time password expires. Must be between 60 and 86400. Defaults to 900 if not set. */ otpExpiry?: number; /** * Number of digits in the generated one-time password. Must be between 4 and 48. Defaults to 6 if not set. */ otpLength?: number; } export interface ConnectionOptionsOtpSettingsPhone { /** * Number of seconds before the one-time password expires. Must be between 60 and 86400. Defaults to 900 if not set. */ otpExpiry?: number; /** * Number of digits in the generated one-time password. Must be between 4 and 48. Defaults to 6 if not set. */ otpLength?: number; } export interface ConnectionOptionsPasskeyOptions { /** * Controls the UI used to challenge the user for their passkey */ challengeUi: string; /** * Enables or disables enrollment prompt for local passkey when user authenticates using a cross-device passkey for the connection */ localEnrollmentEnabled: boolean; /** * Enables or disables progressive enrollment of passkeys for the connection */ progressiveEnrollmentEnabled: boolean; } export interface ConnectionOptionsPasswordComplexityOptions { /** * Minimum number of characters allowed in passwords. */ minLength?: number; } export interface ConnectionOptionsPasswordDictionary { /** * Customized contents of the password dictionary. By default, the password dictionary contains a list of the [10,000 most common passwords](https://github.com/danielmiessler/SecLists/blob/master/Passwords/Common-Credentials/10k-most-common.txt); your customized content is used in addition to the default password dictionary. Matching is not case-sensitive. */ dictionaries?: string[]; /** * Indicates whether the password dictionary check is enabled for this connection. */ enable?: boolean; } export interface ConnectionOptionsPasswordHistory { enable?: boolean; size?: number; } export interface ConnectionOptionsPasswordNoPersonalInfo { enable?: boolean; } export interface ConnectionOptionsPasswordOptions { /** * Password complexity requirements. */ complexity: outputs.ConnectionOptionsPasswordOptionsComplexity; /** * Dictionary-based password validation. */ dictionary: outputs.ConnectionOptionsPasswordOptionsDictionary; /** * Password history enforcement. */ history: outputs.ConnectionOptionsPasswordOptionsHistory; /** * Personal information restriction policy. */ profileData: outputs.ConnectionOptionsPasswordOptionsProfileData; } export interface ConnectionOptionsPasswordOptionsComplexity { /** * When all 4 character types are specified, determines if all or 3 of 4 are required. Possible values: `all`, `threeOfFour`. Default: `all`. */ characterTypeRule: string; /** * Required character types. Valid values: `uppercase`, `lowercase`, `number`, `special`. */ characterTypes: string[]; /** * Controls whether 3+ consecutive identical characters are allowed. Possible values: `allow`, `block`. Default: `allow`. */ identicalCharacters: string; /** * Controls behavior when the password exceeds 72 bytes. Possible values: `truncate`, `error`. Default: `error`. */ maxLengthExceeded: string; /** * Minimum password length. Must be between 1 and 72. Default: 15. */ minLength: number; /** * Controls whether sequential characters (abc, 123, etc.) are allowed. Possible values: `allow`, `block`. Default: `allow`. */ sequentialCharacters: string; } export interface ConnectionOptionsPasswordOptionsDictionary { /** * Enables dictionary checking. */ active: boolean; /** * Custom list of disallowed terms. */ customs: string[]; /** * Default dictionary to use. Possible values: `en10k`, `en100k`. Default: `en100k`. */ default: string; } export interface ConnectionOptionsPasswordOptionsHistory { /** * Enables password history checking. */ active: boolean; /** * Number of previous passwords to check against. Must be between 1 and 24. Default: 3. */ size: number; } export interface ConnectionOptionsPasswordOptionsProfileData { /** * Prevents users from including profile data in passwords. */ active: boolean; /** * User profile fields to block from passwords. Maximum 12 items, each max 100 characters. */ blockedFields: string[]; } export interface ConnectionOptionsSigningKey { cert: string; key: string; } export interface ConnectionOptionsTotp { /** * Length of the one-time password. */ length?: number; /** * Seconds between allowed generation of new passwords. */ timeStep?: number; } export interface ConnectionOptionsValidation { /** * Specifies the `min` and `max` values of username length. */ username?: outputs.ConnectionOptionsValidationUsername; } export interface ConnectionOptionsValidationUsername { max?: number; min?: number; } export interface ConnectionProfileConnectionConfig { } export interface ConnectionProfileCrossAppAccessResourceApp { /** * The Cross App Access resource app status configuration. */ status: outputs.ConnectionProfileCrossAppAccessResourceAppStatus; } export interface ConnectionProfileCrossAppAccessResourceAppStatus { /** * Status values organizations are allowed to set. When specified, must contain both "enabled" and "disabled" — the API enforces a minimum of 2 unique values drawn from a 2-value enum, so any non-empty list must be the full pair. Omit entirely to leave it unrestricted. */ allowedValues?: string[]; /** * Default status value for organizations that don't have an explicit override. Either `enabled` or `disabled`. */ defaultValue: string; } export interface ConnectionProfileOrganization { /** * Whether to assign membership on login. */ assignMembershipOnLogin: string; /** * Whether to show organization as a button. */ showAsButton: string; } export interface ConnectionProfileStrategyOverrides { /** * Strategy override configuration. */ ad: outputs.ConnectionProfileStrategyOverridesAd; /** * Strategy override configuration. */ adfs: outputs.ConnectionProfileStrategyOverridesAdfs; /** * Strategy override configuration. */ googleApps: outputs.ConnectionProfileStrategyOverridesGoogleApps; /** * Strategy override configuration. */ oidc: outputs.ConnectionProfileStrategyOverridesOidc; /** * Strategy override configuration. */ okta: outputs.ConnectionProfileStrategyOverridesOkta; /** * Strategy override configuration. */ pingfederate: outputs.ConnectionProfileStrategyOverridesPingfederate; /** * Strategy override configuration. */ samlp: outputs.ConnectionProfileStrategyOverridesSamlp; /** * Strategy override configuration. */ waad: outputs.ConnectionProfileStrategyOverridesWaad; } export interface ConnectionProfileStrategyOverridesAd { /** * Connection config for the strategy override. */ connectionConfig: outputs.ConnectionProfileStrategyOverridesAdConnectionConfig; /** * Enabled features for the strategy override. */ enabledFeatures: string[]; } export interface ConnectionProfileStrategyOverridesAdConnectionConfig { } export interface ConnectionProfileStrategyOverridesAdfs { /** * Connection config for the strategy override. */ connectionConfig: outputs.ConnectionProfileStrategyOverridesAdfsConnectionConfig; /** * Enabled features for the strategy override. */ enabledFeatures: string[]; } export interface ConnectionProfileStrategyOverridesAdfsConnectionConfig { } export interface ConnectionProfileStrategyOverridesGoogleApps { /** * Connection config for the strategy override. */ connectionConfig: outputs.ConnectionProfileStrategyOverridesGoogleAppsConnectionConfig; /** * Enabled features for the strategy override. */ enabledFeatures: string[]; } export interface ConnectionProfileStrategyOverridesGoogleAppsConnectionConfig { } export interface ConnectionProfileStrategyOverridesOidc { /** * Connection config for the strategy override. */ connectionConfig: outputs.ConnectionProfileStrategyOverridesOidcConnectionConfig; /** * Enabled features for the strategy override. */ enabledFeatures: string[]; } export interface ConnectionProfileStrategyOverridesOidcConnectionConfig { } export interface ConnectionProfileStrategyOverridesOkta { /** * Connection config for the strategy override. */ connectionConfig: outputs.ConnectionProfileStrategyOverridesOktaConnectionConfig; /** * Enabled features for the strategy override. */ enabledFeatures: string[]; } export interface ConnectionProfileStrategyOverridesOktaConnectionConfig { } export interface ConnectionProfileStrategyOverridesPingfederate { /** * Connection config for the strategy override. */ connectionConfig: outputs.ConnectionProfileStrategyOverridesPingfederateConnectionConfig; /** * Enabled features for the strategy override. */ enabledFeatures: string[]; } export interface ConnectionProfileStrategyOverridesPingfederateConnectionConfig { } export interface ConnectionProfileStrategyOverridesSamlp { /** * Connection config for the strategy override. */ connectionConfig: outputs.ConnectionProfileStrategyOverridesSamlpConnectionConfig; /** * Enabled features for the strategy override. */ enabledFeatures: string[]; } export interface ConnectionProfileStrategyOverridesSamlpConnectionConfig { } export interface ConnectionProfileStrategyOverridesWaad { /** * Connection config for the strategy override. */ connectionConfig: outputs.ConnectionProfileStrategyOverridesWaadConnectionConfig; /** * Enabled features for the strategy override. */ enabledFeatures: string[]; } export interface ConnectionProfileStrategyOverridesWaadConnectionConfig { } export interface ConnectionScimConfigurationMapping { /** * The field location in the Auth0 schema. */ auth0: string; /** * The field location in the SCIM schema. */ scim: string; } export interface CustomDomainCertificate { /** * Name of the certificate authority that issued the certificate. */ certificateAuthority: string; /** * Contains the error message if the provisioning process fails. */ errorMsg: string; /** * Specifies the date by which the certificate should be renewed. */ renewsBefore: string; /** * Indicates the current state of the certificate provisioning process. */ status: string; } export interface CustomDomainVerification { /** * Contains error message, if any, from the last DNS verification check. */ errorMsg: string; /** * Indicates the last time the domain was successfully verified. */ lastVerifiedAt: string; /** * Defines the list of domain verification methods used. */ methods: any[]; /** * Represents the current status of the domain verification process. */ status: string; } export interface EmailProviderCredentials { /** * AWS Access Key ID. Used only for AWS. */ accessKeyId?: string; /** * API Key for your email service. Will always be encrypted in our database. */ apiKey?: string; /** * Azure Communication Services Connection String. */ azureCsConnectionString?: string; /** * Domain name. */ domain?: string; /** * Microsoft 365 Client ID. */ ms365ClientId?: string; /** * Microsoft 365 Client Secret. */ ms365ClientSecret?: string; /** * Microsoft 365 Tenant ID. */ ms365TenantId?: string; /** * Default region. Used only for AWS, Mailgun, and SparkPost. */ region?: string; /** * AWS Secret Key. Will always be encrypted in our database. Used only for AWS. */ secretAccessKey?: string; /** * Hostname or IP address of your SMTP server. Used only for SMTP. */ smtpHost?: string; /** * SMTP password. Used only for SMTP. */ smtpPass?: string; /** * 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. */ smtpPort?: number; /** * SMTP username. Used only for SMTP. */ smtpUser?: string; } export interface EmailProviderSettings { /** * Headers settings for the `smtp` email provider. */ headers?: outputs.EmailProviderSettingsHeaders; /** * Message settings for the `mandrill` or `ses` email provider. */ message?: outputs.EmailProviderSettingsMessage; } export interface EmailProviderSettingsHeaders { /** * Disable or enable the default View Content Link for sensitive emails. */ xMcViewContentLink?: string; /** * SES Configuration set to include when sending emails. */ xSesConfigurationSet?: string; } export interface EmailProviderSettingsMessage { /** * Setting for the `ses` email provider. The name of the configuration set to apply to the sent emails. */ configurationSetName?: string; /** * Setting for the `mandrill` email provider. Set to `true` to see the content of individual emails sent to users. */ viewContentLink?: boolean; } export interface EncryptionKeyManagerCustomerProvidedRootKey { /** * The ISO 8601 formatted date the customer provided root key was created. */ createdAt: string; /** * The key ID of the customer provided root key. */ keyId: string; /** * The key ID of the parent wrapping key. */ parentKeyId: string; /** * The public wrapping key in PEM format. */ publicWrappingKey: string; /** * The state of the encryption key. One of `pre-activation`, `active`, `deactivated`, or `destroyed`. */ state: string; /** * The type of the customer provided root key. Should be `customer-provided-root-key`. */ type: string; /** * The ISO 8601 formatted date the customer provided root key was updated. */ updatedAt: string; /** * The base64-encoded customer provided root key, wrapped using the `publicWrappingKey`. This can be removed after the wrapped key has been applied. */ wrappedKey?: string; /** * The algorithm that should be used to wrap the customer provided root key. Should be `CKM_RSA_AES_KEY_WRAP`. */ wrappingAlgorithm: string; } export interface EncryptionKeyManagerEncryptionKey { /** * The ISO 8601 formatted date the encryption key was created. */ createdAt: string; /** * The key ID of the encryption key. */ keyId: string; /** * The key ID of the parent wrapping key. */ parentKeyId: string; /** * The state of the encryption key. One of `pre-activation`, `active`, `deactivated`, or `destroyed`. */ state: string; /** * The type of the encryption key. One of `customer-provided-root-key`, `environment-root-key`, or `tenant-master-key`. */ type: string; /** * The ISO 8601 formatted date the encryption key was updated. */ updatedAt: string; } export interface EventStreamActionConfiguration { /** * The ID of the Auth0 Action to use as the event stream destination. */ actionId: string; } export interface EventStreamEventbridgeConfiguration { awsAccountId: string; awsPartnerEventSource: string; awsRegion: string; } export interface EventStreamWebhookConfiguration { /** * Authorization details for the webhook endpoint. Supports `basic` authentication using `username` and `password`, `bearer` authentication using a `token`, or `customHeader` authentication using `headerKey` and `headerValue` (or `headerValueWo`). The appropriate fields must be set based on the chosen method. */ webhookAuthorization: outputs.EventStreamWebhookConfigurationWebhookAuthorization; /** * The HTTPS endpoint that will receive the webhook events. Must be a valid, publicly accessible URL. */ webhookEndpoint: string; } export interface EventStreamWebhookConfigurationWebhookAuthorization { /** * The name of the HTTP header used for `customHeader` authentication. Required when `method` is `customHeader`. Returned by the API and stored in state. */ headerKey?: string; /** * The secret value sent in the custom header. Required when `method` is `customHeader` and `headerValueWo` is not provided. **Note:** For better security, use `headerValueWo` to prevent storing the secret in state. */ headerValue?: string; /** * **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. * The secret value sent in the custom header (write-only). Not stored in Terraform state. Bump `headerValueWoVersion` to rotate the secret. */ headerValueWo?: string; /** * Version number for secret rotation. Update to trigger a new `headerValueWo` to be sent. */ headerValueWoVersion?: number; /** * The authorization method used to secure the webhook endpoint. Can be `basic`, `bearer`, or `customHeader`. */ method: string; /** * The password for `basic` authentication. Required only when `method` is set to `basic`. **Note:** For better security, consider using `passwordWo` instead to prevent storing the password in Terraform state. */ password?: string; /** * **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. * The password for `basic` authentication (write-only). This value is only available during resource creation and update, and is **not** stored in Terraform state. To change the password, update the `passwordWoVersion` attribute. Required only when `method` is set to `basic` and `password` is not provided. */ passwordWo?: string; /** * Version number for password changes. Update this value to trigger a password change when using `passwordWo`. */ passwordWoVersion?: number; /** * The token used for `bearer` authentication. Required only when `method` is set to `bearer`. **Note:** For better security, consider using `tokenWo` instead to prevent storing the token in Terraform state. */ token?: string; /** * **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. * The token used for `bearer` authentication (write-only). This value is only available during resource creation and update, and is **not** stored in Terraform state. To change the token, update the `tokenWoVersion` attribute. Required only when `method` is set to `bearer` and `token` is not provided. */ tokenWo?: string; /** * Version number for token changes. Update this value to trigger a token change when using `tokenWo`. */ tokenWoVersion?: number; /** * The username for `basic` authentication. Required only when `method` is set to `basic`. */ username?: string; } export interface ExperimentAllocation { /** * Whether this allocation is the control variation. At most one allocation can be the control. */ isControl: boolean; /** * Whether this allocation is the fallback. Only for the segment strategy. */ isFallback: boolean; /** * The evaluation priority of this allocation. Only for the segment strategy. */ priority?: number; /** * The segment targeted by this allocation. Only for the segment strategy. Omit for the fallback allocation. */ segmentId?: string; /** * The name of the targeted segment. */ segmentName: string; /** * The snapshot of the segment. */ segmentSnapshot: string; /** * The ID of the feature flag variation assigned to this allocation. */ variationId: string; /** * The name of the assigned variation. */ variationName: string; /** * The snapshot of the variation. */ variationSnapshot: string; /** * The percentage weight of this allocation. Only for the percentage strategy. Omit when using levels. */ weight?: number; } export interface ExperimentFeatureFlagParameter { /** * Description of the parameter. */ description?: string; /** * The key of the parameter. */ name: string; /** * The value type of the parameter. One of boolean, string, number, array, object */ type: string; /** * The default value of the parameter, as a string. For `type = "object"` or `type = "array"` supply a JSON-encoded string; for `boolean`/`number` supply the literal value as a string. */ value: string; } export interface ExperimentFeatureFlagVariation { /** * Description of the variation. Must contain 3 to 1024 characters when set. */ description?: string; /** * The name of the variation. Must be unique within the feature flag and contain 3 to 255 characters without surrounding whitespace. Changing the name deletes the variation and creates a new one with a new ID. */ name: string; /** * Parameter overrides for the variation. Omit for a control variation. */ overrides?: outputs.ExperimentFeatureFlagVariationOverride[]; } export interface ExperimentFeatureFlagVariationOverride { /** * The name of a parameter on the feature flag. Each name can appear once. */ name: string; /** * The type of the parameter value. One of boolean, string, number, array, object. */ type: string; /** * The override value as a string. For object and array values, provide JSON; for boolean and number values, provide their literal text. */ value: string; } export interface ExperimentSegmentRule { /** * Attribute conditions that must match. Set between 1 and 10 attributes, including each `anonymousSessionMetadata` block. At least one of `match` or `notMatch` is required per rule. */ match?: outputs.ExperimentSegmentRuleMatch; /** * Attribute conditions that must not match. Set between 1 and 10 attributes, including each `anonymousSessionMetadata` block. At least one of `match` or `notMatch` is required per rule. */ notMatch?: outputs.ExperimentSegmentRuleNotMatch; } export interface ExperimentSegmentRuleMatch { /** * Condition on a namespaced `anonymous_session_metadata.` attribute. Repeat the block once per key. Each key can appear only once per `match/not_match` block. */ anonymousSessionMetadatas?: outputs.ExperimentSegmentRuleMatchAnonymousSessionMetadata[]; /** * Condition on the `browser` attribute. Set exactly one operator. */ browser?: outputs.ExperimentSegmentRuleMatchBrowser; /** * Condition on the `clientId` attribute. Set exactly one operator. */ clientId?: outputs.ExperimentSegmentRuleMatchClientId; /** * Condition on the `connection` attribute. Set exactly one operator. */ connection?: outputs.ExperimentSegmentRuleMatchConnection; /** * Condition on the `connectionType` attribute. Set exactly one operator. */ connectionType?: outputs.ExperimentSegmentRuleMatchConnectionType; /** * Condition on the `country` attribute. Set exactly one operator. */ country?: outputs.ExperimentSegmentRuleMatchCountry; /** * Condition on the `deviceType` attribute. Set exactly one operator. */ deviceType?: outputs.ExperimentSegmentRuleMatchDeviceType; /** * Condition on the `domain` attribute. Set exactly one operator. */ domain?: outputs.ExperimentSegmentRuleMatchDomain; /** * Condition on the `organizationId` attribute. Set exactly one operator. */ organizationId?: outputs.ExperimentSegmentRuleMatchOrganizationId; /** * Condition on the `platform` attribute. Set exactly one operator. */ platform?: outputs.ExperimentSegmentRuleMatchPlatform; /** * Condition on the `region` attribute. Set exactly one operator. */ region?: outputs.ExperimentSegmentRuleMatchRegion; /** * Condition on the `userAgent` attribute. Set exactly one operator. */ userAgent?: outputs.ExperimentSegmentRuleMatchUserAgent; } export interface ExperimentSegmentRuleMatchAnonymousSessionMetadata { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * The metadata key, without the `anonymous_session_metadata.` prefix. Between 1 and 255 characters, not blank. */ key: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleMatchBrowser { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleMatchClientId { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleMatchConnection { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleMatchConnectionType { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleMatchCountry { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleMatchDeviceType { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleMatchDomain { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleMatchOrganizationId { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleMatchPlatform { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleMatchRegion { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleMatchUserAgent { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleNotMatch { /** * Condition on a namespaced `anonymous_session_metadata.` attribute. Repeat the block once per key. Each key can appear only once per `match/not_match` block. */ anonymousSessionMetadatas?: outputs.ExperimentSegmentRuleNotMatchAnonymousSessionMetadata[]; /** * Condition on the `browser` attribute. Set exactly one operator. */ browser?: outputs.ExperimentSegmentRuleNotMatchBrowser; /** * Condition on the `clientId` attribute. Set exactly one operator. */ clientId?: outputs.ExperimentSegmentRuleNotMatchClientId; /** * Condition on the `connection` attribute. Set exactly one operator. */ connection?: outputs.ExperimentSegmentRuleNotMatchConnection; /** * Condition on the `connectionType` attribute. Set exactly one operator. */ connectionType?: outputs.ExperimentSegmentRuleNotMatchConnectionType; /** * Condition on the `country` attribute. Set exactly one operator. */ country?: outputs.ExperimentSegmentRuleNotMatchCountry; /** * Condition on the `deviceType` attribute. Set exactly one operator. */ deviceType?: outputs.ExperimentSegmentRuleNotMatchDeviceType; /** * Condition on the `domain` attribute. Set exactly one operator. */ domain?: outputs.ExperimentSegmentRuleNotMatchDomain; /** * Condition on the `organizationId` attribute. Set exactly one operator. */ organizationId?: outputs.ExperimentSegmentRuleNotMatchOrganizationId; /** * Condition on the `platform` attribute. Set exactly one operator. */ platform?: outputs.ExperimentSegmentRuleNotMatchPlatform; /** * Condition on the `region` attribute. Set exactly one operator. */ region?: outputs.ExperimentSegmentRuleNotMatchRegion; /** * Condition on the `userAgent` attribute. Set exactly one operator. */ userAgent?: outputs.ExperimentSegmentRuleNotMatchUserAgent; } export interface ExperimentSegmentRuleNotMatchAnonymousSessionMetadata { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * The metadata key, without the `anonymous_session_metadata.` prefix. Between 1 and 255 characters, not blank. */ key: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleNotMatchBrowser { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleNotMatchClientId { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleNotMatchConnection { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleNotMatchConnectionType { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleNotMatchCountry { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleNotMatchDeviceType { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleNotMatchDomain { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleNotMatchOrganizationId { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleNotMatchPlatform { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleNotMatchRegion { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface ExperimentSegmentRuleNotMatchUserAgent { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains?: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths?: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists?: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs?: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths?: string[]; } export interface FormLanguage { /** * Default language for the form. */ default?: string; /** * Primary language for the form. */ primary: string; } export interface FormMessage { /** * Custom message for the form. (JSON encoded) */ custom?: string; /** * Error message for the form. (JSON encoded) */ errors?: string; } export interface GetActionDependency { /** * Dependency name, e.g. `lodash`. */ name: string; /** * Dependency version, e.g. `latest` or `4.17.21`. */ version: string; } export interface GetActionModule { /** * The unique ID of the module. */ moduleId: string; /** * The name of the module. */ moduleName: string; /** * The ID of the specific module version to use. */ moduleVersionId: string; /** * The version number of the module. */ moduleVersionNumber: number; } export interface GetActionModuleActionsAction { /** * The ID of the action. */ actionId: string; /** * The name of the action. */ actionName: string; /** * The ID of the module version this action is using. */ moduleVersionId: string; /** * The version number of the module this action is using. */ moduleVersionNumber: number; /** * The triggers that this action supports. */ supportedTriggers: outputs.GetActionModuleActionsActionSupportedTrigger[]; } export interface GetActionModuleActionsActionSupportedTrigger { /** * The trigger ID. */ id: string; /** * The trigger version. */ version: string; } export interface GetActionModuleDependency { /** * Dependency name, e.g. `lodash`. */ name: string; /** * Dependency version, e.g. `latest` or `4.17.21`. */ version: string; } export interface GetActionModuleLatestVersion { /** * The source code of this version. */ code: string; /** * The time when this version was created. */ createdAt: string; /** * List of third party npm modules, and their versions, that this version depends on. */ dependencies: outputs.GetActionModuleLatestVersionDependency[]; /** * The unique identifier of the version. */ id: string; /** * List of secrets that are included in this version. */ secrets: outputs.GetActionModuleLatestVersionSecret[]; /** * The version number. */ versionNumber: number; } export interface GetActionModuleLatestVersionDependency { /** * Dependency name. */ name: string; /** * Dependency version. */ version: string; } export interface GetActionModuleLatestVersionSecret { /** * Secret name. */ name: string; /** * The time when this secret was last updated. */ updatedAt: string; } export interface GetActionModuleSecret { /** * Secret name. */ name: string; /** * Last update time */ updatedAt: string; /** * Secret value. */ value: string; } export interface GetActionModuleVersionDependency { /** * Dependency name. */ name: string; /** * Dependency version. */ version: string; } export interface GetActionModuleVersionSecret { /** * Secret name. */ name: string; /** * The time when this secret was last updated. */ updatedAt: string; } export interface GetActionModuleVersionsVersion { /** * The exact source code that was published with this version. */ code: string; /** * The timestamp when this version was created. */ createdAt: string; /** * Dependencies locked to this version. */ dependencies: outputs.GetActionModuleVersionsVersionDependency[]; /** * The unique identifier of the version. */ id: string; /** * The ID of the parent module. */ moduleId: string; /** * Secrets available to this version (name and updatedAt only, values never returned). */ secrets: outputs.GetActionModuleVersionsVersionSecret[]; /** * The sequential version number. */ versionNumber: number; } export interface GetActionModuleVersionsVersionDependency { /** * Dependency name. */ name: string; /** * Dependency version. */ version: string; } export interface GetActionModuleVersionsVersionSecret { /** * Secret name. */ name: string; /** * The time when this secret was last updated. */ updatedAt: string; } export interface GetActionSecret { /** * Secret name. */ name: string; /** * Secret value. */ value: string; } export interface GetActionSecretsWo { /** * Secret name. */ name: string; /** * Secret value (write-only). This value is never stored in Terraform state. */ value: string; } export interface GetActionSupportedTrigger { /** * The trigger ID. */ id: string; /** * The trigger version. This regulates which `runtime` versions are supported. */ version: string; } export interface GetAttackProtectionBotDetection { /** * List of IP addresses or ranges that will not trigger bot detection. */ allowlists: string[]; /** * Bot detection level. Possible values: `low`, `medium`, `high`. */ botDetectionLevel: string; /** * Challenge policy for password flow. Possible values: `never`, `whenRisky`, `always`. */ challengePasswordPolicy: string; /** * Challenge policy for password reset flow. Possible values: `never`, `whenRisky`, `always`. */ challengePasswordResetPolicy: string; /** * Challenge policy for passwordless flow. Possible values: `never`, `whenRisky`, `always`. */ challengePasswordlessPolicy: string; /** * Whether monitoring mode is enabled for bot detection. */ monitoringModeEnabled: boolean; } export interface GetAttackProtectionBreachedPasswordDetection { /** * When `adminNotification` is enabled within the `shields` property, determines how often email notifications are sent. Possible values: `immediately`, `daily`, `weekly`, `monthly`. */ adminNotificationFrequencies: string[]; /** * Whether breached password detection is active. */ enabled: boolean; /** * The subscription level for breached password detection methods. Use "enhanced" to enable Credential Guard. Possible values: `standard`, `enhanced`. */ method: string; /** * Configuration options that apply before every password change attempt. */ preChangePasswords: outputs.GetAttackProtectionBreachedPasswordDetectionPreChangePassword[]; /** * Configuration options that apply before every user registration attempt. Only available on public tenants. */ preUserRegistrations: outputs.GetAttackProtectionBreachedPasswordDetectionPreUserRegistration[]; /** * Action to take when a breached password is detected. Options include: `block` (block compromised user accounts), `userNotification` (send an email to user when we detect that they are using compromised credentials) and `adminNotification` (send an email with a summary of the number of accounts logging in with compromised credentials). */ shields: string[]; } export interface GetAttackProtectionBreachedPasswordDetectionPreChangePassword { /** * Action to take when a breached password is detected before the password is changed. Possible values: `block` (block compromised credentials for new accounts), `adminNotification` (send an email notification with a summary of compromised credentials in new accounts). */ shields: string[]; } export interface GetAttackProtectionBreachedPasswordDetectionPreUserRegistration { /** * Action to take when a breached password is detected during a signup. Possible values: `block` (block compromised credentials for new accounts), `adminNotification` (send an email notification with a summary of compromised credentials in new accounts). */ shields: string[]; } export interface GetAttackProtectionBruteForceProtection { /** * List of trusted IP addresses that will not have attack protection enforced against them. This field allows you to specify multiple IP addresses, or ranges. You can use IPv4 or IPv6 addresses and CIDR notation. */ allowlists: string[]; /** * Whether brute force attack protections are active. */ enabled: boolean; /** * Maximum number of consecutive failed login attempts from a single user before blocking is triggered. Only available on public tenants. */ maxAttempts: number; /** * Determines whether the IP address is used when counting failed attempts. Possible values: `countPerIdentifierAndIp` (lockout an account from a given IP Address) or `countPerIdentifier` (lockout an account regardless of IP Address). */ mode: string; /** * Action to take when a brute force protection threshold is violated. Possible values: `block` (block login attempts for a flagged user account), `userNotification` (send an email to user when their account has been blocked). */ shields: string[]; } export interface GetAttackProtectionCaptcha { /** * Active CAPTCHA provider ID. Set to empty string to disable CAPTCHA. Possible values: `recaptchaV2`, `recaptchaEnterprise`, `hcaptcha`, `friendlyCaptcha`, `arkose`, `authChallenge`, `simpleCaptcha`. */ activeProviderId: string; /** * Configuration for Arkose Labs. */ arkoses: outputs.GetAttackProtectionCaptchaArkose[]; /** * Configuration for Auth0's Auth Challenge. */ authChallenges: outputs.GetAttackProtectionCaptchaAuthChallenge[]; /** * Configuration for Friendly Captcha. */ friendlyCaptchas: outputs.GetAttackProtectionCaptchaFriendlyCaptcha[]; /** * Configuration for hCaptcha. */ hcaptchas: outputs.GetAttackProtectionCaptchaHcaptcha[]; /** * Configuration for Google reCAPTCHA Enterprise. */ recaptchaEnterprises: outputs.GetAttackProtectionCaptchaRecaptchaEnterprise[]; /** * Configuration for Google reCAPTCHA v2. */ recaptchaV2s: outputs.GetAttackProtectionCaptchaRecaptchaV2[]; } export interface GetAttackProtectionCaptchaArkose { /** * Client subdomain for Arkose Labs. */ clientSubdomain: string; /** * Whether the captcha should fail open. */ failOpen: boolean; /** * Secret for Arkose Labs. Required when configuring Arkose Labs. */ secret: string; /** * Site key for Arkose Labs. */ siteKey: string; /** * Verify subdomain for Arkose Labs. */ verifySubdomain: string; } export interface GetAttackProtectionCaptchaAuthChallenge { /** * Whether the auth challenge should fail open. */ failOpen: boolean; } export interface GetAttackProtectionCaptchaFriendlyCaptcha { /** * Secret for Friendly Captcha. Required when configuring Friendly Captcha. */ secret: string; /** * Site key for Friendly Captcha. */ siteKey: string; } export interface GetAttackProtectionCaptchaHcaptcha { /** * Secret for hCaptcha. Required when configuring hCaptcha. */ secret: string; /** * Site key for hCaptcha. */ siteKey: string; } export interface GetAttackProtectionCaptchaRecaptchaEnterprise { /** * API key for reCAPTCHA Enterprise. Required when configuring reCAPTCHA Enterprise. */ apiKey: string; /** * Project ID for reCAPTCHA Enterprise. */ projectId: string; /** * Site key for reCAPTCHA Enterprise. */ siteKey: string; } export interface GetAttackProtectionCaptchaRecaptchaV2 { /** * Secret for reCAPTCHA v2. Required when configuring reCAPTCHA v2. */ secret: string; /** * Site key for reCAPTCHA v2. */ siteKey: string; } export interface GetAttackProtectionPhoneProviderProtection { /** * The SMS backoff strategy used during MFA enrollment. Use `exponential` to activate exponential-backoff resend limiting (EA only). */ type: string; } export interface GetAttackProtectionSuspiciousIpThrottling { /** * List of trusted IP addresses that will not have attack protection enforced against them. This field allows you to specify multiple IP addresses, or ranges. You can use IPv4 or IPv6 addresses and CIDR notation. */ allowlists: string[]; /** * Whether suspicious IP throttling attack protections are active. */ enabled: boolean; /** * Configuration options that apply before every login attempt. Only available on public tenants. */ preLogins: outputs.GetAttackProtectionSuspiciousIpThrottlingPreLogin[]; /** * Configuration options that apply before every user registration attempt. Only available on public tenants. */ preUserRegistrations: outputs.GetAttackProtectionSuspiciousIpThrottlingPreUserRegistration[]; /** * Action to take when a suspicious IP throttling threshold is violated. Possible values: `block` (throttle traffic from an IP address when there is a high number of login attempts targeting too many different accounts), `adminNotification` (send an email notification when traffic is throttled on one or more IP addresses due to high-velocity traffic). */ shields: string[]; } export interface GetAttackProtectionSuspiciousIpThrottlingPreLogin { /** * The maximum number of failed login attempts allowed from a single IP address. */ maxAttempts: number; /** * Interval of time, given in milliseconds at which new login tokens will become available after they have been used by an IP address. Each login attempt will be added on the defined throttling rate. */ rate: number; } export interface GetAttackProtectionSuspiciousIpThrottlingPreUserRegistration { /** * The maximum number of sign up attempts allowed from a single IP address. */ maxAttempts: number; /** * Interval of time, given in milliseconds at which new sign up tokens will become available after they have been used by an IP address. Each sign up attempt will be added on the defined throttling rate. */ rate: number; } export interface GetBrandingColor { /** * Background color of login pages in hexadecimal. */ pageBackground: string; /** * Primary button background color in hexadecimal. */ primary: string; } export interface GetBrandingFont { /** * URL for the custom font. */ url: string; } export interface GetBrandingPhoneNotificationTemplateContent { /** * The body content of the phone notification template. */ bodies: outputs.GetBrandingPhoneNotificationTemplateContentBody[]; /** * The sender phone number for SMS or voice notifications. */ from: string; /** * The syntax of the phone notification template. */ syntax: string; } export interface GetBrandingPhoneNotificationTemplateContentBody { /** * The text content for SMS notifications. */ text: string; /** * The voice content for voice notifications. */ voice: string; } export interface GetBrandingThemeBorder { /** * Button border radius. Value needs to be between `1` and `10`. Defaults to `3.0`. */ buttonBorderRadius: number; /** * Button border weight. Value needs to be between `0` and `10`. Defaults to `1.0`. */ buttonBorderWeight: number; /** * Buttons style. Available options: `pill`, `rounded`, `sharp`. Defaults to `rounded`. */ buttonsStyle: string; /** * Input border radius. Value needs to be between `0` and `10`. Defaults to `3.0`. */ inputBorderRadius: number; /** * Input border weight. Value needs to be between `0` and `3`. Defaults to `1.0`. */ inputBorderWeight: number; /** * Inputs style. Available options: `pill`, `rounded`, `sharp`. Defaults to `rounded`. */ inputsStyle: string; /** * Show widget shadow. Defaults to `true`. */ showWidgetShadow: boolean; /** * Widget border weight. Value needs to be between `0` and `10`. Defaults to `0.0`. */ widgetBorderWeight: number; /** * Widget corner radius. Value needs to be between `0` and `50`. Defaults to `5.0`. */ widgetCornerRadius: number; } export interface GetBrandingThemeColor { /** * Base focus color. Defaults to `#635dff`. */ baseFocusColor: string; /** * Base hover color. Defaults to `#000000`. */ baseHoverColor: string; /** * Body text. Defaults to `#1e212a`. */ bodyText: string; /** * Captcha Widget Theme. */ captchaWidgetTheme: string; /** * Error. Defaults to `#d03c38`. */ error: string; /** * Header. Defaults to `#1e212a`. */ header: string; /** * Icons. Defaults to `#65676e`. */ icons: string; /** * Input background. Defaults to `#ffffff`. */ inputBackground: string; /** * Input border. Defaults to `#c9cace`. */ inputBorder: string; /** * Input filled text. Defaults to `#000000`. */ inputFilledText: string; /** * Input labels & placeholders. Defaults to `#65676e`. */ inputLabelsPlaceholders: string; /** * Links & focused components. Defaults to `#635dff`. */ linksFocusedComponents: string; /** * Primary button. Defaults to `#635dff`. */ primaryButton: string; /** * Primary button label. Defaults to `#ffffff`. */ primaryButtonLabel: string; /** * Read only background. */ readOnlyBackground: string; /** * Secondary button border. Defaults to `#c9cace`. */ secondaryButtonBorder: string; /** * Secondary button label. Defaults to `#1e212a`. */ secondaryButtonLabel: string; /** * Success. Defaults to `#13a688`. */ success: string; /** * Widget background. Defaults to `#ffffff`. */ widgetBackground: string; /** * Widget border. Defaults to `#c9cace`. */ widgetBorder: string; } export interface GetBrandingThemeFont { /** * Body text. */ bodyTexts: outputs.GetBrandingThemeFontBodyText[]; /** * Buttons text. */ buttonsTexts: outputs.GetBrandingThemeFontButtonsText[]; /** * Font URL. Defaults to an empty string. */ fontUrl: string; /** * Input labels. */ inputLabels: outputs.GetBrandingThemeFontInputLabel[]; /** * Links. */ links: outputs.GetBrandingThemeFontLink[]; /** * Links style. Defaults to `normal`. */ linksStyle: string; /** * Reference text size. Value needs to be between `12` and `24`. Defaults to `16.0`. */ referenceTextSize: number; /** * Subtitle. */ subtitles: outputs.GetBrandingThemeFontSubtitle[]; /** * Title. */ titles: outputs.GetBrandingThemeFontTitle[]; } export interface GetBrandingThemeFontBodyText { /** * Body text bold. Defaults to `false`. */ bold: boolean; /** * Body text size. Value needs to be between `0` and `150`. Defaults to `87.5`. */ size: number; } export interface GetBrandingThemeFontButtonsText { /** * Buttons text bold. Defaults to `false`. */ bold: boolean; /** * Buttons text size. Value needs to be between `0` and `150`. Defaults to `100.0`. */ size: number; } export interface GetBrandingThemeFontInputLabel { /** * Input labels bold. Defaults to `false`. */ bold: boolean; /** * Input labels size. Value needs to be between `0` and `150`. Defaults to `100.0`. */ size: number; } export interface GetBrandingThemeFontLink { /** * Links bold. Defaults to `true`. */ bold: boolean; /** * Links size. Value needs to be between `0` and `150`. Defaults to `87.5`. */ size: number; } export interface GetBrandingThemeFontSubtitle { /** * Subtitle bold. Defaults to `false`. */ bold: boolean; /** * Subtitle size. Value needs to be between `0` and `150`. Defaults to `87.5`. */ size: number; } export interface GetBrandingThemeFontTitle { /** * Title bold. Defaults to `false`. */ bold: boolean; /** * Title size. Value needs to be between `75` and `150`. Defaults to `150.0`. */ size: number; } export interface GetBrandingThemeIdentifier { /** * Login display style. Available options: `unified`, `separate`. */ loginDisplay: string; /** * Whether OTP autocomplete is enabled. */ otpAutocomplete: boolean; /** * Phone number display settings. */ phoneDisplays: outputs.GetBrandingThemeIdentifierPhoneDisplay[]; } export interface GetBrandingThemeIdentifierPhoneDisplay { /** * Phone number formatting. Available options: `international`, `regional`. */ formatting: string; /** * Phone number masking. Available options: `maskDigits`, `hideCountryCode`, `showAll`. */ masking: string; } export interface GetBrandingThemePageBackground { /** * Background color. Defaults to `#000000`. */ backgroundColor: string; /** * Background image url. Defaults to an empty string. */ backgroundImageUrl: string; /** * Page layout. Available options: `center`, `left`, `right`. Defaults to `center`. */ pageLayout: string; } export interface GetBrandingThemeWidget { /** * Header text alignment. Available options: `center`, `left`, `right`. Defaults to `center`. */ headerTextAlignment: string; /** * Logo height. Value needs to be between `1` and `100`. Defaults to `52.0`. */ logoHeight: number; /** * Logo position. Available options: `center`, `left`, `right`, `none`. Defaults to `center`. */ logoPosition: string; /** * Logo url. Defaults to an empty string. */ logoUrl: string; /** * Social buttons layout. Available options: `bottom`, `top`. Defaults to `bottom`. */ socialButtonsLayout: string; } export interface GetBrandingUniversalLogin { /** * The html template for the New Universal Login Experience. */ body: string; } export interface GetClientAddon { /** * AWS Addon configuration. */ aws: outputs.GetClientAddonAw[]; /** * Azure Blob Storage Addon configuration. */ azureBlobs: outputs.GetClientAddonAzureBlob[]; /** * Azure Storage Bus Addon configuration. */ azureSbs: outputs.GetClientAddonAzureSb[]; /** * Box SSO indicator (no configuration settings needed for Box SSO). */ boxes: outputs.GetClientAddonBox[]; /** * CloudBees SSO indicator (no configuration settings needed for CloudBees SSO). */ cloudbees: outputs.GetClientAddonCloudbee[]; /** * Concur SSO indicator (no configuration settings needed for Concur SSO). */ concurs: outputs.GetClientAddonConcur[]; /** * Dropbox SSO indicator (no configuration settings needed for Dropbox SSO). */ dropboxes: outputs.GetClientAddonDropbox[]; /** * Adobe EchoSign SSO configuration. */ echosigns: outputs.GetClientAddonEchosign[]; /** * Egnyte SSO configuration. */ egnytes: outputs.GetClientAddonEgnyte[]; /** * Google Firebase addon configuration. */ firebases: outputs.GetClientAddonFirebase[]; /** * Layer addon configuration. */ layers: outputs.GetClientAddonLayer[]; /** * Microsoft Dynamics CRM SSO configuration. */ mscrms: outputs.GetClientAddonMscrm[]; /** * New Relic SSO configuration. */ newrelics: outputs.GetClientAddonNewrelic[]; /** * Microsoft Office 365 SSO configuration. */ office365s: outputs.GetClientAddonOffice365[]; /** * Active Directory Rights Management Service SSO configuration. */ rms: outputs.GetClientAddonRm[]; /** * Salesforce API addon configuration. */ salesforceApis: outputs.GetClientAddonSalesforceApi[]; /** * Salesforce Sandbox addon configuration. */ salesforceSandboxApis: outputs.GetClientAddonSalesforceSandboxApi[]; /** * Salesforce SSO configuration. */ salesforces: outputs.GetClientAddonSalesforce[]; /** * Configuration settings for a SAML add-on. */ samlps: outputs.GetClientAddonSamlp[]; /** * SAP API addon configuration. */ sapApis: outputs.GetClientAddonSapApi[]; /** * Sentry SSO configuration. */ sentries: outputs.GetClientAddonSentry[]; /** * SharePoint SSO configuration. */ sharepoints: outputs.GetClientAddonSharepoint[]; /** * Slack team or workspace name usually first segment in your Slack URL, for example `https://acme-org.slack.com` would be `acme-org`. */ slacks: outputs.GetClientAddonSlack[]; /** * SpringCM SSO configuration. */ springcms: outputs.GetClientAddonSpringcm[]; /** * Generic SSO configuration. */ ssoIntegrations: outputs.GetClientAddonSsoIntegration[]; /** * Windows Azure Mobile Services addon configuration. */ wams: outputs.GetClientAddonWam[]; /** * WS-Fed (WIF) addon indicator. Actual configuration is stored in `callback` and `clientAliases` properties on the client. */ wsfeds: outputs.GetClientAddonWsfed[]; /** * Zendesk SSO configuration. */ zendesks: outputs.GetClientAddonZendesk[]; /** * Zoom SSO configuration. */ zooms: outputs.GetClientAddonZoom[]; } export interface GetClientAddonAw { /** * AWS token lifetime in seconds. */ lifetimeInSeconds: number; /** * AWS principal ARN, for example `arn:aws:iam::010616021751:saml-provider/idpname`. */ principal: string; /** * AWS role ARN, for example `arn:aws:iam::010616021751:role/foo`. */ role: string; } export interface GetClientAddonAzureBlob { /** * Your Azure storage account name. Usually first segment in your Azure storage URL, for example `https://acme-org.blob.core.windows.net` would be the account name `acme-org`. */ accountName: string; /** * Indicates if the issued token has permission to delete the blob. */ blobDelete: boolean; /** * Entity to request a token for, such as `my-blob`. If blank the computed SAS will apply to the entire storage container. */ blobName: string; /** * Indicates if the issued token has permission to read the content, properties, metadata and block list. Use the blob as the source of a copy operation. */ blobRead: boolean; /** * Indicates if the issued token has permission to create or write content, properties, metadata, or block list. Snapshot or lease the blob. Resize the blob (page blob only). Use the blob as the destination of a copy operation within the same account. */ blobWrite: boolean; /** * Indicates if issued token has permission to delete any blob in the container. */ containerDelete: boolean; /** * Indicates if the issued token has permission to list blobs in the container. */ containerList: boolean; /** * Container to request a token for, such as `my-container`. */ containerName: string; /** * Indicates if the issued token has permission to read the content, properties, metadata or block list of any blob in the container. Use any blob in the container as the source of a copy operation. */ containerRead: boolean; /** * Indicates that for any blob in the container if the issued token has permission to create or write content, properties, metadata, or block list. Snapshot or lease the blob. Resize the blob (page blob only). Use the blob as the destination of a copy operation within the same account. */ containerWrite: boolean; /** * Expiration in minutes for the generated token (default of 5 minutes). */ expiration: number; /** * Shared access policy identifier defined in your storage account resource. */ signedIdentifier: string; /** * Access key associated with this storage account. */ storageAccessKey: string; } export interface GetClientAddonAzureSb { /** * Entity you want to request a token for, such as `my-queue`. */ entityPath: string; /** * Optional expiration in minutes for the generated token. Defaults to 5 minutes. */ expiration: number; /** * Your Azure Service Bus namespace. Usually the first segment of your Service Bus URL (for example `https://acme-org.servicebus.windows.net` would be `acme-org`). */ namespace: string; /** * Primary Key associated with your shared access policy. */ sasKey: string; /** * Your shared access policy name defined in your Service Bus entity. */ sasKeyName: string; } export interface GetClientAddonBox { } export interface GetClientAddonCloudbee { } export interface GetClientAddonConcur { } export interface GetClientAddonDropbox { } export interface GetClientAddonEchosign { /** * Your custom domain found in your EchoSign URL, for example `https://acme-org.echosign.com` would be `acme-org`. */ domain: string; } export interface GetClientAddonEgnyte { /** * Your custom domain found in your Egnyte URL, for example `https://acme-org.echosign.com` would be `acme-org`. */ domain: string; } export interface GetClientAddonFirebase { /** * ID of the Service Account you have created (shown as `clientEmail` in the generated JSON file, SDK v3+ tokens only). */ clientEmail: string; /** * Optional expiration in seconds for the generated token. Defaults to 3600 seconds (SDK v3+ tokens only). */ lifetimeInSeconds: number; /** * Private Key for signing the token (SDK v3+ tokens only). */ privateKey: string; /** * Optional ID of the private key to obtain the `kid` header claim from the issued token (SDK v3+ tokens only). */ privateKeyId: string; /** * Google Firebase Secret. (SDK v2 only). */ secret: string; } export interface GetClientAddonLayer { /** * Optional expiration in minutes for the generated token. Defaults to 5 minutes. */ expiration: number; /** * Authentication Key identifier used to sign the Layer token. */ keyId: string; /** * Name of the property used as the unique user ID in Layer. If not specified `userId` is used. */ principal: string; /** * Private key for signing the Layer token. */ privateKey: string; /** * Provider ID of your Layer account. */ providerId: string; } export interface GetClientAddonMscrm { /** * Microsoft Dynamics CRM application URL. */ url: string; } export interface GetClientAddonNewrelic { /** * Your New Relic Account ID found in your New Relic URL after the `/accounts/` path, for example `https://rpm.newrelic.com/accounts/123456/query` would be `123456`. */ account: string; } export interface GetClientAddonOffice365 { /** * Optional Auth0 database connection for testing an already-configured Office 365 tenant. */ connection: string; /** * Your Office 365 domain name, for example `acme-org.com`. */ domain: string; } export interface GetClientAddonRm { /** * URL of your Rights Management Server. It can be internal or external, but users will have to be able to reach it. */ url: string; } export interface GetClientAddonSalesforce { /** * Arbitrary logical URL that identifies the Saleforce resource, for example `https://acme-org.com`. */ entityId: string; } export interface GetClientAddonSalesforceApi { /** * Consumer Key assigned by Salesforce to the Connected App. */ clientId: string; /** * Community name. */ communityName: string; /** * Community URL section. */ communityUrlSection: string; /** * Name of the property in the user object that maps to a Salesforce username, for example `email`. */ principal: string; } export interface GetClientAddonSalesforceSandboxApi { /** * Consumer Key assigned by Salesforce to the Connected App. */ clientId: string; /** * Community name. */ communityName: string; /** * Community URL section. */ communityUrlSection: string; /** * Name of the property in the user object that maps to a Salesforce username, for example `email`. */ principal: string; } export interface GetClientAddonSamlp { /** * Audience of the SAML Assertion. Default will be the Issuer on SAMLRequest. */ audience: string; /** * Class reference of the authentication context. */ authnContextClassRef: string; /** * Protocol binding used for SAML logout responses. */ binding: string; /** * Indicates whether a UPN claim should be created. */ createUpnClaim: boolean; /** * Destination of the SAML Response. If not specified, it will be `AssertionConsumerUrl` of SAMLRequest or callback URL if there was no SAMLRequest. */ destination: string; /** * Algorithm used to calculate the digest of the SAML Assertion or response. Options include `sha1` and `sha256`. */ digestAlgorithm: string; /** * This is a supporting attribute to `mappings` field.Please note this is an experimental field. It should only be used when needed to send a map with keys as slices. */ flexibleMappings: string; /** * 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. */ includeAttributeNameFormat: boolean; /** * Issuer of the SAML Assertion. */ issuer: string; /** * Number of seconds during which the token is valid. */ lifetimeInSeconds: number; /** * Configuration settings for logout. */ logouts: outputs.GetClientAddonSamlpLogout[]; /** * Indicates whether or not to add additional identity information in the token, such as the provider used and the `accessToken`, if available. */ mapIdentities: boolean; /** * Indicates whether 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. */ mapUnknownClaimsAsIs: boolean; /** * Mappings between the Auth0 user profile property name (`name`) and the output attributes on the SAML attribute in the assertion (`value`). */ mappings: { [key: string]: string; }; /** * Format of the name identifier. */ nameIdentifierFormat: 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. */ nameIdentifierProbes: string[]; /** * Indicates whether or not to passthrough claims that are not mapped to the common profile in the output assertion. */ passthroughClaimsWithNoMapping: boolean; /** * Recipient of the SAML Assertion (SubjectConfirmationData). Default is `AssertionConsumerUrl` on SAMLRequest or callback URL if no SAMLRequest was sent. */ recipient: string; /** * Indicates whether or not the SAML Response should be signed instead of the SAML Assertion. */ signResponse: boolean; /** * Algorithm used to sign the SAML Assertion or response. Options include `rsa-sha1` and `rsa-sha256`. */ signatureAlgorithm: string; /** * Optionally indicates the public key certificate used to validate SAML requests. If set, SAML requests will be required to be signed. A sample value would be `-----BEGIN PUBLIC KEY-----\nMIGf...bpP/t3\n+JGNGIRMj1hF1rnb6QIDAQAB\n-----END PUBLIC KEY-----\n`. */ signingCert: string; /** * 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`. */ typedAttributes: boolean; } export interface GetClientAddonSamlpLogout { /** * The service provider (client application)'s Single Logout Service URL, where Auth0 will send logout requests and responses. */ callback: string; /** * Controls whether Auth0 should notify service providers of session termination. */ sloEnabled: boolean; } export interface GetClientAddonSapApi { /** * If activated in the OAuth 2.0 client configuration (transaction ` SOAUTH2) the SAML attribute `clientId`must be set and equal the`clientId` form parameter of the access token request. */ clientId: string; /** * NameID element of the Subject which can be used to express the user's identity. Defaults to `urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified`. */ nameIdentifierFormat: string; /** * Requested scope for SAP APIs. */ scope: string; /** * Service account password to use to authenticate API calls to the token endpoint. */ servicePassword: string; /** * The OAuth2 token endpoint URL of your SAP OData server. */ tokenEndpointUrl: string; /** * Name of the property in the user object that maps to a SAP username, for example `email`. */ usernameAttribute: string; } export interface GetClientAddonSentry { /** * URL prefix only if running Sentry Community Edition, otherwise leave empty. */ baseUrl: string; /** * Generated slug for your Sentry organization. Found in your Sentry URL, for example `https://sentry.acme.com/acme-org/` would be `acme-org`. */ orgSlug: string; } export interface GetClientAddonSharepoint { /** * External SharePoint application URLs if exposed to the Internet. */ externalUrls: string[]; /** * Internal SharePoint application URL. */ url: string; } export interface GetClientAddonSlack { /** * Slack team name. */ team: string; } export interface GetClientAddonSpringcm { /** * SpringCM ACS URL, for example `https://na11.springcm.com/atlas/sso/SSOEndpoint.ashx`. */ acsUrl: string; } export interface GetClientAddonSsoIntegration { /** * SSO integration name. */ name: string; /** * SSO integration version installed. */ version: string; } export interface GetClientAddonWam { /** * Your master key for Windows Azure Mobile Services. */ masterKey: string; } export interface GetClientAddonWsfed { } export interface GetClientAddonZendesk { /** * Zendesk account name. Usually the first segment in your Zendesk URL, for example `https://acme-org.zendesk.com` would be `acme-org`. */ accountName: string; } export interface GetClientAddonZoom { /** * Zoom account name. Usually the first segment of your Zoom URL, for example `https://acme-org.zoom.us` would be `acme-org`. */ account: string; } export interface GetClientAnonymousSession { /** * If set to true, this client is allowed to create anonymous sessions. Requires `oidcConformant` to be set to `true`. Set to `false` to disable. (EA only) */ active: boolean; } export interface GetClientB2bIntegrationConfiguration { /** * The type of integration used to connect to this B2B integration client. One of custom_auth_server, third_party, application */ integrationType: string; /** * ID of the self-service SSO profile (an `auth0.SelfServiceProfile` id, in `ssp_...` format) linked to this B2B integration client. Maximum 1. */ ssoProfiles: string[]; } export interface GetClientClientAuthenticationMethod { /** * If this is defined, the client is enabled to use the Private Key JWT authentication method. */ privateKeyJwts: outputs.GetClientClientAuthenticationMethodPrivateKeyJwt[]; /** * If this is defined, the client is enabled to use the mTLS authentication method utilizing a self-signed certificate. */ selfSignedTlsClientAuths: outputs.GetClientClientAuthenticationMethodSelfSignedTlsClientAuth[]; /** * If this is defined, the client is enabled to use the CA-based mTLS authentication method. */ tlsClientAuths: outputs.GetClientClientAuthenticationMethodTlsClientAuth[]; } export interface GetClientClientAuthenticationMethodPrivateKeyJwt { /** * Credentials that will be enabled on the client for Private Key JWT authentication. */ credentials: outputs.GetClientClientAuthenticationMethodPrivateKeyJwtCredential[]; } export interface GetClientClientAuthenticationMethodPrivateKeyJwtCredential { /** * Algorithm which will be used with the credential. Can be one of `RS256`, `RS384`, `PS256`. If not specified, `RS256` will be used. */ algorithm: string; /** * The ISO 8601 formatted date the credential was created. */ createdAt: string; /** * Credential type. Supported types: `publicKey`. */ credentialType: string; /** * The ISO 8601 formatted date representing the expiration of the credential. */ expiresAt: string; /** * The ID of the client credential. */ id: string; /** * The key identifier of the credential, generated on creation. */ keyId: string; /** * Friendly name for a credential. */ name: string; /** * The ISO 8601 formatted date the credential was updated. */ updatedAt: string; } export interface GetClientClientAuthenticationMethodSelfSignedTlsClientAuth { /** * Credentials that will be enabled on the client for mTLS authentication utilizing self-signed certificates. */ credentials: outputs.GetClientClientAuthenticationMethodSelfSignedTlsClientAuthCredential[]; } export interface GetClientClientAuthenticationMethodSelfSignedTlsClientAuthCredential { /** * The ISO 8601 formatted date the credential was created. */ createdAt: string; /** * Credential type. Supported types: `x509Cert`. */ credentialType: string; /** * The ID of the client credential. */ id: string; /** * Friendly name for a credential. */ name: string; /** * The ISO 8601 formatted date the credential was updated. */ updatedAt: string; } export interface GetClientClientAuthenticationMethodTlsClientAuth { /** * Credentials that will be enabled on the client for CA-based mTLS authentication. */ credentials: outputs.GetClientClientAuthenticationMethodTlsClientAuthCredential[]; } export interface GetClientClientAuthenticationMethodTlsClientAuthCredential { /** * The ISO 8601 formatted date the credential was created. */ createdAt: string; /** * Credential type. Supported types: `certSubjectDn`. */ credentialType: string; /** * The ID of the client credential. */ id: string; /** * Friendly name for a credential. */ name: string; /** * Subject Distinguished Name. Mutually exlusive with `pem` property. */ subjectDn: string; /** * The ISO 8601 formatted date the credential was updated. */ updatedAt: string; } export interface GetClientDefaultOrganization { /** * If set, the `defaultOrganization` will be removed. */ disable: boolean; /** * Definition of the flow that needs to be configured. Eg. client_credentials */ flows: string[]; /** * The unique identifier of the organization */ organizationId: string; } export interface GetClientExpressConfiguration { /** * The domain that admins are expected to log in via for authenticating for express configuration. */ adminLoginDomain: string; /** * The ID of the connection profile to use for this application. */ connectionProfileId: string; /** * When true, all connections made via express configuration will be enabled for this application. */ enableClient: boolean; /** * When true, all connections made via express configuration will have the associated organization enabled. */ enableOrganization: boolean; /** * The URI users should bookmark to log in to this application. Variable substitution is permitted for: organization_name, organization_id, and connection_name. */ initiateLoginUriTemplate: string; /** * List of client IDs that are linked to this express configuration (e.g. web or mobile clients). */ linkedClients: outputs.GetClientExpressConfigurationLinkedClient[]; /** * The identifier of the published application in the OKTA OIN. */ oinSubmissionId: string; /** * The unique identifier for the Okta OIN Express Configuration Client. */ oktaOinClientId: string; /** * The ID of the user attribute profile to use for this application. */ userAttributeProfileId: string; } export interface GetClientExpressConfigurationLinkedClient { /** * The ID of the linked client. */ clientId: string; } export interface GetClientFedcmLogin { /** * Google FedCM configuration. (EA only) */ googles: outputs.GetClientFedcmLoginGoogle[]; } export interface GetClientFedcmLoginGoogle { /** * Whether to show the Google FedCM prompt on Login. (EA only) */ isEnabled: boolean; } export interface GetClientGrantOrganizationsOrganization { /** * How to style the login pages for this organization. */ brandings: outputs.GetClientGrantOrganizationsOrganizationBranding[]; /** * Friendly name of the organization. */ displayName: string; /** * Whether this organization's app entitlement is active (EA only). */ isAppEntitlementActive: boolean; /** * Metadata associated with the organization. */ metadata: { [key: string]: string; }; /** * The name of the organization. */ name: string; /** * The ID of the organization. */ organizationId: string; /** * Controls whether this organization can be used in user flows with third-party clients. Available values are `allow` or `block`. */ thirdPartyClientAccess: string; /** * The token quota configuration for this organization. */ tokenQuotas: outputs.GetClientGrantOrganizationsOrganizationTokenQuota[]; } export interface GetClientGrantOrganizationsOrganizationBranding { /** * Color scheme used to customize the login pages. */ colors: { [key: string]: string; }; /** * URL of logo to display on login page. */ logoUrl: string; } export interface GetClientGrantOrganizationsOrganizationTokenQuota { /** * The token quota configuration for client credentials. */ clientCredentials: outputs.GetClientGrantOrganizationsOrganizationTokenQuotaClientCredential[]; } export interface GetClientGrantOrganizationsOrganizationTokenQuotaClientCredential { /** * Whether the quota is enforced. */ enforce: boolean; /** * Maximum number of issued tokens per day. */ perDay: number; /** * Maximum number of issued tokens per hour. */ perHour: number; } export interface GetClientGrantsClientGrant { /** * When enabled, all scopes configured on the resource server are allowed for this client grant. EA Only. */ allowAllScopes: boolean; /** * The audience of the client grant. */ audience: string; /** * The client ID associated with the grant. */ clientId: string; /** * Indicates this grant is the default for a category of clients. */ defaultFor: string; /** * The ID of the client grant. */ id: string; /** * List of granted scopes. */ scopes: string[]; /** * The subject type (usually 'client'). */ subjectType: string; } export interface GetClientIdentityAssertionAuthorizationGrant { /** * Whether the client can exchange ID-JAGs for access tokens. (EA only) */ active: boolean; } export interface GetClientJwtConfiguration { /** * Algorithm used to sign JWTs. Can be one of `HS256`, `RS256`, `PS256`. */ alg: string; /** * Number of seconds during which the JWT will be valid. */ lifetimeInSeconds: number; /** * Permissions (scopes) included in JWTs. */ scopes: { [key: string]: string; }; /** * Indicates whether the client secret is Base64-encoded. */ secretEncoded: boolean; } export interface GetClientMobile { /** * Configuration settings for Android native apps. */ androids: outputs.GetClientMobileAndroid[]; /** * Configuration settings for i0S native apps. */ ios: outputs.GetClientMobileIo[]; } export interface GetClientMobileAndroid { appPackageName: string; sha256CertFingerprints: string[]; } export interface GetClientMobileIo { appBundleIdentifier: string; teamId: string; } export interface GetClientMyOrganizationConfiguration { /** * The list of connection strategies that are allowed when creating organizations for this client (e.g. "okta", "samlp"). */ allowedStrategies: string[]; /** * Controls the behavior when deleting connections associated with organizations for this client. Possible values: `allow`, `allowIfEmpty`. */ connectionDeletionBehavior: string; /** * The ID of the connection profile to use when creating organizations for this client. */ connectionProfileId: string; /** * When true, limits the permissions that organization admins can assign to members to only those held by the admin themselves. Requires the `myOrgMemberManagementEa` feature flag. Available in Early Access (EA). */ enforcePermissionCeiling: boolean; /** * When true, prevents organization admins from assigning permissions to themselves. Requires the `myOrgMemberManagementEa` feature flag. Available in Early Access (EA). */ enforceSelfAssignmentRestriction: boolean; /** * The client ID used as the invitation landing page when creating invitations through the My Organization API. Requires the tenant to have member management enabled, and the referenced client must allow organizations. */ invitationLandingClientId: string; /** * Configures third-party client access to organizations created for this client through the My Organization API. Requires the `myOrgsThirdPartyClientSupport` (EA Only) */ thirdPartyClientAccesses: outputs.GetClientMyOrganizationConfigurationThirdPartyClientAccess[]; /** * The ID of the user attribute profile to use when creating organizations for this client. */ userAttributeProfileId: string; } export interface GetClientMyOrganizationConfigurationThirdPartyClientAccess { /** * The third-party client access values that can be set on organizations created for this client through the My Organization API. Required whenever this block is set — the API rejects the block without it. Possible values: `allow`, `block`. Unlike `auth0.ConnectionProfile`'s `crossAppAccessResourceApp`, a single value is accepted here. (EA Only) */ allowedValues: string[]; /** * The default third-party client access value applied to organizations created for this client. The API currently only accepts "block"; "allow" is rejected with a 400 error, so this is exposed as computed-only rather than user-settable. (EA Only) */ defaultValue: string; } export interface GetClientNativeSocialLogin { apples: outputs.GetClientNativeSocialLoginApple[]; facebooks: outputs.GetClientNativeSocialLoginFacebook[]; googles: outputs.GetClientNativeSocialLoginGoogle[]; } export interface GetClientNativeSocialLoginApple { enabled: boolean; } export interface GetClientNativeSocialLoginFacebook { enabled: boolean; } export interface GetClientNativeSocialLoginGoogle { enabled: boolean; } export interface GetClientOidcLogout { /** * Configure OIDC logout initiators for the Client */ backchannelLogoutInitiators: outputs.GetClientOidcLogoutBackchannelLogoutInitiator[]; /** * Controls whether session metadata is included in the logout token. Default value is null. */ backchannelLogoutSessionMetadatas: outputs.GetClientOidcLogoutBackchannelLogoutSessionMetadata[]; /** * Set of URLs that are valid to call back from Auth0 for OIDC backchannel logout. Currently only one URL is allowed. */ backchannelLogoutUrls: string[]; } export interface GetClientOidcLogoutBackchannelLogoutInitiator { /** * Determines the configuration method for enabling initiators. `custom` enables only the initiators listed in the backchannelLogoutSelectedInitiators set, `all` enables all current and future initiators. */ mode: string; /** * Contains the list of initiators to be enabled for the given client. */ selectedInitiators: string[]; } export interface GetClientOidcLogoutBackchannelLogoutSessionMetadata { /** * The `include` property determines whether session metadata is included in the logout token. */ include: boolean; } export interface GetClientProfileApplyPolicy { /** * The creator of the clients to match. Defaults to `client`, which means the client was registered dynamically. Possible values: [client]. */ externalMetadataCreatedBy: string; /** * The type of external metadata of the clients to match. Defaults to `cimd`. Possible values: [cimd]. */ externalMetadataType: string; } export interface GetClientProfileClientConfiguration { /** * Methods used to discover the organization during login. Requires the `organizationRequireBehavior` default value to be `preLoginPrompt`. */ organizationDiscoveryMethods: outputs.GetClientProfileClientConfigurationOrganizationDiscoveryMethod[]; /** * Defines how to proceed during an authentication transaction when the organization usage is `require`. */ organizationRequireBehaviors: outputs.GetClientProfileClientConfigurationOrganizationRequireBehavior[]; /** * Whether matched clients can use organizations. */ organizationUsages: outputs.GetClientProfileClientConfigurationOrganizationUsage[]; /** * Refresh token settings applied to matched clients. Auth0 replaces this block as a whole, so removing it clears all of its settings. */ refreshTokens: outputs.GetClientProfileClientConfigurationRefreshToken[]; /** * Whether matched clients must use proof of possession (DPoP) for their tokens. */ requireProofOfPossessions: outputs.GetClientProfileClientConfigurationRequireProofOfPossession[]; } export interface GetClientProfileClientConfigurationOrganizationDiscoveryMethod { /** * Possible values: [email organizationName]. */ defaultValues: string[]; } export interface GetClientProfileClientConfigurationOrganizationRequireBehavior { /** * Possible values: [noPrompt pre_login_prompt postLoginPrompt]. */ defaultValue: string; } export interface GetClientProfileClientConfigurationOrganizationUsage { /** * Possible values: [deny allow require]. */ defaultValue: string; } export interface GetClientProfileClientConfigurationRefreshToken { /** * The inactivity lifetime of a refresh token. It must not exceed `tokenLifetime`. If only one of `tokenLifetime` and `idleTokenLifetime` is set, Auth0 derives the other. */ idleTokenLifetimes: outputs.GetClientProfileClientConfigurationRefreshTokenIdleTokenLifetime[]; /** * The period in which a refresh token may be reused without triggering reuse detection. */ leeways: outputs.GetClientProfileClientConfigurationRefreshTokenLeeway[]; /** * The absolute lifetime of a refresh token. If only one of `tokenLifetime` and `idleTokenLifetime` is set, Auth0 derives the other. */ tokenLifetimes: outputs.GetClientProfileClientConfigurationRefreshTokenTokenLifetime[]; } export interface GetClientProfileClientConfigurationRefreshTokenIdleTokenLifetime { /** * The lifetime in seconds. */ defaultValue: number; } export interface GetClientProfileClientConfigurationRefreshTokenLeeway { /** * The leeway in seconds. `0` disables the leeway. */ defaultValue: number; } export interface GetClientProfileClientConfigurationRefreshTokenTokenLifetime { /** * The lifetime in seconds. */ defaultValue: number; } export interface GetClientProfileClientConfigurationRequireProofOfPossession { /** * Whether proof of possession is required. */ defaultValue: boolean; } export interface GetClientRefreshToken { /** * Options include `expiring`, `non-expiring`. Whether a refresh token will expire based on an absolute lifetime, after which the token can no longer be used. If rotation is `rotating`, this must be set to `expiring`. */ expirationType: string; /** * The time in seconds after which inactive refresh tokens will expire. */ idleTokenLifetime: number; /** * Whether inactive refresh tokens should remain valid indefinitely. */ infiniteIdleTokenLifetime: boolean; /** * Whether refresh tokens should remain valid indefinitely. If false, `tokenLifetime` should also be set. */ infiniteTokenLifetime: boolean; /** * The amount of time in seconds in which a refresh token may be reused without triggering reuse detection. */ leeway: number; /** * A collection of policies governing multi-resource refresh token exchange (MRRT), defining how refresh tokens can be used across different resource servers */ policies: outputs.GetClientRefreshTokenPolicy[]; /** * Options include `rotating`, `non-rotating`. When `rotating`, exchanging a refresh token will cause a new refresh token to be issued and the existing token will be invalidated. This allows for automatic detection of token reuse if the token is leaked. */ rotationType: string; /** * The absolute lifetime of a refresh token in seconds. */ tokenLifetime: number; } export interface GetClientRefreshTokenPolicy { /** * The identifier of the resource server to which the Multi Resource Refresh Token Policy applies */ audience: string; /** * The resource server permissions granted under the Multi Resource Refresh Token Policy, defining the context in which an access token can be used */ scopes: string[]; } export interface GetClientSessionTransfer { /** * Indicates whether the application is allowed to use a refresh token when using a sessionTransferToken session. */ allowRefreshToken: boolean; allowedAuthenticationMethods: string[]; /** * Indicates whether the application(Native app) can use the Token Exchange endpoint to create a session_transfer_token */ canCreateSessionTransferToken: boolean; /** * Configuration for delegation (impersonation) access using Session Transfer Tokens. */ delegations: outputs.GetClientSessionTransferDelegation[]; /** * Indicates whether revoking the parent Refresh Token that initiated a Native to Web flow and was used to issue a Session Transfer Token should trigger a cascade revocation affecting its dependent child entities. Usually configured in the native application. */ enforceCascadeRevocation: boolean; /** * Configures the level of device binding enforced when a sessionTransferToken is consumed. Can be one of `ip`, `asn` or `none`. */ enforceDeviceBinding: string; /** * Indicates whether Refresh Tokens created during a native-to-web session are tied to that session's lifetime. This determines if such refresh tokens should be automatically revoked when their corresponding sessions are. Usually configured in the web application. */ enforceOnlineRefreshTokens: boolean; } export interface GetClientSessionTransferDelegation { /** * Indicates whether delegation (impersonation) access is allowed using Session Transfer Tokens. Defaults to `false`. */ allowDelegatedAccess: boolean; /** * Indicates the device binding enforcement for delegation (impersonation) access. If set to 'ip', device binding is enforced by IP. If set to 'asn', device binding is enforced by ASN. Defaults to `ip`. */ enforceDeviceBinding: string; } export interface GetClientSignedRequestObject { /** * Credentials that will be enabled on the client for JWT-secured authorization requests. */ credentials: outputs.GetClientSignedRequestObjectCredential[]; /** * Require JWT-secured authorization requests. */ required: boolean; } export interface GetClientSignedRequestObjectCredential { /** * Algorithm which will be used with the credential. Can be one of `RS256`, `RS384`, `PS256`. If not specified, `RS256` will be used. */ algorithm: string; /** * The ISO 8601 formatted date the credential was created. */ createdAt: string; /** * Credential type. Supported types: `publicKey`. */ credentialType: string; /** * The ISO 8601 formatted date representing the expiration of the credential. */ expiresAt: string; /** * The ID of the client credential. */ id: string; /** * The key identifier of the credential, generated on creation. */ keyId: string; /** * Friendly name for a credential. */ name: string; /** * The ISO 8601 formatted date the credential was updated. */ updatedAt: string; } export interface GetClientTokenExchange { /** * List of allowed profile types for token exchange. Supported values include: custom_authentication, on_behalf_of_token_exchange. */ allowAnyProfileOfTypes: string[]; } export interface GetClientTokenQuota { /** * The token quota configuration for client credentials. */ clientCredentials: outputs.GetClientTokenQuotaClientCredential[]; } export interface GetClientTokenQuotaClientCredential { /** * If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs. */ enforce: boolean; /** * Maximum number of issued tokens per day */ perDay: number; /** * Maximum number of issued tokens per hour */ perHour: number; } export interface GetClientsClient { /** * The ID of the agent (`auth0.Agent`) this client is linked to (EA Only). Reference it as `auth0_agent..id` so that the client is unlinked before the agent is deleted. Removing the attribute unlinks the client, including a link made outside Terraform. Requires the `update:clients` and `update:agents` scopes. */ agentId: string; /** * List of applications ID's that will be allowed to make delegation request. By default, all applications will be allowed. */ allowedClients: string[]; /** * URLs that Auth0 may redirect to after logout. */ allowedLogoutUrls: string[]; /** * URLs that represent valid origins for cross-origin resource sharing. By default, all your callback URLs will be allowed. */ allowedOrigins: string[]; /** * Anonymous Sessions settings for the client. Removing this block clears the setting on the API. (EA only) */ anonymousSessions: outputs.GetClientsClientAnonymousSession[]; /** * Type of application the client represents. Possible values are: `native`, `spa`, `regularWeb`, `nonInteractive`, `resourceServer`,`ssoIntegration`. 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`, `expressConfiguration` */ appType: string; /** * List of notification channels enabled for CIBA (Client-Initiated Backchannel Authentication) requests initiated by this client. Valid values are `guardian-push`, `email`, and `my-account`.The order is significant as this is the order in which notification channels will be evaluated. */ asyncApprovalNotificationChannels: string[]; /** * Configuration for B2B Integration (Enterprise Connect) clients. Contents can be updated in place, but adding or removing whole block forces client recreation. (EA only) */ b2bIntegrationConfigurations: outputs.GetClientsClientB2bIntegrationConfiguration[]; /** * 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://. */ callbacks: string[]; /** * The ID of the client. If not provided, `name` must be set. */ clientId?: string; /** * 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]`. */ clientMetadata: { [key: string]: string; }; /** * Secret for the client. Keep this private. To access this attribute you need to add the `read:client_keys` scope to the Terraform client. Otherwise, the attribute will contain an empty string. Set `hideClientSecret` to `true` to avoid persisting this value into Terraform state. */ clientSecret: string; /** * Description of the purpose of the client. */ description: string; /** * Express Configuration settings for the client. Used with OIN Express Configuration. */ expressConfigurations: outputs.GetClientsClientExpressConfiguration[]; /** * The URL of the Client ID Metadata Document. Only present for CIMD-registered clients. */ externalClientId: string; /** * Who created the external metadata client: `admin` (via Management API), `client` (self-registered), or `unknown`. */ externalMetadataCreatedBy: string; /** * Whether Auth0 can resolve the Client ID Metadata Document from its cache or the document URL: `available` or `unavailable` (EA only). Only present for CIMD-registered clients. */ externalMetadataStatus: string; /** * Type of external metadata. Value is `cimd` for CIMD-registered clients. */ externalMetadataType: string; /** * Federated Credential Management (FedCM) configuration. (EA only) */ fedcmLogins: outputs.GetClientsClientFedcmLogin[]; /** * Types of grants that this client is authorized to use. */ grantTypes: string[]; /** * Configures the client to participate in the Identity Assertion Authorization Grant (ID-JAG) exchange, used for Cross App Access (XAA). (EA only) */ identityAssertionAuthorizationGrants: outputs.GetClientsClientIdentityAssertionAuthorizationGrant[]; /** * Indicates whether this client is a first-party client. */ isFirstParty: boolean; /** * Indicates whether the token endpoint IP header is trusted. Requires the authentication method to be set to `clientSecretPost` or `clientSecretBasic`. Setting this property when creating the resource, will default the authentication method to `clientSecretPost`. To change the authentication method to `clientSecretBasic` use the `auth0.ClientCredentials` resource. */ isTokenEndpointIpHeaderTrusted: boolean; /** * URL for the JSON Web Key Set (JWKS) containing the public keys used for `privateKeyJwt` authentication. Only present for CIMD clients using `privateKeyJwt` authentication. */ jwksUri: string; /** * Configuration for self-service organization features, controlling how organizations are created and managed for this client. */ myOrganizationConfigurations: outputs.GetClientsClientMyOrganizationConfiguration[]; /** * The name of the client. If not provided, `clientId` must be set. */ name?: string; /** * Configure OIDC logout for the Client */ oidcLogouts: outputs.GetClientsClientOidcLogout[]; /** * Methods for discovering organizations during the pre_login_prompt. Can include `email` (allows users to find their organization by entering their email address) and/or `organizationName` (requires users to enter the organization name directly). These methods can be combined. Setting this property requires that `organizationRequireBehavior` is set to `preLoginPrompt`. For clients that set `b2bIntegrationConfiguration`, server-side defaults the values when this is not specified; Set to `[]` (empty array) to clear the values. */ organizationDiscoveryMethods: string[]; /** * Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows.Allowed values: `allowAlways` or `openRedirectProtection`. */ redirectionPolicy: string; /** * The identifier of a resource server that client is associated withThis property can be sent only when app_type=resource_server.This property can not be changed, once the client is created. */ resourceServerIdentifier: string; sessionTransfers: outputs.GetClientsClientSessionTransfer[]; /** * Indicates whether the confirmation prompt appears when using non-verifiable callback URIs. Set to true to skip the prompt, false to show it, or null to unset. Accepts (true/false/null) or ("true"/"false"/"null") */ skipNonVerifiableCallbackUriConfirmationPrompt: string; /** * Security mode for third-party clients. Allowed values: `strict` or `permissive`. */ thirdPartySecurityMode: string; /** * Allows configuration for token exchange */ tokenExchanges: outputs.GetClientsClientTokenExchange[]; /** * The token quota configuration. */ tokenQuotas: outputs.GetClientsClientTokenQuota[]; /** * URLs that represent valid web origins for use with web message response mode. */ webOrigins: string[]; } export interface GetClientsClientAnonymousSession { /** * If set to true, this client is allowed to create anonymous sessions. Requires `oidcConformant` to be set to `true`. Set to `false` to disable. (EA only) */ active: boolean; } export interface GetClientsClientB2bIntegrationConfiguration { /** * The type of integration used to connect to this B2B integration client. One of custom_auth_server, third_party, application */ integrationType: string; /** * ID of the self-service SSO profile (an `auth0.SelfServiceProfile` id, in `ssp_...` format) linked to this B2B integration client. Maximum 1. */ ssoProfiles: string[]; } export interface GetClientsClientExpressConfiguration { /** * The domain that admins are expected to log in via for authenticating for express configuration. */ adminLoginDomain: string; /** * The ID of the connection profile to use for this application. */ connectionProfileId: string; /** * When true, all connections made via express configuration will be enabled for this application. */ enableClient: boolean; /** * When true, all connections made via express configuration will have the associated organization enabled. */ enableOrganization: boolean; /** * The URI users should bookmark to log in to this application. Variable substitution is permitted for: organization_name, organization_id, and connection_name. */ initiateLoginUriTemplate: string; /** * List of client IDs that are linked to this express configuration (e.g. web or mobile clients). */ linkedClients: outputs.GetClientsClientExpressConfigurationLinkedClient[]; /** * The identifier of the published application in the OKTA OIN. */ oinSubmissionId: string; /** * The unique identifier for the Okta OIN Express Configuration Client. */ oktaOinClientId: string; /** * The ID of the user attribute profile to use for this application. */ userAttributeProfileId: string; } export interface GetClientsClientExpressConfigurationLinkedClient { /** * The ID of the linked client. */ clientId: string; } export interface GetClientsClientFedcmLogin { /** * Google FedCM configuration. (EA only) */ googles: outputs.GetClientsClientFedcmLoginGoogle[]; } export interface GetClientsClientFedcmLoginGoogle { /** * Whether to show the Google FedCM prompt on Login. (EA only) */ isEnabled: boolean; } export interface GetClientsClientIdentityAssertionAuthorizationGrant { /** * Whether the client can exchange ID-JAGs for access tokens. (EA only) */ active: boolean; } export interface GetClientsClientMyOrganizationConfiguration { /** * The list of connection strategies that are allowed when creating organizations for this client (e.g. "okta", "samlp"). */ allowedStrategies: string[]; /** * Controls the behavior when deleting connections associated with organizations for this client. Possible values: `allow`, `allowIfEmpty`. */ connectionDeletionBehavior: string; /** * The ID of the connection profile to use when creating organizations for this client. */ connectionProfileId: string; /** * When true, limits the permissions that organization admins can assign to members to only those held by the admin themselves. Requires the `myOrgMemberManagementEa` feature flag. Available in Early Access (EA). */ enforcePermissionCeiling: boolean; /** * When true, prevents organization admins from assigning permissions to themselves. Requires the `myOrgMemberManagementEa` feature flag. Available in Early Access (EA). */ enforceSelfAssignmentRestriction: boolean; /** * The client ID used as the invitation landing page when creating invitations through the My Organization API. Requires the tenant to have member management enabled, and the referenced client must allow organizations. */ invitationLandingClientId: string; /** * Configures third-party client access to organizations created for this client through the My Organization API. Requires the `myOrgsThirdPartyClientSupport` (EA Only) */ thirdPartyClientAccesses: outputs.GetClientsClientMyOrganizationConfigurationThirdPartyClientAccess[]; /** * The ID of the user attribute profile to use when creating organizations for this client. */ userAttributeProfileId: string; } export interface GetClientsClientMyOrganizationConfigurationThirdPartyClientAccess { /** * The third-party client access values that can be set on organizations created for this client through the My Organization API. Required whenever this block is set — the API rejects the block without it. Possible values: `allow`, `block`. Unlike `auth0.ConnectionProfile`'s `crossAppAccessResourceApp`, a single value is accepted here. (EA Only) */ allowedValues: string[]; /** * The default third-party client access value applied to organizations created for this client. The API currently only accepts "block"; "allow" is rejected with a 400 error, so this is exposed as computed-only rather than user-settable. (EA Only) */ defaultValue: string; } export interface GetClientsClientOidcLogout { /** * Configure OIDC logout initiators for the Client */ backchannelLogoutInitiators: outputs.GetClientsClientOidcLogoutBackchannelLogoutInitiator[]; /** * Controls whether session metadata is included in the logout token. Default value is null. */ backchannelLogoutSessionMetadatas: outputs.GetClientsClientOidcLogoutBackchannelLogoutSessionMetadata[]; /** * Set of URLs that are valid to call back from Auth0 for OIDC backchannel logout. Currently only one URL is allowed. */ backchannelLogoutUrls: string[]; } export interface GetClientsClientOidcLogoutBackchannelLogoutInitiator { /** * Determines the configuration method for enabling initiators. `custom` enables only the initiators listed in the backchannelLogoutSelectedInitiators set, `all` enables all current and future initiators. */ mode: string; /** * Contains the list of initiators to be enabled for the given client. */ selectedInitiators: string[]; } export interface GetClientsClientOidcLogoutBackchannelLogoutSessionMetadata { /** * The `include` property determines whether session metadata is included in the logout token. */ include: boolean; } export interface GetClientsClientSessionTransfer { /** * Indicates whether the application is allowed to use a refresh token when using a sessionTransferToken session. */ allowRefreshToken: boolean; allowedAuthenticationMethods: string[]; /** * Indicates whether the application(Native app) can use the Token Exchange endpoint to create a session_transfer_token */ canCreateSessionTransferToken: boolean; /** * Configuration for delegation (impersonation) access using Session Transfer Tokens. */ delegations: outputs.GetClientsClientSessionTransferDelegation[]; /** * Indicates whether revoking the parent Refresh Token that initiated a Native to Web flow and was used to issue a Session Transfer Token should trigger a cascade revocation affecting its dependent child entities. Usually configured in the native application. */ enforceCascadeRevocation: boolean; /** * Configures the level of device binding enforced when a sessionTransferToken is consumed. Can be one of `ip`, `asn` or `none`. */ enforceDeviceBinding: string; /** * Indicates whether Refresh Tokens created during a native-to-web session are tied to that session's lifetime. This determines if such refresh tokens should be automatically revoked when their corresponding sessions are. Usually configured in the web application. */ enforceOnlineRefreshTokens: boolean; } export interface GetClientsClientSessionTransferDelegation { /** * Indicates whether delegation (impersonation) access is allowed using Session Transfer Tokens. Defaults to `false`. */ allowDelegatedAccess: boolean; /** * Indicates the device binding enforcement for delegation (impersonation) access. If set to 'ip', device binding is enforced by IP. If set to 'asn', device binding is enforced by ASN. Defaults to `ip`. */ enforceDeviceBinding: string; } export interface GetClientsClientTokenExchange { /** * List of allowed profile types for token exchange. Supported values include: custom_authentication, on_behalf_of_token_exchange. */ allowAnyProfileOfTypes: string[]; } export interface GetClientsClientTokenQuota { /** * The token quota configuration for client credentials. */ clientCredentials: outputs.GetClientsClientTokenQuotaClientCredential[]; } export interface GetClientsClientTokenQuotaClientCredential { /** * If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs. */ enforce: boolean; /** * Maximum number of issued tokens per day */ perDay: number; /** * Maximum number of issued tokens per hour */ perHour: number; } export interface GetConnectionAuthentication { active: boolean; } export interface GetConnectionConnectedAccount { active: boolean; } export interface GetConnectionCrossAppAccessRequestingApp { active: boolean; } export interface GetConnectionCrossAppAccessResourceApp { /** * Whether the connection acts as a Cross App Access resource application. One of `enabled` or `disabled`. (EA only) */ status: string; } export interface GetConnectionDirectoryDefaultMappingMapping { /** * The field location in the Auth0 schema. */ auth0: string; /** * The field location in the IDP schema. */ idp: string; } export interface GetConnectionDirectoryMapping { /** * The field location in the Auth0 schema. */ auth0: string; /** * The field location in the IDP schema. */ idp: string; } export interface GetConnectionDirectorySynchronizedGroupsGroup { /** * Number of direct members in the Google Workspace Directory group. */ directMembersCount: number; /** * Google Workspace Directory group email. */ email: string; /** * Google Workspace Directory group ID. */ id: string; /** * Google Workspace Directory group name. */ name: string; } export interface GetConnectionKeysKey { /** * The signing key algorithm. */ algorithm: string; /** * The public certificate of the signing key. */ cert: string; connectionId: string; /** * True if the key is the current key. */ current: boolean; /** * The date and time when the key became the current key. */ currentSince: string; /** * The certificate fingerprint. */ fingerprint: string; /** * The signing key use, whether for encryption or signing. */ keyUse: string; /** * The key ID of the signing key. */ kid: string; /** * True if the key is the next key. */ next: boolean; /** * The public certificate of the signing key in PKCS7 format. */ pkcs: string; /** * True if the key is the previous key. */ previous: boolean; /** * The subject distinguished name (DN) of the certificate. */ subjectDn: string; /** * The certificate thumbprint. */ thumbprint: string; /** * This is an arbitrary map, which when edited shall perform rotation of keys for the corresponding connection. It can host keys like version, timestamp of last rotation etc.The field has no association with API */ triggers: { [key: string]: string; }; } export interface GetConnectionOption { /** * URL used to exchange a user-authorized request token for an access token. */ accessTokenUrl: string; /** * ADFS URL where to fetch the metadata source. */ adfsServer: string; /** * List of allowed audiences. */ allowedAudiences: string[]; /** * Enable API Access to groups. */ apiEnableGroups: boolean; /** * Enable API Access to users. */ apiEnableUsers: boolean; /** * App ID. */ appId: string; /** * Settings for SAML assertion decryption. Only applicable when strategy=samlp or pingfederate. */ assertionDecryptionSettings: outputs.GetConnectionOptionAssertionDecryptionSetting[]; /** * OpenID Connect and Okta Workforce connections can automatically map claims received from the identity provider (IdP). You can configure this mapping through a library template provided by Auth0 or by entering your own template directly. Click [here](https://auth0.com/docs/authenticate/identity-providers/enterprise-identity-providers/configure-pkce-claim-mapping-for-oidc#map-claims-for-oidc-connections) for more info. */ attributeMaps: outputs.GetConnectionOptionAttributeMap[]; /** * Order of attributes for precedence in identification.Valid values: email, phone_number, username. If Precedence is set, it must contain all values (email, phone_number, username) in specific order */ attributes: outputs.GetConnectionOptionAttribute[]; /** * Query string parameters to be included as part of the generated passwordless email link. */ authParams: { [key: string]: string; }; /** * Specifies the authentication methods and their configuration (enabled or disabled) */ authenticationMethods: outputs.GetConnectionOptionAuthenticationMethod[]; /** * Authorization endpoint. */ authorizationEndpoint: string; /** * Indicates whether to enable brute force protection, which will limit the number of signups and failed logins from a suspicious IP address. */ bruteForceProtection: boolean; /** * The strategy's client ID. */ clientId: string; /** * The strategy's client secret. **Note:** For better security, consider using `optionsClientSecretWo` instead to avoid storing the secret in Terraform state. */ clientSecret: string; /** * Salesforce community base URL. */ communityBaseUrl: string; /** * A case-sensitive map of key value pairs used as configuration variables for the `customScript`. */ configuration: { [key: string]: string; }; /** * Proof Key for Code Exchange (PKCE) configuration settings for an OIDC or Okta Workforce connection. */ connectionSettings: outputs.GetConnectionOptionConnectionSetting[]; /** * Identifies the client to the service provider */ consumerKey: string; /** * Secret used to establish ownership of the consumer key. */ consumerSecret: string; /** * Configure extra headers to the Token endpoint of an OAuth 2.0 provider */ customHeaders: outputs.GetConnectionOptionCustomHeader[]; /** * Configure custom password hashing within a connection. (EA only) */ customPasswordHashes: outputs.GetConnectionOptionCustomPasswordHash[]; /** * A map of scripts used to integrate with a custom database. */ customScripts: { [key: string]: string; }; /** * When enabled, additional debug information will be generated. */ debug: boolean; /** * The key used to decrypt encrypted responses from the connection. Uses the `key` and `cert` properties to provide the private key and certificate respectively. */ decryptionKeys: outputs.GetConnectionOptionDecryptionKey[]; /** * The destination URL for the SAML assertion. Used when configuring a SAML connection for proxy gateways. */ destinationUrl: string; /** * Sign Request Algorithm Digest. */ digestAlgorithm: string; /** * Indicates whether to disable the cache or not. */ disableCache: boolean; /** * Indicates whether to remove the forgot password link within the New Universal Login. */ disableSelfServiceChangePassword: boolean; /** * When enabled, will disable sign out. */ disableSignOut: boolean; /** * Indicates whether to allow user sign-ups to your application. */ disableSignup: boolean; /** * OpenID discovery URL, e.g. `https://auth.example.com/.well-known/openid-configuration`. */ discoveryUrl: string; /** * Domain name. */ domain: string; /** * List of the domains that can be authenticated using the identity provider. Only needed for Identifier First authentication flows. */ domainAliases: string[]; /** * The algorithm used to sign the DPoP proof. Allowed values: ES256, ES384, ES512, Ed25519. */ dpopSigningAlg: string; /** * Indicates whether to request the email scope. Used by some OAuth2 connections (e.g., LINE). */ email: boolean; /** * Set to `true` to inject context into custom DB scripts (warning: cannot be disabled once enabled). */ enableScriptContext: boolean; /** * Set to `true` to use a legacy user store. */ enabledDatabaseCustomization: boolean; /** * Custom Entity ID for the connection. */ entityId: string; /** * Federation Metadata for the ADFS connection. */ fedMetadataXml: string; /** * Configuration for collecting access tokens and refresh tokens from federated connections. Only applicable for OIDC connections. */ federatedConnectionsAccessTokens: outputs.GetConnectionOptionFederatedConnectionsAccessToken[]; /** * If you're configuring a SAML enterprise connection for a non-standard PingFederate Server, you must update the attribute mappings. */ fieldsMap: string; /** * Specifies whether or not request info should be forwarded to sms gateway. */ forwardRequestInfo: boolean; /** * Address to use as the sender. */ from: string; /** * Defines the parameters used to generate the auth token for the custom gateway. */ gatewayAuthentications: outputs.GetConnectionOptionGatewayAuthentication[]; /** * Defines a custom sms gateway to use instead of Twilio. */ gatewayUrl: string; /** * Specifies the issuer of the JWT used for global token revocation for the SAML connection. */ globalTokenRevocationJwtIss: string; /** * Specifies the subject of the JWT used for global token revocation for the SAML connection. */ globalTokenRevocationJwtSub: string; /** * Icon URL. */ iconUrl: string; /** * Indicates whether the identity provider supports session expiry via the id_token. When true, Auth0 will use the sessionExpiry claim from the upstream IdP's ID token to determine the maximum session lifetime. Only applicable for Okta and OIDC connections. */ idTokenSessionExpirySupported: boolean; /** * List of allowed algorithms for the ID token signature. If not set or empty, default algorithm(s) will be applied at runtime. (Okta/OIDC Connections) */ idTokenSignedResponseAlgs: string[]; /** * Azure AD Identity API. Available options are: `microsoft-identity-platform-v2.0` or `azure-active-directory-v1.0`. */ identityApi: string; /** * Configuration options for IDP Initiated Authentication. This is an object with the properties: `clientId`, `clientProtocol`, and `clientAuthorizeQuery`. */ idpInitiateds: outputs.GetConnectionOptionIdpInitiated[]; /** * Indicates whether you have a legacy user store and want to gradually migrate those users to the Auth0 user store. */ importMode: boolean; /** * A list of IPs. */ ips: string[]; /** * Issuer URL, e.g. `https://auth.example.com`. */ issuer: string; /** * JWKS URI. */ jwksUri: string; /** * Apple Key ID. */ keyId: string; /** * By default Auth0 maps `userId` to `email`. Enabling this setting changes the behavior to map `userId` to 'id' instead. This can only be defined on a new Google Workspace connection and can not be changed once set. */ mapUserIdToId: boolean; /** * Maximum number of groups to retrieve. */ maxGroupsToRetrieve: string; /** * SID for Copilot. Used when SMS Source is Copilot. */ messagingServiceSid: string; /** * The URL of the SAML metadata document. */ metadataUrl: string; /** * The XML content for the SAML metadata document. Values within the xml will take precedence over other attributes set on the options block. */ metadataXml: string; /** * Configuration options for multifactor authentication. */ mfas: outputs.GetConnectionOptionMfa[]; /** * The public name of the email or SMS Connection. In most cases this is the same name as the connection name. */ name: string; /** * If there are user fields that should not be stored in Auth0 databases due to privacy reasons, you can add them to the DenyList here. */ nonPersistentAttrs: string[]; /** * Additional OIDC metadata to include in the discovery document. Only applicable when strategy=oidc, okta, or samlp. On oidc and okta, Auth0 defaults any omitted `claimsParameterSupported`, `requestParameterSupported`, `requestUriParameterSupported`, `requireRequestUriRegistration` field to false. Those defaults are not tracked in provider until set to true explisitly. (EA only) */ oidcMetadata: string; /** * One-time password settings for database (`auth0` strategy) connections, configurable per delivery channel. (EA only) */ otpSettings: outputs.GetConnectionOptionOtpSetting[]; /** * Defines options for the passkey authentication method */ passkeyOptions: outputs.GetConnectionOptionPasskeyOption[]; /** * Configuration settings for password complexity. */ passwordComplexityOptions: outputs.GetConnectionOptionPasswordComplexityOption[]; /** * Configuration settings for the password dictionary check, which does not allow passwords that are part of the password dictionary. */ passwordDictionaries: outputs.GetConnectionOptionPasswordDictionary[]; /** * Configuration settings for the password history that is maintained for each user to prevent the reuse of passwords. */ passwordHistories: outputs.GetConnectionOptionPasswordHistory[]; /** * 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`. */ passwordNoPersonalInfos: outputs.GetConnectionOptionPasswordNoPersonalInfo[]; /** * Flexible password policy configuration. Only available for `auth0` strategy connections. Cannot be set together with legacy password policy fields (`passwordPolicy`, `passwordComplexityOptions`, `passwordHistory`, `passwordNoPersonalInfo`, `passwordDictionary`). */ passwordOptions: outputs.GetConnectionOptionPasswordOption[]; /** * 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`. */ passwordPolicy: string; /** * Ping Federate Server URL. */ pingFederateBaseUrl: string; /** * Enables Proof Key for Code Exchange (PKCE) functionality for OAuth2 connections. */ pkceEnabled: boolean; /** * Order of attributes for precedence in identification.Valid values: email, phone_number, username. If Precedence is set, it must contain all values (email, phone_number, username) in specific order */ precedences: string[]; /** * The SAML Response Binding: how the SAML token is received by Auth0 from the IdP. */ protocolBinding: string; /** * Defines the custom `smsGateway` provider. */ provider: string; /** * Allows configuration if connectionsRealmFallback flag is enabled for the tenant */ realmFallback: boolean; /** * The recipient URL for the SAML assertion. Used when configuring a SAML connection for proxy gateways. */ recipientUrl: string; /** * Template that formats the SAML request. */ requestTemplate: string; /** * URL used to obtain an unauthorized request token. */ requestTokenUrl: string; /** * Indicates whether the user is required to provide a username in addition to an email address. */ requiresUsername: boolean; /** * Permissions to grant to the connection. Within the Auth0 dashboard these appear under the "Attributes" and "Extended Attributes" sections. Some examples: `basicProfile`, `extProfile`, `extNestedGroups`, etc. */ scopes: string[]; /** * A map of scripts used for an OAuth connection. Only accepts a `fetchUserProfile` script. */ scripts: { [key: string]: string; }; /** * When true and `type` is 'back_channel', includes a cryptographic nonce in authorization requests to prevent replay attacks. The identity provider must include this nonce in the ID token for validation. */ sendBackChannelNonce: boolean; /** * Session Key for storing the request token. */ sessionKey: string; /** * Determines whether to sync user profile attributes (`name`, `givenName`, `familyName`, `nickname`, `picture`) at each login or only on the first login. Options include: `onEachLogin`, `onFirstLogin`, `neverOnLogin`. Default value: `onEachLogin`. */ setUserRootAttributes: string; /** * Choose how Auth0 sets the emailVerified field in the user profile. */ shouldTrustEmailVerifiedConnection: string; /** * SAML single login URL for the connection. */ signInEndpoint: string; /** * SAML single logout URL for the connection. */ signOutEndpoint: string; /** * When enabled, the SAML authentication request will be signed. */ signSamlRequest: boolean; /** * Sign Request Algorithm. */ signatureAlgorithm: string; /** * Signature method used to sign the request */ signatureMethod: string; /** * X.509 signing certificate (encoded in PEM or CER) you retrieved from the IdP, Base64-encoded. */ signingCert: string; /** * The key used to sign requests in the connection. Uses the `key` and `cert` properties to provide the private key and certificate respectively. */ signingKeys: outputs.GetConnectionOptionSigningKey[]; /** * Version 1 is deprecated, use version 2. */ strategyVersion: number; /** * Subject line of the email. */ subject: string; /** * Syntax of the template body. */ syntax: string; /** * Apple Team ID. */ teamId: string; /** * Body of the template. */ template: string; /** * Tenant domain name. */ tenantDomain: string; /** * Token endpoint. */ tokenEndpoint: string; /** * Specifies the authentication method for the token endpoint. (Okta/OIDC Connections) */ tokenEndpointAuthMethod: string; /** * Specifies the signing algorithm for the token endpoint. (Okta/OIDC Connections) */ tokenEndpointAuthSigningAlg: string; /** * Specifies the format of the aud (audience) claim in the JWT for client authentication. Accepted values: 'issuer' or 'token_endpoint'. (Okta/OIDC Connections) */ tokenEndpointJwtcaAudFormat: string; /** * Configuration options for one-time passwords. */ totps: outputs.GetConnectionOptionTotp[]; /** * SID for your Twilio account. */ twilioSid: string; /** * AuthToken for your Twilio account. */ twilioToken: string; /** * The connection's communication channel type. For OIDC connections, accepted values are `backChannel` and `frontChannel`; for Okta Workforce connections, only `backChannel` is accepted. Front Channel uses the OIDC protocol with `response_mode=form_post` and `response_type=id_token`. Back Channel uses `response_type=code`. */ type: string; /** * You can pass provider-specific parameters to an identity provider during authentication. The values can either be static per connection or dynamic per user. */ upstreamParams: string; /** * Indicates whether to use cert auth or not. */ useCertAuth: boolean; /** * Indicates whether to use Kerberos or not. */ useKerberos: boolean; /** * Enabling this when using the connectionScope parameter, uses space as a delimiter for scopes when calling the IdP's API. */ useOauthSpecScope: boolean; /** * Whether to use WS-Fed. */ useWsfed: boolean; /** * URL used to obtain user authorization. */ userAuthorizationUrl: string; /** * Attribute in the token that will be mapped to the userId property in Auth0. */ userIdAttribute: string; /** * User info endpoint. */ userinfoEndpoint: string; /** * Validation of the minimum and maximum values allowed for a user to have as username. */ validations: outputs.GetConnectionOptionValidation[]; /** * Indicates whether 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. */ waadCommonEndpoint: boolean; /** * Protocol to use. */ waadProtocol: string; } export interface GetConnectionOptionAssertionDecryptionSetting { /** * A list of insecure algorithms to allow for SAML assertion decryption. */ algorithmExceptions: string[]; /** * The algorithm profile to use for decrypting SAML assertions. Options include: `v2026-1`. */ algorithmProfile: string; } export interface GetConnectionOptionAttribute { /** * Connection Options for Email Attribute */ emails: outputs.GetConnectionOptionAttributeEmail[]; /** * Connection Options for Phone Number Attribute */ phoneNumbers: outputs.GetConnectionOptionAttributePhoneNumber[]; /** * Connection Options for User Name Attribute */ usernames: outputs.GetConnectionOptionAttributeUsername[]; } export interface GetConnectionOptionAttributeEmail { /** * Connection Options Email Attribute Identifier */ identifiers: outputs.GetConnectionOptionAttributeEmailIdentifier[]; /** * Defines whether Profile is required */ profileRequired: boolean; /** * Defines signup settings for Email attribute */ signups: outputs.GetConnectionOptionAttributeEmailSignup[]; /** * If set to false, it allow multiple accounts with the same email address. Defaults to `true`. This can only be set when the connection is created: the Auth0 Management API does not allow updating it, so changing it on an existing connection fails at plan time and requires recreating the connection. The API also refuses to add a non-unique email attribute to a connection that does not already have one. */ unique: boolean; /** * Defines whether whether user will receive a link or an OTP during user signup for email verification and password reset for email verification */ verificationMethod: string; } export interface GetConnectionOptionAttributeEmailIdentifier { /** * Defines whether email attribute is active as an identifier */ active: boolean; /** * Gets and Sets the default authentication method for the email identifier type. Valid values: `password`, `emailOtp` */ defaultMethod: string; } export interface GetConnectionOptionAttributeEmailSignup { /** * Defines signup status for Email Attribute */ status: string; /** * Defines settings for Verification under Email attribute */ verifications: outputs.GetConnectionOptionAttributeEmailSignupVerification[]; } export interface GetConnectionOptionAttributeEmailSignupVerification { /** * Defines verification settings for signup attribute */ active: boolean; } export interface GetConnectionOptionAttributeMap { /** * This property is an object containing mapping information that allows Auth0 to interpret incoming claims from the IdP. Mapping information must be provided as key/value pairs. */ attributes: string; /** * Method used to map incoming claims. Possible values: `useMap` (Okta or OIDC), `bindAll` (OIDC) or `basicProfile` (Okta). */ mappingMode: string; /** * This property defines the scopes that Auth0 sends to the IdP’s UserInfo endpoint when requested. */ userinfoScope: string; } export interface GetConnectionOptionAttributePhoneNumber { /** * Connection Options Phone Number Attribute Identifier */ identifiers: outputs.GetConnectionOptionAttributePhoneNumberIdentifier[]; /** * Defines whether Profile is required */ profileRequired: boolean; /** * Defines signup settings for Phone Number attribute */ signups: outputs.GetConnectionOptionAttributePhoneNumberSignup[]; } export interface GetConnectionOptionAttributePhoneNumberIdentifier { /** * Defines whether Phone Number attribute is active as an identifier */ active: boolean; /** * Gets and Sets the default authentication method for the phoneNumber identifier type. Valid values: `password`, `phoneOtp` */ defaultMethod: string; } export interface GetConnectionOptionAttributePhoneNumberSignup { /** * Defines status of signup for Phone Number attribute */ status: string; /** * Defines verification settings for Phone Number attribute */ verifications: outputs.GetConnectionOptionAttributePhoneNumberSignupVerification[]; } export interface GetConnectionOptionAttributePhoneNumberSignupVerification { /** * Defines verification settings for Phone Number attribute */ active: boolean; } export interface GetConnectionOptionAttributeUsername { /** * Connection options for User Name Attribute Identifier */ identifiers: outputs.GetConnectionOptionAttributeUsernameIdentifier[]; /** * Defines whether Profile is required */ profileRequired: boolean; /** * Defines signup settings for User Name attribute */ signups: outputs.GetConnectionOptionAttributeUsernameSignup[]; /** * Defines validation settings for User Name attribute */ validations: outputs.GetConnectionOptionAttributeUsernameValidation[]; } export interface GetConnectionOptionAttributeUsernameIdentifier { /** * Defines whether UserName attribute is active as an identifier */ active: boolean; /** * Gets and Sets the default authentication method for the username identifier type. Valid value: `password` */ defaultMethod: string; } export interface GetConnectionOptionAttributeUsernameSignup { /** * Defines whether User Name attribute is active as an identifier */ status: string; } export interface GetConnectionOptionAttributeUsernameValidation { /** * Defines allowed types for for UserName attribute */ allowedTypes: outputs.GetConnectionOptionAttributeUsernameValidationAllowedType[]; /** * Defines Max Length for User Name attribute */ maxLength: number; /** * Defines Min Length for User Name attribute */ minLength: number; } export interface GetConnectionOptionAttributeUsernameValidationAllowedType { /** * One of the allowed types for UserName signup attribute */ email: boolean; /** * One of the allowed types for UserName signup attribute */ phoneNumber: boolean; } export interface GetConnectionOptionAuthenticationMethod { /** * Configures Email OTP authentication */ emailOtps: outputs.GetConnectionOptionAuthenticationMethodEmailOtp[]; /** * Configures passkey authentication */ passkeys: outputs.GetConnectionOptionAuthenticationMethodPasskey[]; /** * Configures password authentication */ passwords: outputs.GetConnectionOptionAuthenticationMethodPassword[]; /** * Configures Phone OTP authentication */ phoneOtps: outputs.GetConnectionOptionAuthenticationMethodPhoneOtp[]; } export interface GetConnectionOptionAuthenticationMethodEmailOtp { /** * Enables Email OTP authentication */ enabled: boolean; } export interface GetConnectionOptionAuthenticationMethodPasskey { /** * Enables passkey authentication */ enabled: boolean; } export interface GetConnectionOptionAuthenticationMethodPassword { /** * Specifies whether password is required or optional when creating users via API. Possible values: "required", "optional". Defaults to "required". */ apiBehavior: string; /** * Enables password authentication */ enabled: boolean; /** * Specifies whether password is allowed or blocked during signup flows. Possible values: "allow", "block". Defaults to "allow". */ signupBehavior: string; } export interface GetConnectionOptionAuthenticationMethodPhoneOtp { /** * Enables Phone OTP authentication */ enabled: boolean; } export interface GetConnectionOptionConnectionSetting { /** * PKCE configuration. Possible values: `auto` (uses the strongest algorithm available), `S256` (uses the SHA-256 algorithm), `plain` (uses plaintext as described in the PKCE specification) or `disabled` (disables support for PKCE). */ pkce: string; } export interface GetConnectionOptionCustomHeader { header: string; value: string; } export interface GetConnectionOptionCustomPasswordHash { /** * Id of an existing action that should be invoked when validating a universal password hash. This action must support password-hash-migration trigger */ actionId: string; } export interface GetConnectionOptionDecryptionKey { cert: string; key: string; } export interface GetConnectionOptionFederatedConnectionsAccessToken { /** * When enabled, Auth0 will collect and store access tokens and refresh tokens obtained from federated connections during authentication. */ active: boolean; } export interface GetConnectionOptionGatewayAuthentication { /** * Audience claim for the HS256 token sent to `gatewayUrl`. */ audience: string; /** * Authentication method (default is `bearer` token). */ method: string; /** * Secret used to sign the HS256 token sent to `gatewayUrl`. */ secret: string; /** * Specifies whether or not the secret is Base64-encoded. */ secretBase64Encoded: boolean; /** * Subject claim for the HS256 token sent to `gatewayUrl`. */ subject: string; } export interface GetConnectionOptionIdpInitiated { clientAuthorizeQuery: string; clientId: string; clientProtocol: string; enabled: boolean; } export interface GetConnectionOptionMfa { /** * Indicates whether multifactor authentication is enabled for this connection. */ active: boolean; /** * Indicates whether multifactor authentication enrollment settings will be returned. */ returnEnrollSettings: boolean; } export interface GetConnectionOptionOtpSetting { /** * One-time password settings for the email delivery channel. */ emails: outputs.GetConnectionOptionOtpSettingEmail[]; /** * One-time password settings for the phone delivery channel. */ phones: outputs.GetConnectionOptionOtpSettingPhone[]; } export interface GetConnectionOptionOtpSettingEmail { /** * Number of seconds before the one-time password expires. Must be between 60 and 86400. Defaults to 900 if not set. */ otpExpiry: number; /** * Number of digits in the generated one-time password. Must be between 4 and 48. Defaults to 6 if not set. */ otpLength: number; } export interface GetConnectionOptionOtpSettingPhone { /** * Number of seconds before the one-time password expires. Must be between 60 and 86400. Defaults to 900 if not set. */ otpExpiry: number; /** * Number of digits in the generated one-time password. Must be between 4 and 48. Defaults to 6 if not set. */ otpLength: number; } export interface GetConnectionOptionPasskeyOption { /** * Controls the UI used to challenge the user for their passkey */ challengeUi: string; /** * Enables or disables enrollment prompt for local passkey when user authenticates using a cross-device passkey for the connection */ localEnrollmentEnabled: boolean; /** * Enables or disables progressive enrollment of passkeys for the connection */ progressiveEnrollmentEnabled: boolean; } export interface GetConnectionOptionPasswordComplexityOption { /** * Minimum number of characters allowed in passwords. */ minLength: number; } export interface GetConnectionOptionPasswordDictionary { /** * Customized contents of the password dictionary. By default, the password dictionary contains a list of the [10,000 most common passwords](https://github.com/danielmiessler/SecLists/blob/master/Passwords/Common-Credentials/10k-most-common.txt); your customized content is used in addition to the default password dictionary. Matching is not case-sensitive. */ dictionaries: string[]; /** * Indicates whether the password dictionary check is enabled for this connection. */ enable: boolean; } export interface GetConnectionOptionPasswordHistory { enable: boolean; size: number; } export interface GetConnectionOptionPasswordNoPersonalInfo { enable: boolean; } export interface GetConnectionOptionPasswordOption { /** * Password complexity requirements. */ complexities: outputs.GetConnectionOptionPasswordOptionComplexity[]; /** * Dictionary-based password validation. */ dictionaries: outputs.GetConnectionOptionPasswordOptionDictionary[]; /** * Password history enforcement. */ histories: outputs.GetConnectionOptionPasswordOptionHistory[]; /** * Personal information restriction policy. */ profileDatas: outputs.GetConnectionOptionPasswordOptionProfileData[]; } export interface GetConnectionOptionPasswordOptionComplexity { /** * When all 4 character types are specified, determines if all or 3 of 4 are required. Possible values: `all`, `threeOfFour`. Default: `all`. */ characterTypeRule: string; /** * Required character types. Valid values: `uppercase`, `lowercase`, `number`, `special`. */ characterTypes: string[]; /** * Controls whether 3+ consecutive identical characters are allowed. Possible values: `allow`, `block`. Default: `allow`. */ identicalCharacters: string; /** * Controls behavior when the password exceeds 72 bytes. Possible values: `truncate`, `error`. Default: `error`. */ maxLengthExceeded: string; /** * Minimum password length. Must be between 1 and 72. Default: 15. */ minLength: number; /** * Controls whether sequential characters (abc, 123, etc.) are allowed. Possible values: `allow`, `block`. Default: `allow`. */ sequentialCharacters: string; } export interface GetConnectionOptionPasswordOptionDictionary { /** * Enables dictionary checking. */ active: boolean; /** * Custom list of disallowed terms. */ customs: string[]; /** * Default dictionary to use. Possible values: `en10k`, `en100k`. Default: `en100k`. */ default: string; } export interface GetConnectionOptionPasswordOptionHistory { /** * Enables password history checking. */ active: boolean; /** * Number of previous passwords to check against. Must be between 1 and 24. Default: 3. */ size: number; } export interface GetConnectionOptionPasswordOptionProfileData { /** * Prevents users from including profile data in passwords. */ active: boolean; /** * User profile fields to block from passwords. Maximum 12 items, each max 100 characters. */ blockedFields: string[]; } export interface GetConnectionOptionSigningKey { cert: string; key: string; } export interface GetConnectionOptionTotp { /** * Length of the one-time password. */ length: number; /** * Seconds between allowed generation of new passwords. */ timeStep: number; } export interface GetConnectionOptionValidation { /** * Specifies the `min` and `max` values of username length. */ usernames: outputs.GetConnectionOptionValidationUsername[]; } export interface GetConnectionOptionValidationUsername { max: number; min: number; } export interface GetConnectionProfileConnectionConfig { } export interface GetConnectionProfileCrossAppAccessResourceApp { /** * The Cross App Access resource app status configuration. */ statuses: outputs.GetConnectionProfileCrossAppAccessResourceAppStatus[]; } export interface GetConnectionProfileCrossAppAccessResourceAppStatus { /** * Status values organizations are allowed to set. */ allowedValues: string[]; /** * Default status value for organizations that don't have an explicit override. */ defaultValue: string; } export interface GetConnectionProfileOrganization { /** * Whether to assign membership on login. */ assignMembershipOnLogin: string; /** * Whether to show organization as a button. */ showAsButton: string; } export interface GetConnectionProfileStrategyOverride { /** * Strategy override configuration. */ ad: outputs.GetConnectionProfileStrategyOverrideAd; /** * Strategy override configuration. */ adfs: outputs.GetConnectionProfileStrategyOverrideAdfs; /** * Strategy override configuration. */ googleApps: outputs.GetConnectionProfileStrategyOverrideGoogleApps; /** * Strategy override configuration. */ oidc: outputs.GetConnectionProfileStrategyOverrideOidc; /** * Strategy override configuration. */ okta: outputs.GetConnectionProfileStrategyOverrideOkta; /** * Strategy override configuration. */ pingfederate: outputs.GetConnectionProfileStrategyOverridePingfederate; /** * Strategy override configuration. */ samlp: outputs.GetConnectionProfileStrategyOverrideSamlp; /** * Strategy override configuration. */ waad: outputs.GetConnectionProfileStrategyOverrideWaad; } export interface GetConnectionProfileStrategyOverrideAd { /** * Connection config for the strategy override. */ connectionConfig: outputs.GetConnectionProfileStrategyOverrideAdConnectionConfig; /** * Enabled features for the strategy override. */ enabledFeatures: string[]; } export interface GetConnectionProfileStrategyOverrideAdConnectionConfig { } export interface GetConnectionProfileStrategyOverrideAdfs { /** * Connection config for the strategy override. */ connectionConfig: outputs.GetConnectionProfileStrategyOverrideAdfsConnectionConfig; /** * Enabled features for the strategy override. */ enabledFeatures: string[]; } export interface GetConnectionProfileStrategyOverrideAdfsConnectionConfig { } export interface GetConnectionProfileStrategyOverrideGoogleApps { /** * Connection config for the strategy override. */ connectionConfig: outputs.GetConnectionProfileStrategyOverrideGoogleAppsConnectionConfig; /** * Enabled features for the strategy override. */ enabledFeatures: string[]; } export interface GetConnectionProfileStrategyOverrideGoogleAppsConnectionConfig { } export interface GetConnectionProfileStrategyOverrideOidc { /** * Connection config for the strategy override. */ connectionConfig: outputs.GetConnectionProfileStrategyOverrideOidcConnectionConfig; /** * Enabled features for the strategy override. */ enabledFeatures: string[]; } export interface GetConnectionProfileStrategyOverrideOidcConnectionConfig { } export interface GetConnectionProfileStrategyOverrideOkta { /** * Connection config for the strategy override. */ connectionConfig: outputs.GetConnectionProfileStrategyOverrideOktaConnectionConfig; /** * Enabled features for the strategy override. */ enabledFeatures: string[]; } export interface GetConnectionProfileStrategyOverrideOktaConnectionConfig { } export interface GetConnectionProfileStrategyOverridePingfederate { /** * Connection config for the strategy override. */ connectionConfig: outputs.GetConnectionProfileStrategyOverridePingfederateConnectionConfig; /** * Enabled features for the strategy override. */ enabledFeatures: string[]; } export interface GetConnectionProfileStrategyOverridePingfederateConnectionConfig { } export interface GetConnectionProfileStrategyOverrideSamlp { /** * Connection config for the strategy override. */ connectionConfig: outputs.GetConnectionProfileStrategyOverrideSamlpConnectionConfig; /** * Enabled features for the strategy override. */ enabledFeatures: string[]; } export interface GetConnectionProfileStrategyOverrideSamlpConnectionConfig { } export interface GetConnectionProfileStrategyOverrideWaad { /** * Connection config for the strategy override. */ connectionConfig: outputs.GetConnectionProfileStrategyOverrideWaadConnectionConfig; /** * Enabled features for the strategy override. */ enabledFeatures: string[]; } export interface GetConnectionProfileStrategyOverrideWaadConnectionConfig { } export interface GetConnectionScimConfigurationDefaultMapping { /** * The field location in the Auth0 schema. */ auth0: string; /** * The field location in the SCIM schema. */ scim: string; } export interface GetConnectionScimConfigurationMapping { /** * The field location in the Auth0 schema. */ auth0: string; /** * The field location in the SCIM schema. */ scim: string; } export interface GetCustomDomainCertificate { /** * Name of the certificate authority that issued the certificate. */ certificateAuthority: string; /** * Contains the error message if the provisioning process fails. */ errorMsg: string; /** * Specifies the date by which the certificate should be renewed. */ renewsBefore: string; /** * Indicates the current state of the certificate provisioning process. */ status: string; } export interface GetCustomDomainVerification { /** * Contains error message, if any, from the last DNS verification check. */ errorMsg: string; /** * Indicates the last time the domain was successfully verified. */ lastVerifiedAt: string; /** * Defines the list of domain verification methods used. */ methods: any[]; /** * Represents the current status of the domain verification process. */ status: string; } export interface GetCustomDomainsCustomDomain { /** * The Custom Domain certificate. */ certificates: outputs.GetCustomDomainsCustomDomainCertificate[]; /** * The HTTP header to fetch the client's IP address. Cannot be set on auth0Managed domains. */ customClientIpHeader: string; /** * Name of the custom domain. */ domain: string; /** * Metadata associated with the Custom Domain. Maximum of 10 metadata properties allowed. (EA only). */ domainMetadata: { [key: string]: string; }; /** * Indicates whether this custom domain is the default domain for the tenant */ isDefault: boolean; /** * Once the configuration status is `ready`, the DNS name of the Auth0 origin server that handles traffic for the custom domain. */ originDomainName: string; /** * Indicates whether this is a primary domain. */ primary: boolean; /** * Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not provided or set to null, the full domain will be used. */ relyingPartyIdentifier: string; /** * Configuration status for the custom domain. Options include `disabled`, `pending`, `pendingVerification`, `ready` and `failed`. */ status: string; /** * TLS policy for the custom domain. Available options are: `compatible` or `recommended`. Compatible includes TLS 1.0, 1.1, 1.2, and recommended only includes TLS 1.2. Cannot be set on selfManaged domains. */ tlsPolicy: string; /** * Provisioning type for the custom domain. Options include `auth0ManagedCerts` and `selfManagedCerts`. */ type: string; /** * Configuration settings for verification. */ verifications: outputs.GetCustomDomainsCustomDomainVerification[]; } export interface GetCustomDomainsCustomDomainCertificate { /** * Name of the certificate authority that issued the certificate. */ certificateAuthority: string; /** * Contains the error message if the provisioning process fails. */ errorMsg: string; /** * Specifies the date by which the certificate should be renewed. */ renewsBefore: string; /** * Indicates the current state of the certificate provisioning process. */ status: string; } export interface GetCustomDomainsCustomDomainVerification { /** * Contains error message, if any, from the last DNS verification check. */ errorMsg: string; /** * Indicates the last time the domain was successfully verified. */ lastVerifiedAt: string; /** * Defines the list of domain verification methods used. */ methods: any[]; /** * Represents the current status of the domain verification process. */ status: string; } export interface GetEventStreamActionConfiguration { /** * The ID of the Auth0 Action to use as the event stream destination. */ actionId: string; } export interface GetEventStreamEventbridgeConfiguration { awsAccountId: string; awsPartnerEventSource: string; awsRegion: string; } export interface GetEventStreamWebhookConfiguration { /** * Authorization details for the webhook endpoint. Supports `basic` authentication using `username` and `password`, `bearer` authentication using a `token`, or `customHeader` authentication using `headerKey` and `headerValue` (or `headerValueWo`). The appropriate fields must be set based on the chosen method. */ webhookAuthorizations: outputs.GetEventStreamWebhookConfigurationWebhookAuthorization[]; /** * The HTTPS endpoint that will receive the webhook events. Must be a valid, publicly accessible URL. */ webhookEndpoint: string; } export interface GetEventStreamWebhookConfigurationWebhookAuthorization { /** * The name of the HTTP header used for `customHeader` authentication. Required when `method` is `customHeader`. Returned by the API and stored in state. */ headerKey: string; /** * The secret value sent in the custom header. Required when `method` is `customHeader` and `headerValueWo` is not provided. **Note:** For better security, use `headerValueWo` to prevent storing the secret in state. */ headerValue: string; /** * The secret value sent in the custom header (write-only). Not stored in Terraform state. Bump `headerValueWoVersion` to rotate the secret. */ headerValueWo: string; /** * Version number for secret rotation. Update to trigger a new `headerValueWo` to be sent. */ headerValueWoVersion: number; /** * The authorization method used to secure the webhook endpoint. Can be `basic`, `bearer`, or `customHeader`. */ method: string; /** * The password for `basic` authentication. Required only when `method` is set to `basic`. **Note:** For better security, consider using `passwordWo` instead to prevent storing the password in Terraform state. */ password: string; /** * The password for `basic` authentication (write-only). This value is only available during resource creation and update, and is **not** stored in Terraform state. To change the password, update the `passwordWoVersion` attribute. Required only when `method` is set to `basic` and `password` is not provided. */ passwordWo: string; /** * Version number for password changes. Update this value to trigger a password change when using `passwordWo`. */ passwordWoVersion: number; /** * The token used for `bearer` authentication. Required only when `method` is set to `bearer`. **Note:** For better security, consider using `tokenWo` instead to prevent storing the token in Terraform state. */ token: string; /** * The token used for `bearer` authentication (write-only). This value is only available during resource creation and update, and is **not** stored in Terraform state. To change the token, update the `tokenWoVersion` attribute. Required only when `method` is set to `bearer` and `token` is not provided. */ tokenWo: string; /** * Version number for token changes. Update this value to trigger a token change when using `tokenWo`. */ tokenWoVersion: number; /** * The username for `basic` authentication. Required only when `method` is set to `basic`. */ username: string; } export interface GetExperimentAllocation { /** * Whether this allocation is the control variation. At most one allocation can be the control. */ isControl: boolean; /** * Whether this allocation is the fallback. Only for the segment strategy. */ isFallback: boolean; /** * The evaluation priority of this allocation. Only for the segment strategy. */ priority: number; /** * The segment targeted by this allocation. Only for the segment strategy. Omit for the fallback allocation. */ segmentId: string; /** * The name of the targeted segment. */ segmentName: string; /** * The snapshot of the segment. */ segmentSnapshot: string; /** * The ID of the feature flag variation assigned to this allocation. */ variationId: string; /** * The name of the assigned variation. */ variationName: string; /** * The snapshot of the variation. */ variationSnapshot: string; /** * The percentage weight of this allocation. Only for the percentage strategy. Omit when using levels. */ weight: number; } export interface GetExperimentFeatureFlagParameter { /** * Description of the parameter. */ description: string; /** * The key of the parameter. */ name: string; /** * The value type of the parameter. One of boolean, string, number, array, object */ type: string; /** * The default value of the parameter, as a string. For `type = "object"` or `type = "array"` supply a JSON-encoded string; for `boolean`/`number` supply the literal value as a string. */ value: string; } export interface GetExperimentFeatureFlagVariation { /** * Description of the variation. Must contain 3 to 1024 characters when set. */ description: string; /** * The name of the variation. Must be unique within the feature flag and contain 3 to 255 characters without surrounding whitespace. Changing the name deletes the variation and creates a new one with a new ID. */ name: string; /** * Parameter overrides for the variation. Omit for a control variation. */ overrides: outputs.GetExperimentFeatureFlagVariationOverride[]; } export interface GetExperimentFeatureFlagVariationOverride { /** * The name of a parameter on the feature flag. Each name can appear once. */ name: string; /** * The type of the parameter value. One of boolean, string, number, array, object. */ type: string; /** * The override value as a string. For object and array values, provide JSON; for boolean and number values, provide their literal text. */ value: string; } export interface GetExperimentSegmentRule { /** * Attribute conditions that must match. Set between 1 and 10 attributes, including each `anonymousSessionMetadata` block. At least one of `match` or `notMatch` is required per rule. */ matches: outputs.GetExperimentSegmentRuleMatch[]; /** * Attribute conditions that must not match. Set between 1 and 10 attributes, including each `anonymousSessionMetadata` block. At least one of `match` or `notMatch` is required per rule. */ notMatches: outputs.GetExperimentSegmentRuleNotMatch[]; } export interface GetExperimentSegmentRuleMatch { /** * Condition on a namespaced `anonymous_session_metadata.` attribute. Repeat the block once per key. Each key can appear only once per `match/not_match` block. */ anonymousSessionMetadatas: outputs.GetExperimentSegmentRuleMatchAnonymousSessionMetadata[]; /** * Condition on the `browser` attribute. Set exactly one operator. */ browsers: outputs.GetExperimentSegmentRuleMatchBrowser[]; /** * Condition on the `clientId` attribute. Set exactly one operator. */ clientIds: outputs.GetExperimentSegmentRuleMatchClientId[]; /** * Condition on the `connectionType` attribute. Set exactly one operator. */ connectionTypes: outputs.GetExperimentSegmentRuleMatchConnectionType[]; /** * Condition on the `connection` attribute. Set exactly one operator. */ connections: outputs.GetExperimentSegmentRuleMatchConnection[]; /** * Condition on the `country` attribute. Set exactly one operator. */ countries: outputs.GetExperimentSegmentRuleMatchCountry[]; /** * Condition on the `deviceType` attribute. Set exactly one operator. */ deviceTypes: outputs.GetExperimentSegmentRuleMatchDeviceType[]; /** * Condition on the `domain` attribute. Set exactly one operator. */ domains: outputs.GetExperimentSegmentRuleMatchDomain[]; /** * Condition on the `organizationId` attribute. Set exactly one operator. */ organizationIds: outputs.GetExperimentSegmentRuleMatchOrganizationId[]; /** * Condition on the `platform` attribute. Set exactly one operator. */ platforms: outputs.GetExperimentSegmentRuleMatchPlatform[]; /** * Condition on the `region` attribute. Set exactly one operator. */ regions: outputs.GetExperimentSegmentRuleMatchRegion[]; /** * Condition on the `userAgent` attribute. Set exactly one operator. */ userAgents: outputs.GetExperimentSegmentRuleMatchUserAgent[]; } export interface GetExperimentSegmentRuleMatchAnonymousSessionMetadata { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * The metadata key, without the `anonymous_session_metadata.` prefix. Between 1 and 255 characters, not blank. */ key: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleMatchBrowser { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleMatchClientId { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleMatchConnection { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleMatchConnectionType { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleMatchCountry { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleMatchDeviceType { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleMatchDomain { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleMatchOrganizationId { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleMatchPlatform { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleMatchRegion { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleMatchUserAgent { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleNotMatch { /** * Condition on a namespaced `anonymous_session_metadata.` attribute. Repeat the block once per key. Each key can appear only once per `match/not_match` block. */ anonymousSessionMetadatas: outputs.GetExperimentSegmentRuleNotMatchAnonymousSessionMetadata[]; /** * Condition on the `browser` attribute. Set exactly one operator. */ browsers: outputs.GetExperimentSegmentRuleNotMatchBrowser[]; /** * Condition on the `clientId` attribute. Set exactly one operator. */ clientIds: outputs.GetExperimentSegmentRuleNotMatchClientId[]; /** * Condition on the `connectionType` attribute. Set exactly one operator. */ connectionTypes: outputs.GetExperimentSegmentRuleNotMatchConnectionType[]; /** * Condition on the `connection` attribute. Set exactly one operator. */ connections: outputs.GetExperimentSegmentRuleNotMatchConnection[]; /** * Condition on the `country` attribute. Set exactly one operator. */ countries: outputs.GetExperimentSegmentRuleNotMatchCountry[]; /** * Condition on the `deviceType` attribute. Set exactly one operator. */ deviceTypes: outputs.GetExperimentSegmentRuleNotMatchDeviceType[]; /** * Condition on the `domain` attribute. Set exactly one operator. */ domains: outputs.GetExperimentSegmentRuleNotMatchDomain[]; /** * Condition on the `organizationId` attribute. Set exactly one operator. */ organizationIds: outputs.GetExperimentSegmentRuleNotMatchOrganizationId[]; /** * Condition on the `platform` attribute. Set exactly one operator. */ platforms: outputs.GetExperimentSegmentRuleNotMatchPlatform[]; /** * Condition on the `region` attribute. Set exactly one operator. */ regions: outputs.GetExperimentSegmentRuleNotMatchRegion[]; /** * Condition on the `userAgent` attribute. Set exactly one operator. */ userAgents: outputs.GetExperimentSegmentRuleNotMatchUserAgent[]; } export interface GetExperimentSegmentRuleNotMatchAnonymousSessionMetadata { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * The metadata key, without the `anonymous_session_metadata.` prefix. Between 1 and 255 characters, not blank. */ key: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleNotMatchBrowser { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleNotMatchClientId { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleNotMatchConnection { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleNotMatchConnectionType { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleNotMatchCountry { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleNotMatchDeviceType { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleNotMatchDomain { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleNotMatchOrganizationId { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleNotMatchPlatform { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleNotMatchRegion { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetExperimentSegmentRuleNotMatchUserAgent { /** * Values for the `contains` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ contains: string[]; /** * Values for the `endsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ endsWiths: string[]; /** * Value for the `exists` operator: `true` or `false`. Bare boolean values are accepted. */ exists: string; /** * Values for the `oneOf` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ oneOfs: string[]; /** * Values for the `startsWith` operator. Between 1 and 50 values, each up to 1024 characters. An empty list counts as not set. */ startsWiths: string[]; } export interface GetFormLanguage { /** * Default language for the form. */ default: string; /** * Primary language for the form. */ primary: string; } export interface GetFormMessage { /** * Custom message for the form. (JSON encoded) */ custom: string; /** * Error message for the form. (JSON encoded) */ errors: string; } export interface GetNetworkAclRule { /** * The action configuration for the Network ACL Rule. Only one action type (block, allow, log, or redirect) should be specified. */ actions: outputs.GetNetworkAclRuleAction[]; /** * When true, the rule unconditionally matches all traffic regardless of any other criteria. Mutually exclusive with match and not_match. */ matchAll: boolean; /** * The configuration for the Network ACL Rule */ matches: outputs.GetNetworkAclRuleMatch[]; /** * The configuration for the Network ACL Rule */ notMatches: outputs.GetNetworkAclRuleNotMatch[]; /** * The scope of the Network ACL Rule */ scope: string; } export interface GetNetworkAclRuleAction { /** * If true, allows the request. When using allow action, no other properties should be set. */ allow: boolean; /** * If true, blocks the request. When using block action, no other properties should be set. */ block: boolean; /** * If true, logs the request. When using log action, no other properties should be set. */ log: boolean; /** * If true, redirects the request. When using redirect action, redirectUri must also be specified. */ redirect: boolean; /** * The URI to redirect to when redirect is true. Required when redirect is true. Must be between 1 and 2000 characters. */ redirectUri: string; } export interface GetNetworkAclRuleMatch { /** * ASNs. Must contain between 1 and 10 unique items. */ asns: number[]; /** * Auth0-curated blocklists to match against. Allowed values are `auth0.low_reputation` and `auth0.icloud_relay_proxy`; the set is validated by the Management API and may grow. Requires the `advanced-breached-password-detection` entitlement and the `tenantAclCuratedBlocklists` feature flag to be enabled on the tenant. (EA Only) */ auth0Manageds: string[]; /** * Connecting IPv4 CIDRs. Must contain between 1 and 20 unique items. Can be IPv4 addresses or CIDR blocks. */ connectingIpv4Cidrs: string[]; /** * Connecting IPv6 CIDRs. Must contain between 1 and 20 unique items. Can be IPv6 addresses or CIDR blocks. */ connectingIpv6Cidrs: string[]; /** * Geo Country Codes. Must contain between 1 and 10 unique items. */ geoCountryCodes: string[]; /** * Geo Subdivision Codes. Must contain between 1 and 10 unique items. */ geoSubdivisionCodes: string[]; /** * Hostnames. Must contain between 1 and 20 unique items. */ hostnames: string[]; /** * Match requests that carry an HTTP Message Signature verified by one of the listed Network ACL keys. (EA Only) */ httpMessageSignatures: outputs.GetNetworkAclRuleMatchHttpMessageSignature[]; /** * IPv4 CIDRs. Must contain between 1 and 10 unique items. Can be IPv4 addresses or CIDR blocks. */ ipv4Cidrs: string[]; /** * IPv6 CIDRs. Must contain between 1 and 10 unique items. Can be IPv6 addresses or CIDR blocks. */ ipv6Cidrs: string[]; /** * JA3 Fingerprints. Must contain between 1 and 10 unique items. */ ja3Fingerprints: string[]; /** * JA4 Fingerprints. Must contain between 1 and 10 unique items. */ ja4Fingerprints: string[]; /** * User Agents. Must contain between 1 and 10 unique items. */ userAgents: string[]; } export interface GetNetworkAclRuleMatchHttpMessageSignature { /** * List of Network ACL key references. A request matches if its signature is verified by any of these keys. */ keys: outputs.GetNetworkAclRuleMatchHttpMessageSignatureKey[]; } export interface GetNetworkAclRuleMatchHttpMessageSignatureKey { /** * The ID of the referenced Network ACL key. */ id: string; } export interface GetNetworkAclRuleNotMatch { /** * ASNs. Must contain between 1 and 10 unique items. */ asns: number[]; /** * Auth0-curated blocklists to match against. Allowed values are `auth0.low_reputation` and `auth0.icloud_relay_proxy`; the set is validated by the Management API and may grow. Requires the `advanced-breached-password-detection` entitlement and the `tenantAclCuratedBlocklists` feature flag to be enabled on the tenant. (EA Only) */ auth0Manageds: string[]; /** * Connecting IPv4 CIDRs. Must contain between 1 and 20 unique items. Can be IPv4 addresses or CIDR blocks. */ connectingIpv4Cidrs: string[]; /** * Connecting IPv6 CIDRs. Must contain between 1 and 20 unique items. Can be IPv6 addresses or CIDR blocks. */ connectingIpv6Cidrs: string[]; /** * Geo Country Codes. Must contain between 1 and 10 unique items. */ geoCountryCodes: string[]; /** * Geo Subdivision Codes. Must contain between 1 and 10 unique items. */ geoSubdivisionCodes: string[]; /** * Hostnames. Must contain between 1 and 20 unique items. */ hostnames: string[]; /** * Match requests that carry an HTTP Message Signature verified by one of the listed Network ACL keys. (EA Only) */ httpMessageSignatures: outputs.GetNetworkAclRuleNotMatchHttpMessageSignature[]; /** * IPv4 CIDRs. Must contain between 1 and 10 unique items. Can be IPv4 addresses or CIDR blocks. */ ipv4Cidrs: string[]; /** * IPv6 CIDRs. Must contain between 1 and 10 unique items. Can be IPv6 addresses or CIDR blocks. */ ipv6Cidrs: string[]; /** * JA3 Fingerprints. Must contain between 1 and 10 unique items. */ ja3Fingerprints: string[]; /** * JA4 Fingerprints. Must contain between 1 and 10 unique items. */ ja4Fingerprints: string[]; /** * User Agents. Must contain between 1 and 10 unique items. */ userAgents: string[]; } export interface GetNetworkAclRuleNotMatchHttpMessageSignature { /** * List of Network ACL key references. A request matches if its signature is verified by any of these keys. */ keys: outputs.GetNetworkAclRuleNotMatchHttpMessageSignatureKey[]; } export interface GetNetworkAclRuleNotMatchHttpMessageSignatureKey { /** * The ID of the referenced Network ACL key. */ id: string; } export interface GetOrganizationBranding { /** * Color scheme used to customize the login pages. */ colors: { [key: string]: string; }; /** * URL of logo to display on login page. */ logoUrl: string; } export interface GetOrganizationClientsClient { /** * The type of the associated client application. */ appType: string; /** * The ID of the client (application) to associate with the organization. */ clientId: string; /** * The grant types enabled for the associated client. */ grantTypes: string[]; /** * Whether the associated client is a first-party client (`true`) or not (`false`). */ isFirstParty: boolean; /** * The URI of the associated client's logo. */ logoUri: string; /** * The name of the associated client. */ name: string; /** * How the associated client handles organizations during authentication. Available values are `deny`, `allow` or `require`. This is a read-only reflection of the client's own `organizationUsage` setting and is managed on the `auth0.Client` resource, not here. */ organizationUsage: string; /** * Whether this client is used for member access to the organization. An association starts out with this turned off and it has to be activated explicitly. */ useForMemberAccess: boolean; } export interface GetOrganizationConnection { /** * When `true`, all users that log in with this connection will be automatically granted membership in the organization. When `false`, users must be granted membership in the organization before logging in with this connection. */ assignMembershipOnLogin: boolean; /** * The ID of the enabled connection on the organization. */ connectionId: string; /** * Whether the connection is enabled for the organization. */ isEnabled: boolean; /** * Determines whether organization sign-up should be enabled for this organization connection. Only applicable for database connections. Note: `isSignupEnabled` can only be `true` if `assignMembershipOnLogin` is `true`. */ isSignupEnabled: boolean; /** * The access level for this organization connection. Can be `none`, `readonly`, `limited`, or `full`. */ organizationAccessLevel: string; /** * Name of the connection in the scope of this organization. */ organizationConnectionName: string; /** * Determines whether a connection should be displayed on this organization's login prompt. Only applicable for enterprise connections. */ showAsButton: boolean; } export interface GetOrganizationRoleGroupsGroup { /** * The ID of the connection the group belongs to, if it is a connection group. */ connectionId: string; /** * ISO 8601 timestamp when the group was created. */ createdAt: string; /** * The description of the group. */ description: string; /** * The external identifier of the group, often used for SCIM synchronization. */ externalId: string; /** * The unique identifier for the group. */ id: string; /** * The name of the group. */ name: string; /** * The ID of the organization the group belongs to, if it is an organization group. */ organizationId: string; /** * ISO 8601 timestamp when the group was last updated. */ updatedAt: string; } export interface GetOrganizationRoleMembersMember { /** * The email address of the user. */ email: string; /** * The name of the user. */ name: string; /** * The URL to a picture for the user. */ picture: string; /** * The ID of the user. */ userId: string; } export interface GetOrganizationTokenQuota { /** * The token quota configuration for client credentials. */ clientCredentials: outputs.GetOrganizationTokenQuotaClientCredential[]; } export interface GetOrganizationTokenQuotaClientCredential { /** * If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs. */ enforce: boolean; /** * Maximum number of issued tokens per day */ perDay: number; /** * Maximum number of issued tokens per hour */ perHour: number; } export interface GetOrganizationsOrganization { /** * How to style the login pages for this organization. */ brandings: outputs.GetOrganizationsOrganizationBranding[]; /** * The organization's association with the client passed as `includeClientAssociationFor`. Empty for organizations that have no association with that client (EA only). */ clients: outputs.GetOrganizationsOrganizationClient[]; /** * Friendly name of the organization. */ displayName: string; /** * Whether this organization's app entitlement is active (EA only). */ isAppEntitlementActive: boolean; /** * Metadata associated with the organization. */ metadata: { [key: string]: string; }; /** * The name of the organization. */ name: string; /** * The ID of the organization. */ organizationId: string; /** * Controls whether this organization can be used in user flows with third-party clients. Available values are `allow` or `block`. */ thirdPartyClientAccess: string; /** * The token quota configuration for this organization. */ tokenQuotas: outputs.GetOrganizationsOrganizationTokenQuota[]; } export interface GetOrganizationsOrganizationBranding { /** * Color scheme used to customize the login pages. */ colors: { [key: string]: string; }; /** * URL of logo to display on login page. */ logoUrl: string; } export interface GetOrganizationsOrganizationClient { /** * Whether organization members can log in via this client. */ useForMemberAccess: boolean; } export interface GetOrganizationsOrganizationTokenQuota { /** * The token quota configuration for client credentials. */ clientCredentials: outputs.GetOrganizationsOrganizationTokenQuotaClientCredential[]; } export interface GetOrganizationsOrganizationTokenQuotaClientCredential { /** * Whether the quota is enforced. */ enforce: boolean; /** * Maximum number of issued tokens per day. */ perDay: number; /** * Maximum number of issued tokens per hour. */ perHour: number; } export interface GetOutboundIpsChangelog { /** * Type of change (add or remove). */ action: string; /** * Date of the change (YYYY-MM-DD format). */ date: string; /** * List of IPv4 CIDR blocks affected by this change. */ ipv4Cidrs: string[]; /** * Region affected by the change. */ region: string; } export interface GetOutboundIpsRegion { /** * A list of IPv4 CIDR blocks for the region. */ ipv4Cidrs: string[]; /** * The code for the region (e.g., 'US', 'CA'). */ region: string; } export interface GetPagesChangePassword { /** * Indicates whether to use the custom Reset Password HTML (`true`) or the default Auth0 page (`false`). */ enabled: boolean; /** * Customized content for the Reset Password page. HTML format with supported [Liquid syntax](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers). */ html: string; } export interface GetPagesError { /** * Customized content for the Error page. HTML format with supported [Liquid syntax](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers). */ html: string; /** * Indicates whether to show the link to logs as part of the default error page. */ showLogLink: boolean; /** * URL to redirect to when an error occurs, instead of showing the default error page. */ url: string; } export interface GetPagesGuardianMfa { /** * Indicates whether to use the custom Guardian MFA HTML (`true`) or the default Auth0 page (`false`). */ enabled: boolean; /** * Customized content for the Guardian MFA page. HTML format with supported [Liquid syntax](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers). */ html: string; } export interface GetPagesLogin { /** * Indicates whether to use the custom Login page HTML (`true`) or the default Auth0 page (`false`). */ enabled: boolean; /** * Customized content for the Login page. HTML format with supported [Liquid syntax](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers). */ html: string; } export interface GetPhoneNotificationTemplateContent { /** * The body content of the phone notification template. */ bodies: outputs.GetPhoneNotificationTemplateContentBody[]; /** * The sender phone number for SMS or voice notifications. */ from: string; /** * The syntax of the phone notification template. */ syntax: string; } export interface GetPhoneNotificationTemplateContentBody { /** * The text content for SMS notifications. */ text: string; /** * The voice content for voice notifications. */ voice: string; } export interface GetPhoneProviderConfiguration { /** * Default sender subject as "from" when no other value is specified. */ defaultFrom: string; /** * Media set supported by a given provider to deliver a notification */ deliveryMethods: string[]; /** * Twilio Messaging Service SID */ mssid: string; /** * Twilio Account SID. */ sid: string; } export interface GetPhoneProviderCredential { /** * The Auth Token for the phone provider. */ authToken: string; } export interface GetPortalClient { /** * Client credentials using clientSecretPost authentication. */ clientSecretPosts: outputs.GetPortalClientClientSecretPost[]; } export interface GetPortalClientClientSecretPost { /** * The ID of the client. */ clientId: string; } export interface GetPortalCustomCode { /** * Code added to the page head. */ head: string; } export interface GetPortalNavigation { /** * Sidebar navigation for the portal. */ sidebars: outputs.GetPortalNavigationSidebar[]; } export interface GetPortalNavigationSidebar { /** * Sidebar components in display order. Only V2 links are supported. */ components: outputs.GetPortalNavigationSidebarComponent[]; } export interface GetPortalNavigationSidebarComponent { /** * A V2 link to an external URL. */ externalLinkV2s: outputs.GetPortalNavigationSidebarComponentExternalLinkV2[]; /** * A V2 link to a portal page. */ internalLinkV2s: outputs.GetPortalNavigationSidebarComponentInternalLinkV2[]; } export interface GetPortalNavigationSidebarComponentExternalLinkV2 { /** * The URL of the link. */ href: string; /** * The icon of the link. */ icon: string; /** * The label of the link. */ label: string; } export interface GetPortalNavigationSidebarComponentInternalLinkV2 { /** * The icon of the link. */ icon: string; /** * The label of the link. */ label: string; /** * The slug of the linked page. */ pageSlug: string; } export interface GetPortalPage { /** * The slug of the default page. */ default: string; /** * Standard pages in display order. */ standards: outputs.GetPortalPageStandard[]; } export interface GetPortalPageStandard { /** * Page components in display order. */ components: outputs.GetPortalPageStandardComponent[]; /** * The slug of the page. */ slug: string; /** * The title of the page. */ title: string; } export interface GetPortalPageStandardComponent { /** * A form component. */ forms: outputs.GetPortalPageStandardComponentForm[]; /** * An image component. */ mediaImages: outputs.GetPortalPageStandardComponentMediaImage[]; /** * An MFA management component. */ myAccountMfaManagements: outputs.GetPortalPageStandardComponentMyAccountMfaManagement[]; /** * A passkey management component. */ myAccountPasskeyManagements: outputs.GetPortalPageStandardComponentMyAccountPasskeyManagement[]; /** * An organization details edit component. */ myOrganizationDetailsEdits: outputs.GetPortalPageStandardComponentMyOrganizationDetailsEdit[]; /** * An organization domain table component. */ myOrganizationDomainTables: outputs.GetPortalPageStandardComponentMyOrganizationDomainTable[]; /** * An organization member management component. */ myOrganizationMemberManagements: outputs.GetPortalPageStandardComponentMyOrganizationMemberManagement[]; /** * A section containing up to 20 components. */ structureSections: outputs.GetPortalPageStandardComponentStructureSection[]; /** * A separator component. */ structureSeparators: outputs.GetPortalPageStandardComponentStructureSeparator[]; /** * A heading component. */ typographyHeadings: outputs.GetPortalPageStandardComponentTypographyHeading[]; /** * A rich text component. */ typographyRichTexts: outputs.GetPortalPageStandardComponentTypographyRichText[]; } export interface GetPortalPageStandardComponentForm { /** * The message shown after form completion. */ completionMessage: string; /** * The ID of the form. */ formId: string; } export interface GetPortalPageStandardComponentMediaImage { /** * The height of the image. */ height: number; /** * The position of the image. */ position: string; /** * The URL of the image. */ src: string; } export interface GetPortalPageStandardComponentMyAccountMfaManagement { } export interface GetPortalPageStandardComponentMyAccountPasskeyManagement { } export interface GetPortalPageStandardComponentMyOrganizationDetailsEdit { } export interface GetPortalPageStandardComponentMyOrganizationDomainTable { } export interface GetPortalPageStandardComponentMyOrganizationMemberManagement { } export interface GetPortalPageStandardComponentStructureSection { /** * Components in the section. Sections cannot be nested. */ children: outputs.GetPortalPageStandardComponentStructureSectionChild[]; /** * The description of the section. */ description: string; /** * The title of the section. */ title: string; /** * The section style. Can be `card` or `none`. */ variant: string; } export interface GetPortalPageStandardComponentStructureSectionChild { /** * A form component. */ forms: outputs.GetPortalPageStandardComponentStructureSectionChildForm[]; /** * An image component. */ mediaImages: outputs.GetPortalPageStandardComponentStructureSectionChildMediaImage[]; /** * An MFA management component. */ myAccountMfaManagements: outputs.GetPortalPageStandardComponentStructureSectionChildMyAccountMfaManagement[]; /** * A passkey management component. */ myAccountPasskeyManagements: outputs.GetPortalPageStandardComponentStructureSectionChildMyAccountPasskeyManagement[]; /** * An organization details edit component. */ myOrganizationDetailsEdits: outputs.GetPortalPageStandardComponentStructureSectionChildMyOrganizationDetailsEdit[]; /** * An organization domain table component. */ myOrganizationDomainTables: outputs.GetPortalPageStandardComponentStructureSectionChildMyOrganizationDomainTable[]; /** * An organization member management component. */ myOrganizationMemberManagements: outputs.GetPortalPageStandardComponentStructureSectionChildMyOrganizationMemberManagement[]; /** * A separator component. */ structureSeparators: outputs.GetPortalPageStandardComponentStructureSectionChildStructureSeparator[]; /** * A heading component. */ typographyHeadings: outputs.GetPortalPageStandardComponentStructureSectionChildTypographyHeading[]; /** * A rich text component. */ typographyRichTexts: outputs.GetPortalPageStandardComponentStructureSectionChildTypographyRichText[]; } export interface GetPortalPageStandardComponentStructureSectionChildForm { /** * The message shown after form completion. */ completionMessage: string; /** * The ID of the form. */ formId: string; } export interface GetPortalPageStandardComponentStructureSectionChildMediaImage { /** * The height of the image. */ height: number; /** * The position of the image. */ position: string; /** * The URL of the image. */ src: string; } export interface GetPortalPageStandardComponentStructureSectionChildMyAccountMfaManagement { } export interface GetPortalPageStandardComponentStructureSectionChildMyAccountPasskeyManagement { } export interface GetPortalPageStandardComponentStructureSectionChildMyOrganizationDetailsEdit { } export interface GetPortalPageStandardComponentStructureSectionChildMyOrganizationDomainTable { } export interface GetPortalPageStandardComponentStructureSectionChildMyOrganizationMemberManagement { } export interface GetPortalPageStandardComponentStructureSectionChildStructureSeparator { /** * The text of the separator. */ text: string; /** * The separator style. */ variant: string; } export interface GetPortalPageStandardComponentStructureSectionChildTypographyHeading { /** * The description below the heading. */ description: string; /** * The heading text. */ title: string; } export interface GetPortalPageStandardComponentStructureSectionChildTypographyRichText { /** * The HTML content. */ content: string; } export interface GetPortalPageStandardComponentStructureSeparator { /** * The text of the separator. */ text: string; /** * The separator style. */ variant: string; } export interface GetPortalPageStandardComponentTypographyHeading { /** * The description below the heading. */ description: string; /** * The heading text. */ title: string; } export interface GetPortalPageStandardComponentTypographyRichText { /** * The HTML content. */ content: string; } export interface GetPromptScreenPartialsScreenPartial { insertionPoints: outputs.GetPromptScreenPartialsScreenPartialInsertionPoint[]; /** * The name of the screen associated with the partials */ screenName: string; } export interface GetPromptScreenPartialsScreenPartialInsertionPoint { /** * Content that goes inside the form */ formContent: string; /** * Content that goes at the end of the form. */ formContentEnd: string; /** * Content that goes at the start of the form. */ formContentStart: string; /** * Footer content for the end of the footer. */ formFooterEnd: string; /** * Footer content for the start of the footer. */ formFooterStart: string; /** * Actions that go at the end of secondary actions. */ secondaryActionsEnd: string; /** * Actions that go at the start of secondary actions. */ secondaryActionsStart: string; } export interface GetPromptScreenRendererFilter { /** * An array of clients (applications) identified by id or a metadata key/value pair. Entity Limit: 25. */ clients: string; /** * An array of domains identified by id or a metadata key/value pair. Entity Limit: 25. */ domains: string; /** * Type of match to apply. Options: `includesAny`, `excludesAny`. */ matchType: string; /** * An array of organizations identified by id or a metadata key/value pair. Entity Limit: 25. */ organizations: string; } export interface GetRateLimitPoliciesRateLimitPolicy { /** * The throttling configuration applied when the rate limit is reached. (EA only) */ configurations: outputs.GetRateLimitPoliciesRateLimitPolicyConfiguration[]; /** * The consumer category the policy applies to. Valid values are: [client] (EA Only) */ consumer: string; /** * Identifier or category within the consumer to which the policy applies. Supported values: `client_id:`, `client_id:`, `cimdClients`, `thirdPartyClients`, or `default`. (EA only) */ consumerSelector: string; /** * The date and time when the rate limit policy was created. */ createdAt: string; /** * The ID of the Rate Limit Policy. (EA only) */ id: string; /** * The resource the policy applies to. Valid values are: [oauthAuthenticationApi] (EA Only) */ resource: string; /** * The date and time when the rate limit policy was last updated. */ updatedAt: string; } export interface GetRateLimitPoliciesRateLimitPolicyConfiguration { /** * Action to take when the rate limit is exceeded. Valid values are: [allow block log redirect] (EA only) */ action: string; /** * Maximum number of requests allowed in a single window (0-10000). Required and only valid for the `block`, `log`, and `redirect` actions. (EA only) */ limit: number; /** * HTTPS URI to redirect to when the rate limit is exceeded. Required and only valid for the `redirect` action. (EA only) */ redirectUri: string; } export interface GetRateLimitPolicyConfiguration { /** * Action to take when the rate limit is exceeded. Valid values are: [allow block log redirect] (EA only) */ action: string; /** * Maximum number of requests allowed in a single window (0-10000). Required and only valid for the `block`, `log`, and `redirect` actions. (EA only) */ limit: number; /** * HTTPS URI to redirect to when the rate limit is exceeded. Required and only valid for the `redirect` action. (EA only) */ redirectUri: string; } export interface GetResourceServerAccessToken { /** * Configuration for mapping claims into the access tokens issued for this resource server. (EA only) */ claimsMappings: outputs.GetResourceServerAccessTokenClaimsMapping[]; } export interface GetResourceServerAccessTokenClaimsMapping { /** * Custom claims to include in the access tokens issued for this resource server. Maximum of 20 claims. Setting an empty list clears the custom claims on the API. (EA only) */ customClaims: outputs.GetResourceServerAccessTokenClaimsMappingCustomClaim[]; } export interface GetResourceServerAccessTokenClaimsMappingCustomClaim { /** * Expression used to resolve the claim value, given as a dot-path read from the request context (for example `anonymous_session.metadata.country`). */ expression: string; /** * Name of the claim to emit in the access token. Reserved OIDC/JWT claim names are not allowed. */ name: string; } export interface GetResourceServerAuthorizationDetail { /** * Disable authorization details. */ disable: boolean; /** * Type of authorization details. */ type: string; } export interface GetResourceServerAuthorizationPolicy { /** * Identifier of the authorization policy. */ policyId: string; } export interface GetResourceServerProofOfPossession { /** * Disable proof-of-possession. */ disable: boolean; /** * Mechanism used for proof-of-possession. `mtls` or `dpop` is supported. */ mechanism: string; /** * Indicates whether proof-of-possession is required with this resource server. */ required: boolean; /** * Specifies which client types require Proof-of-Possession`allClients` or `publicClients` is supported. */ requiredFor: string; } export interface GetResourceServerScope { /** * Description of the permission (scope). */ description: string; /** * Name of the permission (scope). Examples include `read:appointments` or `delete:appointments`. */ name: string; } export interface GetResourceServerSubjectTypeAuthorization { /** * Anonymous user authorization policies for the resource server. (EA only) */ anonymousUsers: outputs.GetResourceServerSubjectTypeAuthorizationAnonymousUser[]; /** * Client authorization policies for the resource server. */ clients: outputs.GetResourceServerSubjectTypeAuthorizationClient[]; /** * User authorization policies for the resource server. */ users: outputs.GetResourceServerSubjectTypeAuthorizationUser[]; } export interface GetResourceServerSubjectTypeAuthorizationAnonymousUser { /** * Anonymous user flows policy. One of `denyAll`, `requireClientGrant`. Defaults to `denyAll` (EA only) */ policy: string; } export interface GetResourceServerSubjectTypeAuthorizationClient { /** * Client flows policy. One of `denyAll`, `requireClientGrant`. */ policy: string; } export interface GetResourceServerSubjectTypeAuthorizationUser { /** * User flows policy. One of `allowAll`, `denyAll`, `requireClientGrant`. */ policy: string; } export interface GetResourceServerTokenEncryption { /** * Disable token encryption. */ disable: boolean; /** * Authorization details for this resource server. */ encryptionKeys: outputs.GetResourceServerTokenEncryptionEncryptionKey[]; /** * Format of the token encryption. Only `compact-nested-jwe` is supported. */ format: string; } export interface GetResourceServerTokenEncryptionEncryptionKey { /** * Algorithm used to encrypt the token. */ algorithm: string; /** * Key ID. */ kid: string; /** * Name of the encryption key. */ name: string; /** * PEM-formatted public key. Must be JSON escaped. */ pem: string; } export interface GetRolePermission { /** * Description of the permission. */ description: string; /** * Name of the permission (scope) configured on the resource server (API). */ name: string; /** * Unique identifier for the resource server (API). */ resourceServerIdentifier: string; /** * Name of resource server (API) that the permission is associated with. */ resourceServerName: string; } export interface GetSelfServiceProfileBranding { /** * Configuration settings for colors for branding. */ colors: outputs.GetSelfServiceProfileBrandingColor[]; /** * URL of logo to display on login page. */ logoUrl: string; } export interface GetSelfServiceProfileBrandingColor { /** * Primary button background color in hexadecimal. */ primary: string; } export interface GetSelfServiceProfileUserAttribute { /** * A human readable description of the attribute. */ description: string; /** * Indicates if this attribute is optional or if it has to be provided by the customer for the application to function. */ isOptional: boolean; /** * Attribute’s name on Auth0 side */ name: string; } export interface GetSigningKeysSigningKey { /** * The public certificate of the signing key. */ cert: string; /** * True if the key is the the current key. */ current: boolean; /** * The cert fingerprint. */ fingerprint: string; /** * The key ID of the signing key. */ kid: string; /** * True if the key is the the next key. */ next: boolean; /** * The public certificate of the signing key in PKCS7 format. */ pkcs7: string; /** * True if the key is the the previous key. */ previous: boolean; /** * True if the key is revoked. */ revoked: boolean; /** * The cert thumbprint. */ thumbprint: string; } export interface GetTenantCountryCode { /** * List of ISO 3166-1 alpha-2 country codes. */ lists: string[]; /** * Whether the list is an allow-list or deny-list. Available options: `allow`, `deny`. */ mode: string; } export interface GetTenantDefaultTokenQuota { /** * The token quota configuration. */ clients: outputs.GetTenantDefaultTokenQuotaClient[]; /** * The token quota configuration. */ organizations: outputs.GetTenantDefaultTokenQuotaOrganization[]; } export interface GetTenantDefaultTokenQuotaClient { /** * The token quota configuration for client credentials. */ clientCredentials: outputs.GetTenantDefaultTokenQuotaClientClientCredential[]; } export interface GetTenantDefaultTokenQuotaClientClientCredential { /** * If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs. */ enforce: boolean; /** * Maximum number of issued tokens per day */ perDay: number; /** * Maximum number of issued tokens per hour */ perHour: number; } export interface GetTenantDefaultTokenQuotaOrganization { /** * The token quota configuration for client credentials. */ clientCredentials: outputs.GetTenantDefaultTokenQuotaOrganizationClientCredential[]; } export interface GetTenantDefaultTokenQuotaOrganizationClientCredential { /** * If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs. */ enforce: boolean; /** * Maximum number of issued tokens per day */ perDay: number; /** * Maximum number of issued tokens per hour */ perHour: number; } export interface GetTenantErrorPage { /** * Custom Error HTML (Liquid syntax is supported) */ html: string; /** * Whether to show the link to log as part of the default error page (true, default) or not to show the link (false). */ showLogLink: boolean; /** * URL to redirect to when an error occurs instead of showing the default error page */ url: string; } export interface GetTenantFlag { /** * Whether the legacy delegation endpoint will be enabled for your account (true) or not available (false). */ allowLegacyDelegationGrantTypes: boolean; /** * Whether the legacy `auth/ro` endpoint (used with resource owner password and passwordless features) will be enabled for your account (true) or not available (false). */ allowLegacyRoGrantTypes: boolean; /** * If enabled, customers can use Tokeninfo Endpoint, otherwise they can not use it. */ allowLegacyTokeninfoEndpoint: boolean; /** * Enables new insights activity page view. */ dashboardInsightsView: boolean; /** * Enables beta access to log streaming changes. */ dashboardLogStreamsNext: boolean; /** * Indicates whether classic Universal Login prompts include additional security headers to prevent clickjacking. */ disableClickjackProtectionHeaders: boolean; /** * Disables SAML fields map fix for bad mappings with repeated attributes. */ disableFieldsMapFix: boolean; /** * If true, SMS phone numbers will not be obfuscated in Management API GET calls. */ disableManagementApiSmsObfuscation: boolean; /** * If enabled, users will be presented with an email verification prompt during their first login when using Azure AD or ADFS connections. */ enableAdfsWaadEmailVerification: boolean; /** * Indicates whether the APIs section is enabled for the tenant. */ enableApisSection: boolean; /** * Indicates whether all current connections should be enabled when a new client is created. */ enableClientConnections: boolean; /** * Indicates whether the tenant allows custom domains in emails. Before enabling this flag, you must have a custom domain with status: `ready`. */ enableCustomDomainInEmails: boolean; /** * Indicates whether the tenant allows dynamic client registration. */ enableDynamicClientRegistration: boolean; /** * Whether ID tokens can be used to authorize some types of requests to API v2 (true) or not (false). */ enableIdtokenApi2: boolean; /** * Indicates whether to use the older v2 legacy logs search. */ enableLegacyLogsSearchV2: boolean; /** * Whether ID tokens and the userinfo endpoint includes a complete user profile (true) or only OpenID Connect claims (false). */ enableLegacyProfile: boolean; /** * Indicates whether advanced API Authorization scenarios are enabled. */ enablePipeline2: boolean; /** * Indicates whether the public sign up process shows a `userExists` error if the user already exists. Note: the Auth0 Dashboard toggle **Use a generic response in public signup API error message** shows the inverse of this value. */ enablePublicSignupUserExistsError: boolean; /** * Flag indicating whether users will not be prompted to confirm log in before SSO redirection. This flag applies to existing tenants only; new tenants have it enforced as true. */ enableSso: boolean; /** * Used to allow users to pick which factor to enroll with from the list of available MFA factors. */ mfaShowFactorListOnEnrollment: boolean; /** * Do not Publish Enterprise Connections Information with IdP domains on the lock configuration file. Note: the Auth0 Dashboard toggle **Enable Publishing of Enterprise Connections Information with IdP domains** shows the inverse of this value. */ noDiscloseEnterpriseConnections: boolean; /** * Remove `alg` from jwks(JSON Web Key Sets). */ removeAlgFromJwks: boolean; /** * This Flag is not supported by the Auth0 Management API and will be removed in the next major release. */ requirePushedAuthorizationRequests: boolean; /** * Delete underlying grant when a refresh token is revoked via the Authentication API. */ revokeRefreshTokenGrant: boolean; /** * Indicates whether to use scope descriptions for consent. */ useScopeDescriptionsForConsent: boolean; } export interface GetTenantMtl { /** * Disable mTLS settings. */ disable: boolean; /** * Enable mTLS endpoint aliases. */ enableEndpointAliases: boolean; } export interface GetTenantOidcLogout { /** * Enable the endSessionEndpoint URL in the .well-known discovery configuration. */ rpLogoutEndSessionEndpointDiscovery: boolean; } export interface GetTenantSession { /** * Anonymous Sessions settings for the tenant. (EA only) */ anonymouses: outputs.GetTenantSessionAnonymouse[]; /** * When active, users will be presented with a consent prompt to confirm the logout request if the request is not trustworthy. Turn off the consent prompt to bypass user confirmation. */ oidcLogoutPromptEnabled: boolean; } export interface GetTenantSessionAnonymouse { /** * Whether anonymous session requests return the `auth0Anon` cookie. (EA only) */ activateCookie: boolean; /** * Number of minutes during which an anonymous session will stay valid. Minimum 1, maximum 525600. (EA only) */ lifetimeInMinutes: number; } export interface GetTenantSessionCooky { /** * Behavior of tenant session cookie. Accepts either "persistent" or "non-persistent". */ mode: string; } export interface GetUserAttributeProfileUserAttribute { /** * The Auth0 mapping for the user attribute. */ auth0Mapping: string; /** * Description of the user attribute. */ description: string; /** * Display label for the user attribute. */ label: string; /** * Name of the user attribute. */ name: string; /** * The OIDC mapping configuration for the user attribute. */ oidcMappings: outputs.GetUserAttributeProfileUserAttributeOidcMapping[]; /** * Whether the attribute is required in the profile. */ profileRequired: boolean; /** * SAML mapping override for this strategy. */ samlMappings: string[]; /** * The SCIM mapping for the user attribute. */ scimMapping: string; /** * Strategy-specific overrides for user attribute mapping. */ strategyOverrides: outputs.GetUserAttributeProfileUserAttributeStrategyOverride[]; } export interface GetUserAttributeProfileUserAttributeOidcMapping { /** * Display name for the OIDC mapping. */ displayName: string; /** * The OIDC mapping field. */ mapping: string; } export interface GetUserAttributeProfileUserAttributeStrategyOverride { /** * OIDC mapping override for this strategy. */ oidcMappings: outputs.GetUserAttributeProfileUserAttributeStrategyOverrideOidcMapping[]; /** * SAML mapping override for this strategy. */ samlMappings: string[]; /** * SCIM mapping override for this strategy. */ scimMapping: string; /** * The strategy name (e.g., 'oidc', 'samlp', 'ad', etc.). */ strategy: string; } export interface GetUserAttributeProfileUserAttributeStrategyOverrideOidcMapping { /** * Display name for the OIDC mapping. */ displayName: string; /** * The OIDC mapping field. */ mapping: string; } export interface GetUserAttributeProfileUserId { /** * The OIDC mapping for the user ID. */ oidcMapping: string; /** * The SAML mapping for the user ID. */ samlMappings: string[]; /** * The SCIM mapping for the user ID. */ scimMapping: string; /** * Strategy-specific overrides for user ID mapping. */ strategyOverrides: outputs.GetUserAttributeProfileUserIdStrategyOverride[]; } export interface GetUserAttributeProfileUserIdStrategyOverride { /** * OIDC mapping override for this strategy. */ oidcMapping: string; /** * SAML mapping override for this strategy. */ samlMappings: string[]; /** * SCIM mapping override for this strategy. */ scimMapping: string; /** * The strategy name (e.g., 'oidc', 'samlp', 'ad', etc.). */ strategy: string; } export interface GetUserConnectedAccountsConnectedAccount { /** * The access type for the connected account. */ accessType: string; /** * The name of the connection associated with the account. */ connection: string; /** * The unique identifier of the connection associated with the account. */ connectionId: string; /** * ISO 8601 timestamp when the connected account was created. */ createdAt: string; /** * ISO 8601 timestamp when the connected account expires. Empty string if not set. */ expiresAt: string; /** * The unique identifier for the connected account. */ id: string; /** * The identifier of the organization associated with the connected account. Empty string if not set. */ organizationId: string; /** * The scopes granted for this connected account. */ scopes: string[]; /** * The authentication strategy used by the connection. */ strategy: string; } export interface GetUserOrganizationsOrganization { /** * How to style the login pages for this organization. */ brandings: outputs.GetUserOrganizationsOrganizationBranding[]; /** * Friendly name of the organization. */ displayName: string; /** * Whether this organization's app entitlement is active (EA only). */ isAppEntitlementActive: boolean; /** * Metadata associated with the organization. */ metadata: { [key: string]: string; }; /** * The name of the organization. */ name: string; /** * The ID of the organization. */ organizationId: string; /** * Controls whether this organization can be used in user flows with third-party clients. Available values are `allow` or `block`. */ thirdPartyClientAccess: string; /** * The token quota configuration for this organization. */ tokenQuotas: outputs.GetUserOrganizationsOrganizationTokenQuota[]; } export interface GetUserOrganizationsOrganizationBranding { /** * Color scheme used to customize the login pages. */ colors: { [key: string]: string; }; /** * URL of logo to display on login page. */ logoUrl: string; } export interface GetUserOrganizationsOrganizationTokenQuota { /** * The token quota configuration for client credentials. */ clientCredentials: outputs.GetUserOrganizationsOrganizationTokenQuotaClientCredential[]; } export interface GetUserOrganizationsOrganizationTokenQuotaClientCredential { /** * Whether the quota is enforced. */ enforce: boolean; /** * Maximum number of issued tokens per day. */ perDay: number; /** * Maximum number of issued tokens per hour. */ perHour: number; } export interface GetUserPermission { /** * Description of the permission. */ description: string; /** * Name of the permission. */ name: string; /** * Resource server identifier associated with the permission. */ resourceServerIdentifier: string; /** * Name of resource server that the permission is associated with. */ resourceServerName: string; } export interface GuardianDuo { /** * Indicates whether Duo MFA is enabled. */ enabled: boolean; /** * Duo API Hostname, see the Duo documentation for more details on Duo setup. */ hostname?: string; /** * Duo client ID, see the Duo documentation for more details on Duo setup. */ integrationKey?: string; /** * Duo client secret, see the Duo documentation for more details on Duo setup. */ secretKey?: string; } export interface GuardianEmailSettings { /** * The OTP expiration time in seconds. Defaults to `300` (5 minutes). */ otpExpirationTime: number; /** * The length of the OTP code. Defaults to `6`. */ otpLength: number; } export interface GuardianPhone { /** * Indicates whether Phone MFA is enabled. */ enabled: boolean; /** * Message types to use, array of `sms` and/or `voice`. Adding both to the array should enable the user to choose. */ messageTypes?: string[]; /** * Options for the various providers. This block requires `phoneConsolidatedExperience` to be `false` on the `auth0.Tenant`. * * @deprecated This field is deprecated in favor of the Unified Phone Experience. Use`auth0.PhoneProvider` resource instead. See the migration guide: https://auth0.com/docs/customize/phone-messages/unified-phone/migrate-to-unified-phone-experience-with-terraform. */ options: outputs.GuardianPhoneOptions; /** * Provider to use, one of `auth0`, `twilio` or `phone-message-hook`. Selecting `phone-message-hook` will require a Phone Message Action to be created before. [Learn how](https://auth0.com/docs/customize/actions/flows-and-triggers/send-phone-message-flow). This field requires `phoneConsolidatedExperience` to be `false` on the `auth0.Tenant`. * * @deprecated This field is deprecated in favor of the Unified Phone Experience. Use`auth0.PhoneProvider` resource instead. See the migration guide: https://auth0.com/docs/customize/phone-messages/unified-phone/migrate-to-unified-phone-experience-with-terraform. */ provider?: string; } export interface GuardianPhoneOptions { /** * AuthToken for your Twilio account. */ authToken?: string; /** * This message will be sent whenever a user enrolls a new device for the first time using MFA. Supports Liquid syntax, see [Auth0 docs](https://auth0.com/docs/customize/customize-sms-or-voice-messages). */ enrollmentMessage?: string; /** * Phone number to use as the sender. */ from?: string; /** * Messaging service SID. */ messagingServiceSid?: string; /** * SID for your Twilio account. */ sid?: string; /** * This message will be sent whenever a user logs in after the enrollment. Supports Liquid syntax, see [Auth0 docs](https://auth0.com/docs/customize/customize-sms-or-voice-messages). */ verificationMessage?: string; } export interface GuardianPhoneSettings { /** * The OTP expiration time in seconds. Defaults to `300` (5 minutes). */ otpExpirationTime: number; /** * The length of the OTP code. Defaults to `6`. */ otpLength: number; } export interface GuardianPush { /** * Configuration for Amazon SNS. */ amazonSns: outputs.GuardianPushAmazonSns; /** * Configuration for the Guardian Custom App. */ customApp: outputs.GuardianPushCustomApp; /** * Configuration for the Apple Push Notification service (APNs) settings. */ directApns: outputs.GuardianPushDirectApns; /** * Configuration for Firebase Cloud Messaging (FCM) settings. */ directFcm: outputs.GuardianPushDirectFcm; /** * Indicates whether Push MFA is enabled. */ enabled: boolean; /** * Provider to use, one of `direct`, `guardian`, `sns`. */ provider?: string; } export interface GuardianPushAmazonSns { /** * Your AWS Access Key ID. */ awsAccessKeyId: string; /** * Your AWS application's region. */ awsRegion: string; /** * Your AWS Secret Access Key. */ awsSecretAccessKey: string; /** * The Amazon Resource Name for your Apple Push Notification Service. */ snsApnsPlatformApplicationArn: string; /** * The Amazon Resource Name for your Firebase Cloud Messaging Service. */ snsGcmPlatformApplicationArn: string; } export interface GuardianPushCustomApp { /** * Custom Application Name. */ appName?: string; /** * Apple App Store URL. Must be HTTPS or an empty string. */ appleAppLink?: string; /** * Google Store URL. Must be HTTPS or an empty string. */ googleAppLink?: string; } export interface GuardianPushDirectApns { /** * The Apple Push Notification service Bundle ID. */ bundleId: string; /** * Indicates whether the Apple Push Notification service is enabled. */ enabled: boolean; /** * The base64 encoded certificate in P12 format. */ p12: string; /** * Set to true to use the sandbox iOS app environment, otherwise set to false to use the production iOS app environment. */ sandbox: boolean; } export interface GuardianPushDirectFcm { /** * The Firebase Cloud Messaging Server Key. For security purposes, we don’t retrieve your existing FCM server key to check for drift. */ serverKey: string; } export interface GuardianSettings { /** * Determines whether to display the "Remember me" checkbox on the MFA prompt in Universal Login. Defaults to `true`. */ displayRememberMeCheckbox: boolean; /** * Duration of inactivity (seconds) after which the user will be prompted for MFA. Cannot exceed the overall timeout. Defaults to `604800` (7 days). */ mfaSessionInactivityTimeout: number; /** * Maximum duration (seconds) after which the user will be prompted for MFA regardless of activity. Defaults to `2592000` (30 days). */ mfaSessionOverallTimeout: number; /** * Determines the default state of the "Remember Me" checkbox on the MFA prompt in Universal Login. Defaults to `false`. */ rememberMeDefaultValue: boolean; } export interface GuardianWebauthnPlatform { /** * Indicates whether WebAuthn with FIDO Device Biometrics MFA is enabled. */ enabled: boolean; /** * The Relying Party is the domain for which the WebAuthn keys will be issued, set to `true` if you are customizing the identifier. */ overrideRelyingParty: boolean; /** * The Relying Party should be a suffix of the custom domain. */ relyingPartyIdentifier: string; } export interface GuardianWebauthnRoaming { /** * Indicates whether WebAuthn with FIDO Security Keys MFA is enabled. */ enabled: boolean; /** * The Relying Party is the domain for which the WebAuthn keys will be issued, set to `true` if you are customizing the identifier. */ overrideRelyingParty: boolean; /** * The Relying Party should be a suffix of the custom domain. */ relyingPartyIdentifier: string; /** * User verification, one of `discouraged`, `preferred` or `required`. */ userVerification: string; } export interface LogStreamPiiConfig { /** * The algorithm to use for PII handling. Currently, only `xxhash` is supported. */ algorithm?: string; logFields: string[]; /** * The method to use for PII handling. Options are `hash` or `mask`. */ method?: string; } export interface LogStreamSink { /** * The AWS Account ID. */ awsAccountId?: string; /** * Name of the Partner Event Source to be used with AWS. Generally generated by Auth0 and passed to AWS, so this should be an output attribute. */ awsPartnerEventSource: string; /** * The region in which the EventBridge event source will be created. Possible values: `ap-east-1`, `ap-northeast-1`, `ap-northeast-2`, `ap-northeast-3`, `ap-south-1`, `ap-southeast-1`, `ap-southeast-2`, `ca-central-1`, `cn-north-1`, `cn-northwest-1`, `eu-central-1`, `eu-north-1`, `eu-west-1`, `eu-west-2`, `eu-west-3`, `me-south-1`, `sa-east-1`, `us-gov-east-1`, `us-gov-west-1`, `us-east-1`, `us-east-2`, `us-west-1`, `us-west-2`. */ awsRegion?: string; /** * Name of the Partner Topic to be used with Azure. Generally should not be specified. */ azurePartnerTopic: string; /** * The Azure region code. Possible values: `australiacentral`, `australiaeast`, `australiasoutheast`, `brazilsouth`, `canadacentral`, `canadaeast`, `centralindia`, `centralus`, `eastasia`, `eastus`, `eastus2`, `francecentral`, `germanywestcentral`, `japaneast`, `japanwest`, `koreacentral`, `koreasouth`, `northcentralus`, `northeurope`, `norwayeast`, `southafricanorth`, `southcentralus`, `southeastasia`, `southindia`, `switzerlandnorth`, `uaenorth`, `uksouth`, `ukwest`, `westcentralus`, `westeurope`, `westindia`, `westus`, `westus2`. */ azureRegion?: string; /** * The Azure EventGrid resource group which allows you to manage all Azure assets within one subscription. */ azureResourceGroup?: string; /** * The unique alphanumeric string that identifies your Azure subscription. */ azureSubscriptionId?: string; /** * The Datadog API key. **Note:** For better security, consider using `datadogApiKeyWo` instead. */ datadogApiKey?: string; /** * **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. * The Datadog API key (write-only). This value is **not** stored in Terraform state. */ datadogApiKeyWo?: string; /** * Version number for `datadogApiKeyWo`. Must be a positive integer (starting at `1`). Increment this value to trigger an API key change when using `datadogApiKeyWo`. */ datadogApiKeyWoVersion?: number; /** * The Datadog region. Possible values: `us`, `eu`, `us3`, `us5`. */ datadogRegion?: string; /** * Sent in the HTTP "Authorization" header with each request. */ httpAuthorization?: string; /** * The format of data sent over HTTP. Options are "JSONLINES", "JSONARRAY" or "JSONOBJECT" */ httpContentFormat: string; /** * The "Content-Type" header to send over HTTP. Common value is "application/json". */ httpContentType?: string; /** * Additional HTTP headers to be included as part of the HTTP request. */ httpCustomHeaders?: { [key: string]: string; }[]; /** * The HTTP endpoint to send streaming logs. */ httpEndpoint?: string; /** * The Mixpanel project ID, found on the Project Settings page. */ mixpanelProjectId?: string; /** * The Mixpanel region. Options are ["us", "eu"]. EU is required for customers with EU data residency requirements. */ mixpanelRegion?: string; /** * The Mixpanel Service Account password. */ mixpanelServiceAccountPassword?: string; /** * The Mixpanel Service Account username. Services Accounts can be created in the Project Settings page. */ mixpanelServiceAccountUsername?: string; /** * The [Segment Write Key](https://segment.com/docs/connections/find-writekey/). */ segmentWriteKey?: string; /** * The Splunk domain name. */ splunkDomain?: string; /** * The Splunk port. */ splunkPort?: string; /** * This toggle should be turned off when using self-signed certificates. */ splunkSecure?: boolean; /** * The Splunk access token. */ splunkToken?: string; /** * Generated URL for your defined HTTP source in Sumo Logic for collecting streaming data from Auth0. */ sumoSourceAddress?: string; } export interface NetworkAclRule { /** * The action configuration for the Network ACL Rule. Only one action type (block, allow, log, or redirect) should be specified. */ action: outputs.NetworkAclRuleAction; /** * The configuration for the Network ACL Rule */ match?: outputs.NetworkAclRuleMatch; /** * When true, the rule unconditionally matches all traffic regardless of any other criteria. Mutually exclusive with match and not_match. */ matchAll?: boolean; /** * The configuration for the Network ACL Rule */ notMatch?: outputs.NetworkAclRuleNotMatch; /** * The scope of the Network ACL Rule */ scope: string; } export interface NetworkAclRuleAction { /** * If true, allows the request. When using allow action, no other properties should be set. */ allow?: boolean; /** * If true, blocks the request. When using block action, no other properties should be set. */ block?: boolean; /** * If true, logs the request. When using log action, no other properties should be set. */ log?: boolean; /** * If true, redirects the request. When using redirect action, redirectUri must also be specified. */ redirect?: boolean; /** * The URI to redirect to when redirect is true. Required when redirect is true. Must be between 1 and 2000 characters. */ redirectUri?: string; } export interface NetworkAclRuleMatch { /** * ASNs. Must contain between 1 and 10 unique items. */ asns?: number[]; /** * Auth0-curated blocklists to match against. Allowed values are `auth0.low_reputation` and `auth0.icloud_relay_proxy`; the set is validated by the Management API and may grow. Requires the `advanced-breached-password-detection` entitlement and the `tenantAclCuratedBlocklists` feature flag to be enabled on the tenant. (EA Only) */ auth0Manageds?: string[]; /** * Connecting IPv4 CIDRs. Must contain between 1 and 20 unique items. Can be IPv4 addresses or CIDR blocks. */ connectingIpv4Cidrs?: string[]; /** * Connecting IPv6 CIDRs. Must contain between 1 and 20 unique items. Can be IPv6 addresses or CIDR blocks. */ connectingIpv6Cidrs?: string[]; /** * Geo Country Codes. Must contain between 1 and 10 unique items. */ geoCountryCodes?: string[]; /** * Geo Subdivision Codes. Must contain between 1 and 10 unique items. */ geoSubdivisionCodes?: string[]; /** * Hostnames. Must contain between 1 and 20 unique items. */ hostnames?: string[]; /** * Match requests that carry an HTTP Message Signature verified by one of the listed Network ACL keys. (EA Only) */ httpMessageSignature?: outputs.NetworkAclRuleMatchHttpMessageSignature; /** * IPv4 CIDRs. Must contain between 1 and 10 unique items. Can be IPv4 addresses or CIDR blocks. */ ipv4Cidrs?: string[]; /** * IPv6 CIDRs. Must contain between 1 and 10 unique items. Can be IPv6 addresses or CIDR blocks. */ ipv6Cidrs?: string[]; /** * JA3 Fingerprints. Must contain between 1 and 10 unique items. */ ja3Fingerprints?: string[]; /** * JA4 Fingerprints. Must contain between 1 and 10 unique items. */ ja4Fingerprints?: string[]; /** * User Agents. Must contain between 1 and 10 unique items. */ userAgents?: string[]; } export interface NetworkAclRuleMatchHttpMessageSignature { /** * List of Network ACL key references. A request matches if its signature is verified by any of these keys. */ keys: outputs.NetworkAclRuleMatchHttpMessageSignatureKey[]; } export interface NetworkAclRuleMatchHttpMessageSignatureKey { /** * The ID of the referenced Network ACL key. */ id: string; } export interface NetworkAclRuleNotMatch { /** * ASNs. Must contain between 1 and 10 unique items. */ asns?: number[]; /** * Auth0-curated blocklists to match against. Allowed values are `auth0.low_reputation` and `auth0.icloud_relay_proxy`; the set is validated by the Management API and may grow. Requires the `advanced-breached-password-detection` entitlement and the `tenantAclCuratedBlocklists` feature flag to be enabled on the tenant. (EA Only) */ auth0Manageds?: string[]; /** * Connecting IPv4 CIDRs. Must contain between 1 and 20 unique items. Can be IPv4 addresses or CIDR blocks. */ connectingIpv4Cidrs?: string[]; /** * Connecting IPv6 CIDRs. Must contain between 1 and 20 unique items. Can be IPv6 addresses or CIDR blocks. */ connectingIpv6Cidrs?: string[]; /** * Geo Country Codes. Must contain between 1 and 10 unique items. */ geoCountryCodes?: string[]; /** * Geo Subdivision Codes. Must contain between 1 and 10 unique items. */ geoSubdivisionCodes?: string[]; /** * Hostnames. Must contain between 1 and 20 unique items. */ hostnames?: string[]; /** * Match requests that carry an HTTP Message Signature verified by one of the listed Network ACL keys. (EA Only) */ httpMessageSignature?: outputs.NetworkAclRuleNotMatchHttpMessageSignature; /** * IPv4 CIDRs. Must contain between 1 and 10 unique items. Can be IPv4 addresses or CIDR blocks. */ ipv4Cidrs?: string[]; /** * IPv6 CIDRs. Must contain between 1 and 10 unique items. Can be IPv6 addresses or CIDR blocks. */ ipv6Cidrs?: string[]; /** * JA3 Fingerprints. Must contain between 1 and 10 unique items. */ ja3Fingerprints?: string[]; /** * JA4 Fingerprints. Must contain between 1 and 10 unique items. */ ja4Fingerprints?: string[]; /** * User Agents. Must contain between 1 and 10 unique items. */ userAgents?: string[]; } export interface NetworkAclRuleNotMatchHttpMessageSignature { /** * List of Network ACL key references. A request matches if its signature is verified by any of these keys. */ keys: outputs.NetworkAclRuleNotMatchHttpMessageSignatureKey[]; } export interface NetworkAclRuleNotMatchHttpMessageSignatureKey { /** * The ID of the referenced Network ACL key. */ id: string; } export interface OrganizationBranding { /** * Color scheme used to customize the login pages. */ colors?: { [key: string]: string; }; /** * URL of logo to display on login page. */ logoUrl?: string; } export interface OrganizationClientsClient { /** * The ID of the client (application) to associate with the organization. */ clientId: string; /** * Whether this client is used for member access to the organization. */ useForMemberAccess?: boolean; } export interface OrganizationConnectionsEnabledConnection { /** * When `true`, all users that log in with this connection will be automatically granted membership in the organization. When `false`, users must be granted membership in the organization before logging in with this connection. */ assignMembershipOnLogin?: boolean; /** * The ID of the connection to enable for the organization. */ connectionId: string; /** * Whether the connection is enabled for the organization. */ isEnabled?: boolean; /** * Determines whether organization sign-up should be enabled for this organization connection. Only applicable for database connections. Note: `isSignupEnabled` can only be `true` if `assignMembershipOnLogin` is `true`. */ isSignupEnabled?: boolean; /** * The access level for this organization connection. Can be `none`, `readonly`, `limited`, or `full`. */ organizationAccessLevel: string; /** * Name of the connection in the scope of this organization. */ organizationConnectionName?: string; /** * Determines whether a connection should be displayed on this organization's login prompt. Only applicable for enterprise connections. */ showAsButton?: boolean; } export interface OrganizationDiscoveryDomainsDiscoveryDomain { /** * The domain name for organization discovery. */ domain: string; /** * The ID of the discovery domain. */ id: string; /** * Verification status. Must be either 'pending' or 'verified'. */ status: string; /** * Indicates whether this domain should be used for organization discovery during login. */ useForOrganizationDiscovery: boolean; /** * The full domain where the TXT record should be added. */ verificationHost: string; /** * TXT record value for domain verification. */ verificationTxt: string; } export interface OrganizationTokenQuota { /** * The token quota configuration for client credentials. */ clientCredentials: outputs.OrganizationTokenQuotaClientCredentials; } export interface OrganizationTokenQuotaClientCredentials { /** * If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs. */ enforce?: boolean; /** * Maximum number of issued tokens per day */ perDay?: number; /** * Maximum number of issued tokens per hour */ perHour?: number; } export interface PagesChangePassword { /** * Indicates whether to use the custom Reset Password HTML (`true`) or the default Auth0 page (`false`). */ enabled: boolean; /** * Customized content for the Reset Password page. HTML format with supported [Liquid syntax](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers). */ html: string; } export interface PagesError { /** * Customized content for the Error page. HTML format with supported [Liquid syntax](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers). */ html?: string; /** * Indicates whether to show the link to logs as part of the default error page. */ showLogLink: boolean; /** * URL to redirect to when an error occurs, instead of showing the default error page. */ url?: string; } export interface PagesGuardianMfa { /** * Indicates whether to use the custom Guardian MFA HTML (`true`) or the default Auth0 page (`false`). */ enabled: boolean; /** * Customized content for the Guardian MFA page. HTML format with supported [Liquid syntax](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers). */ html: string; } export interface PagesLogin { /** * Indicates whether to use the custom Login page HTML (`true`) or the default Auth0 page (`false`). */ enabled: boolean; /** * Customized content for the Login page. HTML format with supported [Liquid syntax](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers). */ html: string; } export interface PhoneNotificationTemplateContent { /** * The body content of the phone notification template. */ body: outputs.PhoneNotificationTemplateContentBody; /** * The sender phone number for SMS or voice notifications. */ from?: string; /** * The syntax of the phone notification template. */ syntax: string; } export interface PhoneNotificationTemplateContentBody { /** * The text content for SMS notifications. */ text?: string; /** * The voice content for voice notifications. */ voice?: string; } export interface PhoneProviderConfiguration { /** * Default sender subject as "from" when no other value is specified. */ defaultFrom?: string; /** * Media set supported by a given provider to deliver a notification */ deliveryMethods: string[]; /** * Twilio Messaging Service SID */ mssid?: string; /** * Twilio Account SID. */ sid?: string; } export interface PhoneProviderCredentials { /** * The Auth Token for the phone provider. */ authToken?: string; } export interface PortalClient { /** * Client credentials using clientSecretPost authentication. */ clientSecretPost: outputs.PortalClientClientSecretPost; } export interface PortalClientClientSecretPost { /** * The ID of the client. */ clientId: string; /** * The client secret. This value is stored in Terraform state. */ clientSecret?: string; /** * **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. * The write-only client secret. This value is not stored in Terraform state. It is also sent when any other attribute in `clientSecretPost` changes. */ clientSecretWo?: string; /** * Version of the write-only client secret. Increment this value to send a new secret. */ clientSecretWoVersion?: number; } export interface PortalCustomCode { /** * Code added to the page head. */ head?: string; } export interface PortalNavigation { /** * Sidebar navigation for the portal. */ sidebar?: outputs.PortalNavigationSidebar; } export interface PortalNavigationSidebar { /** * Sidebar components in display order. Only V2 links are supported. */ components?: outputs.PortalNavigationSidebarComponent[]; } export interface PortalNavigationSidebarComponent { /** * A V2 link to an external URL. */ externalLinkV2?: outputs.PortalNavigationSidebarComponentExternalLinkV2; /** * A V2 link to a portal page. */ internalLinkV2?: outputs.PortalNavigationSidebarComponentInternalLinkV2; } export interface PortalNavigationSidebarComponentExternalLinkV2 { /** * The URL of the link. */ href: string; /** * The icon of the link. */ icon?: string; /** * The label of the link. */ label: string; } export interface PortalNavigationSidebarComponentInternalLinkV2 { /** * The icon of the link. */ icon?: string; /** * The label of the link. */ label: string; /** * The slug of the linked page. */ pageSlug: string; } export interface PortalPages { /** * The slug of the default page. */ default?: string; /** * Standard pages in display order. */ standards?: outputs.PortalPagesStandard[]; } export interface PortalPagesStandard { /** * Page components in display order. */ components?: outputs.PortalPagesStandardComponent[]; /** * The slug of the page. */ slug: string; /** * The title of the page. */ title: string; } export interface PortalPagesStandardComponent { /** * A form component. */ form?: outputs.PortalPagesStandardComponentForm; /** * An image component. */ mediaImage?: outputs.PortalPagesStandardComponentMediaImage; /** * An MFA management component. */ myAccountMfaManagement?: outputs.PortalPagesStandardComponentMyAccountMfaManagement; /** * A passkey management component. */ myAccountPasskeyManagement?: outputs.PortalPagesStandardComponentMyAccountPasskeyManagement; /** * An organization details edit component. */ myOrganizationDetailsEdit?: outputs.PortalPagesStandardComponentMyOrganizationDetailsEdit; /** * An organization domain table component. */ myOrganizationDomainTable?: outputs.PortalPagesStandardComponentMyOrganizationDomainTable; /** * An organization member management component. */ myOrganizationMemberManagement?: outputs.PortalPagesStandardComponentMyOrganizationMemberManagement; /** * A section containing up to 20 components. */ structureSection?: outputs.PortalPagesStandardComponentStructureSection; /** * A separator component. */ structureSeparator?: outputs.PortalPagesStandardComponentStructureSeparator; /** * A heading component. */ typographyHeading?: outputs.PortalPagesStandardComponentTypographyHeading; /** * A rich text component. */ typographyRichText?: outputs.PortalPagesStandardComponentTypographyRichText; } export interface PortalPagesStandardComponentForm { /** * The message shown after form completion. */ completionMessage: string; /** * The ID of the form. */ formId: string; } export interface PortalPagesStandardComponentMediaImage { /** * The height of the image. */ height?: number; /** * The position of the image. */ position?: string; /** * The URL of the image. */ src: string; } export interface PortalPagesStandardComponentMyAccountMfaManagement { } export interface PortalPagesStandardComponentMyAccountPasskeyManagement { } export interface PortalPagesStandardComponentMyOrganizationDetailsEdit { } export interface PortalPagesStandardComponentMyOrganizationDomainTable { } export interface PortalPagesStandardComponentMyOrganizationMemberManagement { } export interface PortalPagesStandardComponentStructureSection { /** * Components in the section. Sections cannot be nested. */ children?: outputs.PortalPagesStandardComponentStructureSectionChild[]; /** * The description of the section. */ description?: string; /** * The title of the section. */ title?: string; /** * The section style. Can be `card` or `none`. */ variant: string; } export interface PortalPagesStandardComponentStructureSectionChild { /** * A form component. */ form?: outputs.PortalPagesStandardComponentStructureSectionChildForm; /** * An image component. */ mediaImage?: outputs.PortalPagesStandardComponentStructureSectionChildMediaImage; /** * An MFA management component. */ myAccountMfaManagement?: outputs.PortalPagesStandardComponentStructureSectionChildMyAccountMfaManagement; /** * A passkey management component. */ myAccountPasskeyManagement?: outputs.PortalPagesStandardComponentStructureSectionChildMyAccountPasskeyManagement; /** * An organization details edit component. */ myOrganizationDetailsEdit?: outputs.PortalPagesStandardComponentStructureSectionChildMyOrganizationDetailsEdit; /** * An organization domain table component. */ myOrganizationDomainTable?: outputs.PortalPagesStandardComponentStructureSectionChildMyOrganizationDomainTable; /** * An organization member management component. */ myOrganizationMemberManagement?: outputs.PortalPagesStandardComponentStructureSectionChildMyOrganizationMemberManagement; /** * A separator component. */ structureSeparator?: outputs.PortalPagesStandardComponentStructureSectionChildStructureSeparator; /** * A heading component. */ typographyHeading?: outputs.PortalPagesStandardComponentStructureSectionChildTypographyHeading; /** * A rich text component. */ typographyRichText?: outputs.PortalPagesStandardComponentStructureSectionChildTypographyRichText; } export interface PortalPagesStandardComponentStructureSectionChildForm { /** * The message shown after form completion. */ completionMessage: string; /** * The ID of the form. */ formId: string; } export interface PortalPagesStandardComponentStructureSectionChildMediaImage { /** * The height of the image. */ height?: number; /** * The position of the image. */ position?: string; /** * The URL of the image. */ src: string; } export interface PortalPagesStandardComponentStructureSectionChildMyAccountMfaManagement { } export interface PortalPagesStandardComponentStructureSectionChildMyAccountPasskeyManagement { } export interface PortalPagesStandardComponentStructureSectionChildMyOrganizationDetailsEdit { } export interface PortalPagesStandardComponentStructureSectionChildMyOrganizationDomainTable { } export interface PortalPagesStandardComponentStructureSectionChildMyOrganizationMemberManagement { } export interface PortalPagesStandardComponentStructureSectionChildStructureSeparator { /** * The text of the separator. */ text?: string; /** * The separator style. */ variant?: string; } export interface PortalPagesStandardComponentStructureSectionChildTypographyHeading { /** * The description below the heading. */ description?: string; /** * The heading text. */ title: string; } export interface PortalPagesStandardComponentStructureSectionChildTypographyRichText { /** * The HTML content. */ content: string; } export interface PortalPagesStandardComponentStructureSeparator { /** * The text of the separator. */ text?: string; /** * The separator style. */ variant?: string; } export interface PortalPagesStandardComponentTypographyHeading { /** * The description below the heading. */ description?: string; /** * The heading text. */ title: string; } export interface PortalPagesStandardComponentTypographyRichText { /** * The HTML content. */ content: string; } export interface PromptScreenPartialInsertionPoints { /** * Content that goes inside the form */ formContent?: string; /** * Content that goes at the end of the form. */ formContentEnd?: string; /** * Content that goes at the start of the form. */ formContentStart?: string; /** * Footer content for the end of the footer. */ formFooterEnd?: string; /** * Footer content for the start of the footer. */ formFooterStart?: string; /** * Actions that go at the end of secondary actions. */ secondaryActionsEnd?: string; /** * Actions that go at the start of secondary actions. */ secondaryActionsStart?: string; } export interface PromptScreenPartialsScreenPartial { insertionPoints: outputs.PromptScreenPartialsScreenPartialInsertionPoints; /** * The name of the screen associated with the partials */ screenName: string; } export interface PromptScreenPartialsScreenPartialInsertionPoints { /** * Content that goes inside the form */ formContent?: string; /** * Content that goes at the end of the form. */ formContentEnd?: string; /** * Content that goes at the start of the form. */ formContentStart?: string; /** * Footer content for the end of the footer. */ formFooterEnd?: string; /** * Footer content for the start of the footer. */ formFooterStart?: string; /** * Actions that go at the end of secondary actions. */ secondaryActionsEnd?: string; /** * Actions that go at the start of secondary actions. */ secondaryActionsStart?: string; } export interface PromptScreenRendererFilters { /** * An array of clients (applications) identified by id or a metadata key/value pair. Entity Limit: 25. */ clients?: string; /** * An array of domains identified by id or a metadata key/value pair. Entity Limit: 25. */ domains?: string; /** * Type of match to apply. Options: `includesAny`, `excludesAny`. */ matchType: string; /** * An array of organizations identified by id or a metadata key/value pair. Entity Limit: 25. */ organizations?: string; } export interface RateLimitPolicyConfiguration { /** * Action to take when the rate limit is exceeded. Valid values are: allow block log redirect */ action: string; /** * Maximum number of requests allowed in a single window (0-10000). Required and only valid for the `block`, `log`, and `redirect` actions. (EA only) */ limit?: number; /** * HTTPS URI to redirect to when the rate limit is exceeded. Required and only valid for the `redirect` action. (EA only) */ redirectUri?: string; } export interface ResourceServerAccessToken { /** * Configuration for mapping claims into the access tokens issued for this resource server. (EA only) */ claimsMapping?: outputs.ResourceServerAccessTokenClaimsMapping; } export interface ResourceServerAccessTokenClaimsMapping { /** * Custom claims to include in the access tokens issued for this resource server. Maximum of 20 claims. Setting an empty list clears the custom claims on the API. (EA only) */ customClaims?: outputs.ResourceServerAccessTokenClaimsMappingCustomClaim[]; } export interface ResourceServerAccessTokenClaimsMappingCustomClaim { /** * Expression used to resolve the claim value, given as a dot-path read from the request context (for example `anonymous_session.metadata.country`). */ expression: string; /** * Name of the claim to emit in the access token. Reserved OIDC/JWT claim names are not allowed. */ name: string; } export interface ResourceServerAuthorizationDetail { /** * Disable authorization details. */ disable?: boolean; /** * Type of authorization details. */ type?: string; } export interface ResourceServerAuthorizationPolicy { /** * Identifier of the authorization policy. */ policyId: string; } export interface ResourceServerProofOfPossession { /** * Disable proof-of-possession. */ disable?: boolean; /** * Mechanism used for proof-of-possession. `mtls` or `dpop` is supported. */ mechanism: string; /** * Indicates whether proof-of-possession is required with this resource server. */ required: boolean; /** * Specifies which client types require Proof-of-Possession`allClients` or `publicClients` is supported. */ requiredFor?: string; } export interface ResourceServerScopesScope { /** * User-friendly description of the scope (permission). */ description?: string; /** * Name of the scope (permission). Examples include `read:appointments` or `delete:appointments`. */ name: string; } export interface ResourceServerSubjectTypeAuthorization { /** * Anonymous user authorization policies for the resource server. (EA only) */ anonymousUser: outputs.ResourceServerSubjectTypeAuthorizationAnonymousUser; /** * Client authorization policies for the resource server. */ client: outputs.ResourceServerSubjectTypeAuthorizationClient; /** * User authorization policies for the resource server. */ user: outputs.ResourceServerSubjectTypeAuthorizationUser; } export interface ResourceServerSubjectTypeAuthorizationAnonymousUser { /** * Anonymous user flows policy. One of `denyAll`, `requireClientGrant`. Defaults to `denyAll` (EA only) */ policy: string; } export interface ResourceServerSubjectTypeAuthorizationClient { /** * Client flows policy. One of `denyAll`, `requireClientGrant`. */ policy?: string; } export interface ResourceServerSubjectTypeAuthorizationUser { /** * User flows policy. One of `allowAll`, `denyAll`, `requireClientGrant`. */ policy?: string; } export interface ResourceServerTokenEncryption { /** * Disable token encryption. */ disable?: boolean; /** * Authorization details for this resource server. */ encryptionKey: outputs.ResourceServerTokenEncryptionEncryptionKey; /** * Format of the token encryption. Only `compact-nested-jwe` is supported. */ format: string; } export interface ResourceServerTokenEncryptionEncryptionKey { /** * Algorithm used to encrypt the token. */ algorithm: string; /** * Key ID. */ kid: string; /** * Name of the encryption key. */ name: string; /** * PEM-formatted public key. Must be JSON escaped. */ pem: string; } export interface RolePermissionsPermission { /** * Description of the permission. */ description: string; /** * Name of permission. */ name: string; /** * Resource server identifier associated with the permission. */ resourceServerIdentifier: string; /** * Name of resource server that the permission is associated with. */ resourceServerName: string; } export interface SelfServiceProfileBranding { /** * Configuration settings for colors for branding. */ colors: outputs.SelfServiceProfileBrandingColors; /** * URL of logo to display on login page. */ logoUrl?: string; } export interface SelfServiceProfileBrandingColors { /** * Primary button background color in hexadecimal. */ primary: string; } export interface SelfServiceProfileUserAttribute { /** * A human readable description of the attribute. */ description: string; /** * Indicates if this attribute is optional or if it has to be provided by the customer for the application to function. */ isOptional: boolean; /** * Attribute’s name on Auth0 side */ name: string; } export interface TenantCountryCodes { /** * List of ISO 3166-1 alpha-2 country codes. */ lists: string[]; /** * Whether the list is an allow-list or deny-list. Available options: `allow`, `deny`. */ mode: string; } export interface TenantDefaultTokenQuota { /** * The token quota configuration. */ clients?: outputs.TenantDefaultTokenQuotaClients; /** * The token quota configuration. */ organizations?: outputs.TenantDefaultTokenQuotaOrganizations; } export interface TenantDefaultTokenQuotaClients { /** * The token quota configuration for client credentials. */ clientCredentials: outputs.TenantDefaultTokenQuotaClientsClientCredentials; } export interface TenantDefaultTokenQuotaClientsClientCredentials { /** * If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs. */ enforce?: boolean; /** * Maximum number of issued tokens per day */ perDay?: number; /** * Maximum number of issued tokens per hour */ perHour?: number; } export interface TenantDefaultTokenQuotaOrganizations { /** * The token quota configuration for client credentials. */ clientCredentials: outputs.TenantDefaultTokenQuotaOrganizationsClientCredentials; } export interface TenantDefaultTokenQuotaOrganizationsClientCredentials { /** * If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs. */ enforce?: boolean; /** * Maximum number of issued tokens per day */ perDay?: number; /** * Maximum number of issued tokens per hour */ perHour?: number; } export interface TenantErrorPage { /** * Custom Error HTML (Liquid syntax is supported) */ html?: string; /** * Whether to show the link to log as part of the default error page (true, default) or not to show the link (false). */ showLogLink?: boolean; /** * URL to redirect to when an error occurs instead of showing the default error page */ url?: string; } export interface TenantFlags { /** * Whether the legacy delegation endpoint will be enabled for your account (true) or not available (false). */ allowLegacyDelegationGrantTypes: boolean; /** * Whether the legacy `auth/ro` endpoint (used with resource owner password and passwordless features) will be enabled for your account (true) or not available (false). */ allowLegacyRoGrantTypes: boolean; /** * If enabled, customers can use Tokeninfo Endpoint, otherwise they can not use it. */ allowLegacyTokeninfoEndpoint: boolean; /** * Enables new insights activity page view. */ dashboardInsightsView: boolean; /** * Enables beta access to log streaming changes. */ dashboardLogStreamsNext: boolean; /** * Indicates whether classic Universal Login prompts include additional security headers to prevent clickjacking. */ disableClickjackProtectionHeaders: boolean; /** * Disables SAML fields map fix for bad mappings with repeated attributes. */ disableFieldsMapFix: boolean; /** * If true, SMS phone numbers will not be obfuscated in Management API GET calls. */ disableManagementApiSmsObfuscation: boolean; /** * If enabled, users will be presented with an email verification prompt during their first login when using Azure AD or ADFS connections. */ enableAdfsWaadEmailVerification: boolean; /** * Indicates whether the APIs section is enabled for the tenant. */ enableApisSection: boolean; /** * Indicates whether all current connections should be enabled when a new client is created. */ enableClientConnections: boolean; /** * Indicates whether the tenant allows custom domains in emails. Before enabling this flag, you must have a custom domain with status: `ready`. */ enableCustomDomainInEmails: boolean; /** * Indicates whether the tenant allows dynamic client registration. */ enableDynamicClientRegistration: boolean; /** * Whether ID tokens can be used to authorize some types of requests to API v2 (true) or not (false). */ enableIdtokenApi2: boolean; /** * Indicates whether to use the older v2 legacy logs search. */ enableLegacyLogsSearchV2: boolean; /** * Whether ID tokens and the userinfo endpoint includes a complete user profile (true) or only OpenID Connect claims (false). */ enableLegacyProfile: boolean; /** * Indicates whether advanced API Authorization scenarios are enabled. */ enablePipeline2: boolean; /** * Indicates whether the public sign up process shows a `userExists` error if the user already exists. Note: the Auth0 Dashboard toggle **Use a generic response in public signup API error message** shows the inverse of this value. */ enablePublicSignupUserExistsError: boolean; /** * Flag indicating whether users will not be prompted to confirm log in before SSO redirection. This flag applies to existing tenants only; new tenants have it enforced as true. */ enableSso: boolean; /** * Used to allow users to pick which factor to enroll with from the list of available MFA factors. */ mfaShowFactorListOnEnrollment: boolean; /** * Do not Publish Enterprise Connections Information with IdP domains on the lock configuration file. Note: the Auth0 Dashboard toggle **Enable Publishing of Enterprise Connections Information with IdP domains** shows the inverse of this value. */ noDiscloseEnterpriseConnections: boolean; /** * Remove `alg` from jwks(JSON Web Key Sets). */ removeAlgFromJwks: boolean; /** * This Flag is not supported by the Auth0 Management API and will be removed in the next major release. * * @deprecated This Flag is not supported by the Auth0 Management API and will be removed in the next major release. */ requirePushedAuthorizationRequests: boolean; /** * Delete underlying grant when a refresh token is revoked via the Authentication API. */ revokeRefreshTokenGrant: boolean; /** * Indicates whether to use scope descriptions for consent. */ useScopeDescriptionsForConsent: boolean; } export interface TenantMtls { /** * Disable mTLS settings. */ disable?: boolean; /** * Enable mTLS endpoint aliases. */ enableEndpointAliases?: boolean; } export interface TenantOidcLogout { /** * Enable the end*session*endpoint URL in the .well-known discovery configuration. */ rpLogoutEndSessionEndpointDiscovery: boolean; } export interface TenantSessionCookie { /** * Behavior of tenant session cookie. Accepts either "persistent" or "non-persistent". */ mode?: string; } export interface TenantSessions { /** * Anonymous Sessions settings for the tenant. (EA only) */ anonymous?: outputs.TenantSessionsAnonymous; /** * When active, users will be presented with a consent prompt to confirm the logout request if the request is not trustworthy. Turn off the consent prompt to bypass user confirmation. */ oidcLogoutPromptEnabled: boolean; } export interface TenantSessionsAnonymous { /** * Whether anonymous session requests return the `auth0Anon` cookie. (EA only) */ activateCookie?: boolean; /** * Number of minutes during which an anonymous session will stay valid. Minimum 1, maximum 525600. (EA only) */ lifetimeInMinutes?: number; } export interface TriggerActionsAction { /** * The display name of the action within the flow. */ displayName: string; /** * Action ID. */ id: string; } export interface UserAttributeProfileUserAttribute { /** * The Auth0 mapping for the user attribute. */ auth0Mapping: string; /** * Description of the user attribute. */ description: string; /** * Display label for the user attribute. */ label: string; /** * Name of the user attribute. */ name: string; /** * The OIDC mapping configuration for the user attribute. */ oidcMapping: outputs.UserAttributeProfileUserAttributeOidcMapping; /** * Whether the attribute is required in the profile. */ profileRequired: boolean; /** * SAML mapping override for this strategy. */ samlMappings: string[]; /** * The SCIM mapping for the user attribute. */ scimMapping: string; /** * Strategy-specific overrides for user attribute mapping. */ strategyOverrides: outputs.UserAttributeProfileUserAttributeStrategyOverride[]; } export interface UserAttributeProfileUserAttributeOidcMapping { /** * Display name for the OIDC mapping. */ displayName?: string; /** * The OIDC mapping field. */ mapping: string; } export interface UserAttributeProfileUserAttributeStrategyOverride { /** * OIDC mapping override for this strategy. */ oidcMapping: outputs.UserAttributeProfileUserAttributeStrategyOverrideOidcMapping; /** * SAML mapping override for this strategy. */ samlMappings: string[]; /** * SCIM mapping override for this strategy. */ scimMapping: string; /** * The strategy name (e.g., 'oidc', 'samlp', 'ad', etc.). */ strategy: string; } export interface UserAttributeProfileUserAttributeStrategyOverrideOidcMapping { /** * Display name for the OIDC mapping. */ displayName?: string; /** * The OIDC mapping field. */ mapping: string; } export interface UserAttributeProfileUserId { /** * The OIDC mapping for the user ID. */ oidcMapping: string; /** * The SAML mapping for the user ID. */ samlMappings: string[]; /** * The SCIM mapping for the user ID. */ scimMapping: string; /** * Strategy-specific overrides for user ID mapping. */ strategyOverrides?: outputs.UserAttributeProfileUserIdStrategyOverride[]; } export interface UserAttributeProfileUserIdStrategyOverride { /** * OIDC mapping override for this strategy. */ oidcMapping: string; /** * SAML mapping override for this strategy. */ samlMappings: string[]; /** * SCIM mapping override for this strategy. */ scimMapping: string; /** * The strategy name (e.g., 'oidc', 'samlp', 'ad', etc.). */ strategy: string; } export interface UserPermissionsPermission { /** * Description of the permission. */ description: string; /** * Name of permission. */ name: string; /** * Resource server identifier associated with the permission. */ resourceServerIdentifier: string; /** * Name of resource server that the permission is associated with. */ resourceServerName: string; } //# sourceMappingURL=output.d.ts.map