import * as Management from "../index.mjs"; export declare const OauthScope: { /** * Create Actions */ readonly CreateActions: "create:actions"; /** * Read Actions */ readonly ReadActions: "read:actions"; /** * Update Actions */ readonly UpdateActions: "update:actions"; /** * Delete Actions */ readonly DeleteActions: "delete:actions"; /** * Read Anomaly Blocks */ readonly ReadAnomalyBlocks: "read:anomaly_blocks"; /** * Delete Anomaly Blocks */ readonly DeleteAnomalyBlocks: "delete:anomaly_blocks"; /** * Read Attack Protection */ readonly ReadAttackProtection: "read:attack_protection"; /** * Update Attack Protection */ readonly UpdateAttackProtection: "update:attack_protection"; /** * Create Authentication Methods */ readonly CreateAuthenticationMethods: "create:authentication_methods"; /** * Read Authentication Methods */ readonly ReadAuthenticationMethods: "read:authentication_methods"; /** * Update Authentication Methods */ readonly UpdateAuthenticationMethods: "update:authentication_methods"; /** * Delete Authentication Methods */ readonly DeleteAuthenticationMethods: "delete:authentication_methods"; /** * Read Branding */ readonly ReadBranding: "read:branding"; /** * Update Branding */ readonly UpdateBranding: "update:branding"; /** * Delete Branding */ readonly DeleteBranding: "delete:branding"; /** * Create Client Credentials */ readonly CreateClientCredentials: "create:client_credentials"; /** * Read Client Credentials */ readonly ReadClientCredentials: "read:client_credentials"; /** * Update Client Credentials */ readonly UpdateClientCredentials: "update:client_credentials"; /** * Delete Client Credentials */ readonly DeleteClientCredentials: "delete:client_credentials"; /** * Create Client Grants */ readonly CreateClientGrants: "create:client_grants"; /** * Read Client Grants */ readonly ReadClientGrants: "read:client_grants"; /** * Update Client Grants */ readonly UpdateClientGrants: "update:client_grants"; /** * Delete Client Grants */ readonly DeleteClientGrants: "delete:client_grants"; /** * Read Client Keys */ readonly ReadClientKeys: "read:client_keys"; /** * Update Client Keys */ readonly UpdateClientKeys: "update:client_keys"; /** * Read Client Summary */ readonly ReadClientSummary: "read:client_summary"; /** * Update Client Token Vault Privileged Access */ readonly UpdateClientTokenVaultPrivilegedAccess: "update:client_token_vault_privileged_access"; /** * Create Clients */ readonly CreateClients: "create:clients"; /** * Read Clients */ readonly ReadClients: "read:clients"; /** * Update Clients */ readonly UpdateClients: "update:clients"; /** * Delete Clients */ readonly DeleteClients: "delete:clients"; /** * Create Connection Profiles */ readonly CreateConnectionProfiles: "create:connection_profiles"; /** * Read Connection Profiles */ readonly ReadConnectionProfiles: "read:connection_profiles"; /** * Update Connection Profiles */ readonly UpdateConnectionProfiles: "update:connection_profiles"; /** * Delete Connection Profiles */ readonly DeleteConnectionProfiles: "delete:connection_profiles"; /** * Create Connections */ readonly CreateConnections: "create:connections"; /** * Read Connections */ readonly ReadConnections: "read:connections"; /** * Update Connections */ readonly UpdateConnections: "update:connections"; /** * Delete Connections */ readonly DeleteConnections: "delete:connections"; /** * Create Connections Keys */ readonly CreateConnectionsKeys: "create:connections_keys"; /** * Read Connections Keys */ readonly ReadConnectionsKeys: "read:connections_keys"; /** * Update Connections Keys */ readonly UpdateConnectionsKeys: "update:connections_keys"; /** * Read Current User */ readonly ReadCurrentUser: "read:current_user"; /** * Delete Current User */ readonly DeleteCurrentUser: "delete:current_user"; /** * Create Current User Device Credentials */ readonly CreateCurrentUserDeviceCredentials: "create:current_user_device_credentials"; /** * Delete Current User Device Credentials */ readonly DeleteCurrentUserDeviceCredentials: "delete:current_user_device_credentials"; /** * Update Current User Identities */ readonly UpdateCurrentUserIdentities: "update:current_user_identities"; /** * Update Current User Metadata */ readonly UpdateCurrentUserMetadata: "update:current_user_metadata"; /** * Create Custom Domains */ readonly CreateCustomDomains: "create:custom_domains"; /** * Read Custom Domains */ readonly ReadCustomDomains: "read:custom_domains"; /** * Update Custom Domains */ readonly UpdateCustomDomains: "update:custom_domains"; /** * Delete Custom Domains */ readonly DeleteCustomDomains: "delete:custom_domains"; /** * Create Custom Signing Keys */ readonly CreateCustomSigningKeys: "create:custom_signing_keys"; /** * Read Custom Signing Keys */ readonly ReadCustomSigningKeys: "read:custom_signing_keys"; /** * Update Custom Signing Keys */ readonly UpdateCustomSigningKeys: "update:custom_signing_keys"; /** * Delete Custom Signing Keys */ readonly DeleteCustomSigningKeys: "delete:custom_signing_keys"; /** * Read Device Credentials */ readonly ReadDeviceCredentials: "read:device_credentials"; /** * Delete Device Credentials */ readonly DeleteDeviceCredentials: "delete:device_credentials"; /** * Create Directory Provisionings */ readonly CreateDirectoryProvisionings: "create:directory_provisionings"; /** * Read Directory Provisionings */ readonly ReadDirectoryProvisionings: "read:directory_provisionings"; /** * Update Directory Provisionings */ readonly UpdateDirectoryProvisionings: "update:directory_provisionings"; /** * Delete Directory Provisionings */ readonly DeleteDirectoryProvisionings: "delete:directory_provisionings"; /** * Create Email Provider */ readonly CreateEmailProvider: "create:email_provider"; /** * Read Email Provider */ readonly ReadEmailProvider: "read:email_provider"; /** * Update Email Provider */ readonly UpdateEmailProvider: "update:email_provider"; /** * Delete Email Provider */ readonly DeleteEmailProvider: "delete:email_provider"; /** * Create Email Templates */ readonly CreateEmailTemplates: "create:email_templates"; /** * Read Email Templates */ readonly ReadEmailTemplates: "read:email_templates"; /** * Update Email Templates */ readonly UpdateEmailTemplates: "update:email_templates"; /** * Create Encryption Keys */ readonly CreateEncryptionKeys: "create:encryption_keys"; /** * Read Encryption Keys */ readonly ReadEncryptionKeys: "read:encryption_keys"; /** * Update Encryption Keys */ readonly UpdateEncryptionKeys: "update:encryption_keys"; /** * Delete Encryption Keys */ readonly DeleteEncryptionKeys: "delete:encryption_keys"; /** * Read Event Deliveries */ readonly ReadEventDeliveries: "read:event_deliveries"; /** * Update Event Deliveries */ readonly UpdateEventDeliveries: "update:event_deliveries"; /** * Create Event Streams */ readonly CreateEventStreams: "create:event_streams"; /** * Read Event Streams */ readonly ReadEventStreams: "read:event_streams"; /** * Update Event Streams */ readonly UpdateEventStreams: "update:event_streams"; /** * Delete Event Streams */ readonly DeleteEventStreams: "delete:event_streams"; /** * Read Federated Connections Tokens */ readonly ReadFederatedConnectionsTokens: "read:federated_connections_tokens"; /** * Delete Federated Connections Tokens */ readonly DeleteFederatedConnectionsTokens: "delete:federated_connections_tokens"; /** * Create Flows */ readonly CreateFlows: "create:flows"; /** * Read Flows */ readonly ReadFlows: "read:flows"; /** * Update Flows */ readonly UpdateFlows: "update:flows"; /** * Delete Flows */ readonly DeleteFlows: "delete:flows"; /** * Read Flows Executions */ readonly ReadFlowsExecutions: "read:flows_executions"; /** * Delete Flows Executions */ readonly DeleteFlowsExecutions: "delete:flows_executions"; /** * Create Flows Vault Connections */ readonly CreateFlowsVaultConnections: "create:flows_vault_connections"; /** * Read Flows Vault Connections */ readonly ReadFlowsVaultConnections: "read:flows_vault_connections"; /** * Update Flows Vault Connections */ readonly UpdateFlowsVaultConnections: "update:flows_vault_connections"; /** * Delete Flows Vault Connections */ readonly DeleteFlowsVaultConnections: "delete:flows_vault_connections"; /** * Create Forms */ readonly CreateForms: "create:forms"; /** * Read Forms */ readonly ReadForms: "read:forms"; /** * Update Forms */ readonly UpdateForms: "update:forms"; /** * Delete Forms */ readonly DeleteForms: "delete:forms"; /** * Read Grants */ readonly ReadGrants: "read:grants"; /** * Delete Grants */ readonly DeleteGrants: "delete:grants"; /** * Read Group Members */ readonly ReadGroupMembers: "read:group_members"; /** * Read Groups */ readonly ReadGroups: "read:groups"; /** * Delete Groups */ readonly DeleteGroups: "delete:groups"; /** * Create Guardian Enrollment Tickets */ readonly CreateGuardianEnrollmentTickets: "create:guardian_enrollment_tickets"; /** * Read Guardian Enrollments */ readonly ReadGuardianEnrollments: "read:guardian_enrollments"; /** * Delete Guardian Enrollments */ readonly DeleteGuardianEnrollments: "delete:guardian_enrollments"; /** * Read Guardian Factors */ readonly ReadGuardianFactors: "read:guardian_factors"; /** * Update Guardian Factors */ readonly UpdateGuardianFactors: "update:guardian_factors"; /** * Create Hooks */ readonly CreateHooks: "create:hooks"; /** * Read Hooks */ readonly ReadHooks: "read:hooks"; /** * Update Hooks */ readonly UpdateHooks: "update:hooks"; /** * Delete Hooks */ readonly DeleteHooks: "delete:hooks"; /** * Create Log Streams */ readonly CreateLogStreams: "create:log_streams"; /** * Read Log Streams */ readonly ReadLogStreams: "read:log_streams"; /** * Update Log Streams */ readonly UpdateLogStreams: "update:log_streams"; /** * Delete Log Streams */ readonly DeleteLogStreams: "delete:log_streams"; /** * Read Logs */ readonly ReadLogs: "read:logs"; /** * Read Logs Users */ readonly ReadLogsUsers: "read:logs_users"; /** * Read Mfa Policies */ readonly ReadMfaPolicies: "read:mfa_policies"; /** * Update Mfa Policies */ readonly UpdateMfaPolicies: "update:mfa_policies"; /** * Create Network Acls */ readonly CreateNetworkAcls: "create:network_acls"; /** * Read Network Acls */ readonly ReadNetworkAcls: "read:network_acls"; /** * Update Network Acls */ readonly UpdateNetworkAcls: "update:network_acls"; /** * Delete Network Acls */ readonly DeleteNetworkAcls: "delete:network_acls"; /** * Create Organization Client Grants */ readonly CreateOrganizationClientGrants: "create:organization_client_grants"; /** * Read Organization Client Grants */ readonly ReadOrganizationClientGrants: "read:organization_client_grants"; /** * Delete Organization Client Grants */ readonly DeleteOrganizationClientGrants: "delete:organization_client_grants"; /** * Create Organization Connections */ readonly CreateOrganizationConnections: "create:organization_connections"; /** * Read Organization Connections */ readonly ReadOrganizationConnections: "read:organization_connections"; /** * Update Organization Connections */ readonly UpdateOrganizationConnections: "update:organization_connections"; /** * Delete Organization Connections */ readonly DeleteOrganizationConnections: "delete:organization_connections"; /** * Create Organization Discovery Domains */ readonly CreateOrganizationDiscoveryDomains: "create:organization_discovery_domains"; /** * Read Organization Discovery Domains */ readonly ReadOrganizationDiscoveryDomains: "read:organization_discovery_domains"; /** * Update Organization Discovery Domains */ readonly UpdateOrganizationDiscoveryDomains: "update:organization_discovery_domains"; /** * Delete Organization Discovery Domains */ readonly DeleteOrganizationDiscoveryDomains: "delete:organization_discovery_domains"; /** * Create Organization Invitations */ readonly CreateOrganizationInvitations: "create:organization_invitations"; /** * Read Organization Invitations */ readonly ReadOrganizationInvitations: "read:organization_invitations"; /** * Delete Organization Invitations */ readonly DeleteOrganizationInvitations: "delete:organization_invitations"; /** * Create Organization Member Roles */ readonly CreateOrganizationMemberRoles: "create:organization_member_roles"; /** * Read Organization Member Roles */ readonly ReadOrganizationMemberRoles: "read:organization_member_roles"; /** * Delete Organization Member Roles */ readonly DeleteOrganizationMemberRoles: "delete:organization_member_roles"; /** * Create Organization Members */ readonly CreateOrganizationMembers: "create:organization_members"; /** * Read Organization Members */ readonly ReadOrganizationMembers: "read:organization_members"; /** * Delete Organization Members */ readonly DeleteOrganizationMembers: "delete:organization_members"; /** * Create Organizations */ readonly CreateOrganizations: "create:organizations"; /** * Read Organizations */ readonly ReadOrganizations: "read:organizations"; /** * Update Organizations */ readonly UpdateOrganizations: "update:organizations"; /** * Delete Organizations */ readonly DeleteOrganizations: "delete:organizations"; /** * Read Organizations Summary */ readonly ReadOrganizationsSummary: "read:organizations_summary"; /** * Create Phone Providers */ readonly CreatePhoneProviders: "create:phone_providers"; /** * Read Phone Providers */ readonly ReadPhoneProviders: "read:phone_providers"; /** * Update Phone Providers */ readonly UpdatePhoneProviders: "update:phone_providers"; /** * Delete Phone Providers */ readonly DeletePhoneProviders: "delete:phone_providers"; /** * Create Phone Templates */ readonly CreatePhoneTemplates: "create:phone_templates"; /** * Read Phone Templates */ readonly ReadPhoneTemplates: "read:phone_templates"; /** * Update Phone Templates */ readonly UpdatePhoneTemplates: "update:phone_templates"; /** * Delete Phone Templates */ readonly DeletePhoneTemplates: "delete:phone_templates"; /** * Read Prompts */ readonly ReadPrompts: "read:prompts"; /** * Update Prompts */ readonly UpdatePrompts: "update:prompts"; /** * Read Refresh Tokens */ readonly ReadRefreshTokens: "read:refresh_tokens"; /** * Update Refresh Tokens */ readonly UpdateRefreshTokens: "update:refresh_tokens"; /** * Delete Refresh Tokens */ readonly DeleteRefreshTokens: "delete:refresh_tokens"; /** * Create Resource Servers */ readonly CreateResourceServers: "create:resource_servers"; /** * Read Resource Servers */ readonly ReadResourceServers: "read:resource_servers"; /** * Update Resource Servers */ readonly UpdateResourceServers: "update:resource_servers"; /** * Delete Resource Servers */ readonly DeleteResourceServers: "delete:resource_servers"; /** * Create Role Members */ readonly CreateRoleMembers: "create:role_members"; /** * Read Role Members */ readonly ReadRoleMembers: "read:role_members"; /** * Delete Role Members */ readonly DeleteRoleMembers: "delete:role_members"; /** * Create Roles */ readonly CreateRoles: "create:roles"; /** * Read Roles */ readonly ReadRoles: "read:roles"; /** * Update Roles */ readonly UpdateRoles: "update:roles"; /** * Delete Roles */ readonly DeleteRoles: "delete:roles"; /** * Create Rules */ readonly CreateRules: "create:rules"; /** * Read Rules */ readonly ReadRules: "read:rules"; /** * Update Rules */ readonly UpdateRules: "update:rules"; /** * Delete Rules */ readonly DeleteRules: "delete:rules"; /** * Read Rules Configs */ readonly ReadRulesConfigs: "read:rules_configs"; /** * Update Rules Configs */ readonly UpdateRulesConfigs: "update:rules_configs"; /** * Delete Rules Configs */ readonly DeleteRulesConfigs: "delete:rules_configs"; /** * Create Scim Config */ readonly CreateScimConfig: "create:scim_config"; /** * Read Scim Config */ readonly ReadScimConfig: "read:scim_config"; /** * Update Scim Config */ readonly UpdateScimConfig: "update:scim_config"; /** * Delete Scim Config */ readonly DeleteScimConfig: "delete:scim_config"; /** * Create Scim Token */ readonly CreateScimToken: "create:scim_token"; /** * Read Scim Token */ readonly ReadScimToken: "read:scim_token"; /** * Delete Scim Token */ readonly DeleteScimToken: "delete:scim_token"; /** * Read Self Service Profile Custom Texts */ readonly ReadSelfServiceProfileCustomTexts: "read:self_service_profile_custom_texts"; /** * Update Self Service Profile Custom Texts */ readonly UpdateSelfServiceProfileCustomTexts: "update:self_service_profile_custom_texts"; /** * Create Self Service Profiles */ readonly CreateSelfServiceProfiles: "create:self_service_profiles"; /** * Read Self Service Profiles */ readonly ReadSelfServiceProfiles: "read:self_service_profiles"; /** * Update Self Service Profiles */ readonly UpdateSelfServiceProfiles: "update:self_service_profiles"; /** * Delete Self Service Profiles */ readonly DeleteSelfServiceProfiles: "delete:self_service_profiles"; /** * Read Sessions */ readonly ReadSessions: "read:sessions"; /** * Update Sessions */ readonly UpdateSessions: "update:sessions"; /** * Delete Sessions */ readonly DeleteSessions: "delete:sessions"; /** * Create Signing Keys */ readonly CreateSigningKeys: "create:signing_keys"; /** * Read Signing Keys */ readonly ReadSigningKeys: "read:signing_keys"; /** * Update Signing Keys */ readonly UpdateSigningKeys: "update:signing_keys"; /** * Create Sso Access Tickets */ readonly CreateSsoAccessTickets: "create:sso_access_tickets"; /** * Delete Sso Access Tickets */ readonly DeleteSsoAccessTickets: "delete:sso_access_tickets"; /** * Read Stats */ readonly ReadStats: "read:stats"; /** * Read Tenant Settings */ readonly ReadTenantSettings: "read:tenant_settings"; /** * Update Tenant Settings */ readonly UpdateTenantSettings: "update:tenant_settings"; /** * Create Token Exchange Profiles */ readonly CreateTokenExchangeProfiles: "create:token_exchange_profiles"; /** * Read Token Exchange Profiles */ readonly ReadTokenExchangeProfiles: "read:token_exchange_profiles"; /** * Update Token Exchange Profiles */ readonly UpdateTokenExchangeProfiles: "update:token_exchange_profiles"; /** * Delete Token Exchange Profiles */ readonly DeleteTokenExchangeProfiles: "delete:token_exchange_profiles"; /** * Create User Attribute Profiles */ readonly CreateUserAttributeProfiles: "create:user_attribute_profiles"; /** * Read User Attribute Profiles */ readonly ReadUserAttributeProfiles: "read:user_attribute_profiles"; /** * Update User Attribute Profiles */ readonly UpdateUserAttributeProfiles: "update:user_attribute_profiles"; /** * Delete User Attribute Profiles */ readonly DeleteUserAttributeProfiles: "delete:user_attribute_profiles"; /** * Read User Idp Tokens */ readonly ReadUserIdpTokens: "read:user_idp_tokens"; /** * Create User Tickets */ readonly CreateUserTickets: "create:user_tickets"; /** * Create Users */ readonly CreateUsers: "create:users"; /** * Read Users */ readonly ReadUsers: "read:users"; /** * Update Users */ readonly UpdateUsers: "update:users"; /** * Delete Users */ readonly DeleteUsers: "delete:users"; /** * Update Users App Metadata */ readonly UpdateUsersAppMetadata: "update:users_app_metadata"; /** * Create Vdcs Templates */ readonly CreateVdcsTemplates: "create:vdcs_templates"; /** * Read Vdcs Templates */ readonly ReadVdcsTemplates: "read:vdcs_templates"; /** * Update Vdcs Templates */ readonly UpdateVdcsTemplates: "update:vdcs_templates"; /** * Delete Vdcs Templates */ readonly DeleteVdcsTemplates: "delete:vdcs_templates"; }; export type OauthScope = (typeof OauthScope)[keyof typeof OauthScope]; export interface Action { /** The unique ID of the action. */ id?: string | undefined; /** The name of an action. */ name?: string | undefined; /** The list of triggers that this action supports. At this time, an action can only target a single trigger at a time. */ supported_triggers?: Management.ActionTrigger[] | undefined; /** True if all of an Action's contents have been deployed. */ all_changes_deployed?: boolean | undefined; /** The time when this action was created. */ created_at?: string | undefined; /** The time when this action was updated. */ updated_at?: string | undefined; /** The source code of the action. */ code?: string | undefined; /** The list of third party npm modules, and their versions, that this action depends on. */ dependencies?: Management.ActionVersionDependency[] | undefined; /** The Node runtime. For example: `node22`, defaults to `node22` */ runtime?: string | undefined; /** The list of secrets that are included in an action or a version of an action. */ secrets?: Management.ActionSecretResponse[] | undefined; deployed_version?: Management.ActionDeployedVersion | undefined; /** installed_integration_id is the fk reference to the InstalledIntegration entity. */ installed_integration_id?: string | undefined; integration?: Management.Integration | undefined; status?: Management.ActionBuildStatusEnum | undefined; /** The time when this action was built successfully. */ built_at?: string | undefined; /** True if the action should be deployed after creation. */ deploy?: boolean | undefined; /** The list of action modules and their versions used by this action. */ modules?: Management.ActionModuleReference[] | undefined; } /** * The action to which this version belongs. */ export interface ActionBase { /** The unique ID of the action. */ id?: string | undefined; /** The name of an action. */ name?: string | undefined; /** The list of triggers that this action supports. At this time, an action can only target a single trigger at a time. */ supported_triggers?: Management.ActionTrigger[] | undefined; /** True if all of an Action's contents have been deployed. */ all_changes_deployed?: boolean | undefined; /** The time when this action was created. */ created_at?: string | undefined; /** The time when this action was updated. */ updated_at?: string | undefined; } /** * Binding is the associative entity joining a trigger, and an action together. */ export interface ActionBinding { /** The unique ID of this binding. */ id?: string | undefined; trigger_id?: Management.ActionTriggerTypeEnum | undefined; /** The name of the binding. */ display_name?: string | undefined; action?: Management.Action | undefined; /** The time when the binding was created. */ created_at?: string | undefined; /** The time when the binding was updated. */ updated_at?: string | undefined; } /** * A reference to an action. An action can be referred to by ID or by Name. */ export interface ActionBindingRef { type?: Management.ActionBindingRefTypeEnum | undefined; /** The id or name of an action that is being bound to a trigger. */ value?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** How the action is being referred to: `action_id` or `action_name`. */ export declare const ActionBindingRefTypeEnum: { readonly BindingId: "binding_id"; readonly ActionId: "action_id"; readonly ActionName: "action_name"; }; export type ActionBindingRefTypeEnum = (typeof ActionBindingRefTypeEnum)[keyof typeof ActionBindingRefTypeEnum]; /** In order to execute an Action, it must be bound to a trigger using a binding. `trigger-bound` means that bindings are managed by the tenant. `entity-bound` means that the bindings are automatically managed by Auth0 and other internal resouces will control those bindings. Tenants cannot manage `entity-bound` bindings. */ export declare const ActionBindingTypeEnum: { readonly TriggerBound: "trigger-bound"; readonly EntityBound: "entity-bound"; }; export type ActionBindingTypeEnum = (typeof ActionBindingTypeEnum)[keyof typeof ActionBindingTypeEnum]; export interface ActionBindingWithRef { ref: Management.ActionBindingRef; /** The name of the binding. */ display_name?: string | undefined; /** The list of secrets that are included in an action or a version of an action. */ secrets?: Management.ActionSecretRequest[] | undefined; } /** The build status of this action. */ export declare const ActionBuildStatusEnum: { readonly Pending: "pending"; readonly Building: "building"; readonly Packaged: "packaged"; readonly Built: "built"; readonly Retrying: "retrying"; readonly Failed: "failed"; }; export type ActionBuildStatusEnum = (typeof ActionBuildStatusEnum)[keyof typeof ActionBuildStatusEnum]; /** * The version of the action that is currently deployed. */ export interface ActionDeployedVersion { /** The unique id of an action version. */ id?: string | undefined; /** The id of the action to which this version belongs. */ action_id?: string | undefined; /** The source code of this specific version of the action. */ code?: string | undefined; /** The list of third party npm modules, and their versions, that this specific version depends on. */ dependencies?: Management.ActionVersionDependency[] | undefined; /** Indicates if this specific version is the currently one deployed. */ deployed?: boolean | undefined; /** The Node runtime. For example: `node22` */ runtime?: string | undefined; /** The list of secrets that are included in an action or a version of an action. */ secrets?: Management.ActionSecretResponse[] | undefined; status?: Management.ActionVersionBuildStatusEnum | undefined; /** The index of this version in list of versions for the action. */ number?: number | undefined; /** Any errors that occurred while the version was being built. */ errors?: Management.ActionError[] | undefined; action?: Management.ActionBase | undefined; /** The time when this version was built successfully. */ built_at?: string | undefined; /** The time when this version was created. */ created_at?: string | undefined; /** The time when a version was updated. Versions are never updated externally. Only Auth0 will update an action version as it is being built. */ updated_at?: string | undefined; /** The list of triggers that this version supports. At this time, a version can only target a single trigger at a time. */ supported_triggers?: Management.ActionTrigger[] | undefined; /** The list of action modules and their versions used by this action version. */ modules?: Management.ActionModuleReference[] | undefined; } /** * Error is a generic error with a human readable id which should be easily referenced in support tickets. */ export interface ActionError { id?: string | undefined; msg?: string | undefined; url?: string | undefined; } /** * Captures the results of a single action being executed. */ export interface ActionExecutionResult { /** The name of the action that was executed. */ action_name?: string | undefined; error?: Management.ActionError | undefined; /** The time when the action was started. */ started_at?: string | undefined; /** The time when the action finished executing. */ ended_at?: string | undefined; } /** The overall status of an execution. */ export declare const ActionExecutionStatusEnum: { readonly Unspecified: "unspecified"; readonly Pending: "pending"; readonly Final: "final"; readonly Partial: "partial"; readonly Canceled: "canceled"; readonly Suspended: "suspended"; }; export type ActionExecutionStatusEnum = (typeof ActionExecutionStatusEnum)[keyof typeof ActionExecutionStatusEnum]; export interface ActionModuleAction { /** The unique ID of the action. */ action_id?: string | undefined; /** The name of the action. */ action_name?: string | undefined; /** The ID of the module version this action is using. */ module_version_id?: string | undefined; /** The version number of the module this action is using. */ module_version_number?: number | undefined; /** The triggers that this action supports. */ supported_triggers?: Management.ActionTrigger[] | undefined; } export interface ActionModuleDependency { /** The name of the npm dependency. */ name?: string | undefined; /** The version of the npm dependency. */ version?: string | undefined; } export interface ActionModuleDependencyRequest { /** The name of the npm dependency. */ name: string; /** The version of the npm dependency. */ version: string; } export interface ActionModuleListItem { /** The unique ID of the module. */ id?: string | undefined; /** The name of the module. */ name?: string | undefined; /** The source code from the module's draft version. */ code?: string | undefined; /** The npm dependencies from the module's draft version. */ dependencies?: Management.ActionModuleDependency[] | undefined; /** The secrets from the module's draft version (names and timestamps only, values never returned). */ secrets?: Management.ActionModuleSecret[] | undefined; /** The number of deployed actions using this module. */ actions_using_module_total?: number | undefined; /** Whether all draft changes have been published as a version. */ all_changes_published?: boolean | undefined; /** The version number of the latest published version. Omitted if no versions have been published. */ latest_version_number?: number | undefined; /** Timestamp when the module was created. */ created_at?: string | undefined; /** Timestamp when the module was last updated. */ updated_at?: string | undefined; } /** * Reference to a module and its version used by an action. */ export interface ActionModuleReference { /** The unique ID of the module. */ module_id?: string | undefined; /** The name of the module. */ module_name?: string | undefined; /** The ID of the specific module version. */ module_version_id?: string | undefined; /** The version number of the module. */ module_version_number?: number | undefined; } export interface ActionModuleSecret { /** The name of the secret. */ name?: string | undefined; /** The time when the secret was last updated. */ updated_at?: string | undefined; } export interface ActionModuleSecretRequest { /** The name of the secret. */ name: string; /** The value of the secret. */ value: string; } export interface ActionModuleVersion { /** The unique ID for this version. */ id?: string | undefined; /** The ID of the parent module. */ module_id?: string | undefined; /** The sequential version number. */ version_number?: number | undefined; /** The exact source code that was published with this version. */ code?: string | undefined; /** Secrets available to this version (name and updated_at only, values never returned). */ secrets?: Management.ActionModuleSecret[] | undefined; /** Dependencies locked to this version. */ dependencies?: Management.ActionModuleDependency[] | undefined; /** The timestamp when this version was created. */ created_at?: string | undefined; } /** * The latest published version as a reference object. Omitted if no versions have been published. */ export interface ActionModuleVersionReference { /** The unique ID of the version. */ id?: string | undefined; /** The version number. */ version_number?: number | undefined; /** The source code from this version. */ code?: string | undefined; /** The npm dependencies from this version. */ dependencies?: Management.ActionModuleDependency[] | undefined; /** The secrets from this version (names and timestamps only, values never returned). */ secrets?: Management.ActionModuleSecret[] | undefined; /** Timestamp when the version was created. */ created_at?: string | undefined; } export interface ActionSecretRequest { /** The name of the particular secret, e.g. API_KEY. */ name?: string | undefined; /** The value of the particular secret, e.g. secret123. A secret's value can only be set upon creation. A secret's value will never be returned by the API. */ value?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface ActionSecretResponse { /** The name of the particular secret, e.g. API_KEY. */ name?: string | undefined; /** The time when the secret was last updated. */ updated_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface ActionTrigger { id: Management.ActionTriggerTypeEnum; /** The version of a trigger. v1, v2, etc. */ version?: string | undefined; /** status points to the trigger status. */ status?: string | undefined; /** runtimes supported by this trigger. */ runtimes?: string[] | undefined; /** Runtime that will be used when none is specified when creating an action. */ default_runtime?: string | undefined; /** compatible_triggers informs which other trigger supports the same event and api. */ compatible_triggers?: Management.ActionTriggerCompatibleTrigger[] | undefined; binding_policy?: Management.ActionBindingTypeEnum | undefined; } export interface ActionTriggerCompatibleTrigger { id: Management.ActionTriggerTypeEnum; /** The version of a trigger. v1, v2, etc. */ version: string; /** Accepts any additional properties */ [key: string]: any; } /** An actions extensibility point. */ export declare const ActionTriggerTypeEnum: { readonly PostLogin: "post-login"; readonly CredentialsExchange: "credentials-exchange"; readonly PreUserRegistration: "pre-user-registration"; readonly PostUserRegistration: "post-user-registration"; readonly PostChangePassword: "post-change-password"; readonly SendPhoneMessage: "send-phone-message"; readonly CustomPhoneProvider: "custom-phone-provider"; readonly CustomEmailProvider: "custom-email-provider"; readonly PasswordResetPostChallenge: "password-reset-post-challenge"; readonly CustomTokenExchange: "custom-token-exchange"; readonly EventStream: "event-stream"; readonly PasswordHashMigration: "password-hash-migration"; readonly LoginPostIdentifier: "login-post-identifier"; readonly SignupPostIdentifier: "signup-post-identifier"; }; export type ActionTriggerTypeEnum = (typeof ActionTriggerTypeEnum)[keyof typeof ActionTriggerTypeEnum]; export interface ActionVersion { /** The unique id of an action version. */ id?: string | undefined; /** The id of the action to which this version belongs. */ action_id?: string | undefined; /** The source code of this specific version of the action. */ code?: string | undefined; /** The list of third party npm modules, and their versions, that this specific version depends on. */ dependencies?: Management.ActionVersionDependency[] | undefined; /** Indicates if this specific version is the currently one deployed. */ deployed?: boolean | undefined; /** The Node runtime. For example: `node22` */ runtime?: string | undefined; /** The list of secrets that are included in an action or a version of an action. */ secrets?: Management.ActionSecretResponse[] | undefined; status?: Management.ActionVersionBuildStatusEnum | undefined; /** The index of this version in list of versions for the action. */ number?: number | undefined; /** Any errors that occurred while the version was being built. */ errors?: Management.ActionError[] | undefined; action?: Management.ActionBase | undefined; /** The time when this version was built successfully. */ built_at?: string | undefined; /** The time when this version was created. */ created_at?: string | undefined; /** The time when a version was updated. Versions are never updated externally. Only Auth0 will update an action version as it is being built. */ updated_at?: string | undefined; /** The list of triggers that this version supports. At this time, a version can only target a single trigger at a time. */ supported_triggers?: Management.ActionTrigger[] | undefined; /** The list of action modules and their versions used by this action version. */ modules?: Management.ActionModuleReference[] | undefined; } /** The build status of this specific version. */ export declare const ActionVersionBuildStatusEnum: { readonly Pending: "pending"; readonly Building: "building"; readonly Packaged: "packaged"; readonly Built: "built"; readonly Retrying: "retrying"; readonly Failed: "failed"; }; export type ActionVersionBuildStatusEnum = (typeof ActionVersionBuildStatusEnum)[keyof typeof ActionVersionBuildStatusEnum]; /** * Dependency is an npm module. These values are used to produce an immutable artifact, which manifests as a layer_id. */ export interface ActionVersionDependency { /** name is the name of the npm module, e.g. lodash */ name?: string | undefined; /** description is the version of the npm module, e.g. 4.17.1 */ version?: string | undefined; /** registry_url is an optional value used primarily for private npm registries. */ registry_url?: string | undefined; } /** * Client array filter items */ export type AculClientFilter = Management.AculClientFilterById | Management.AculClientFilterByMetadata; export interface AculClientFilterById { /** Client ID */ id: string; } export interface AculClientFilterByMetadata { metadata: Management.AculClientMetadata; } /** * Client metadata key/value pairs */ export type AculClientMetadata = Record; export interface AculConfigsItem { prompt: Management.PromptGroupNameEnum; screen: Management.ScreenGroupNameEnum; /** Rendering mode */ rendering_mode?: Management.AculRenderingModeEnum | undefined; context_configuration?: ((Management.AculContextConfiguration | undefined) | null) | undefined; /** Override Universal Login default head tags */ default_head_tags_disabled?: (boolean | null) | undefined; /** Use page template with ACUL */ use_page_template?: (boolean | null) | undefined; /** An array of head tags */ head_tags?: (Management.AculHeadTag[] | null) | undefined; filters?: (Management.AculFilters | null) | undefined; } /** * Array of screen configurations to update */ export type AculConfigs = Management.AculConfigsItem[]; /** * Context values to make available */ export type AculContextConfiguration = (Management.AculContextConfigurationItem[] | null) | undefined; export type AculContextConfigurationItem = Management.AculContextEnum /** * Dynamic authorization param ext key (e.g., `untrusted_data.authorization_params.ext-myKey`) */ | string; /** Static context values */ export declare const AculContextEnum: { readonly BrandingSettings: "branding.settings"; readonly BrandingThemesDefault: "branding.themes.default"; readonly ClientLogoUri: "client.logo_uri"; readonly ClientDescription: "client.description"; readonly OrganizationDisplayName: "organization.display_name"; readonly OrganizationBranding: "organization.branding"; readonly ScreenTexts: "screen.texts"; readonly TenantName: "tenant.name"; readonly TenantFriendlyName: "tenant.friendly_name"; readonly TenantLogoUrl: "tenant.logo_url"; readonly TenantEnabledLocales: "tenant.enabled_locales"; readonly UntrustedDataSubmittedFormData: "untrusted_data.submitted_form_data"; readonly UntrustedDataAuthorizationParamsLoginHint: "untrusted_data.authorization_params.login_hint"; readonly UntrustedDataAuthorizationParamsScreenHint: "untrusted_data.authorization_params.screen_hint"; readonly UntrustedDataAuthorizationParamsUiLocales: "untrusted_data.authorization_params.ui_locales"; readonly UserOrganizations: "user.organizations"; readonly TransactionCustomDomainDomain: "transaction.custom_domain.domain"; }; export type AculContextEnum = (typeof AculContextEnum)[keyof typeof AculContextEnum]; /** * Domains array filter items */ export type AculDomainFilter = Management.AculDomainFilterById | Management.AculDomainFilterByMetadata; export interface AculDomainFilterById { /** Domain ID */ id: string; } export interface AculDomainFilterByMetadata { metadata: Management.AculDomainMetadata; } /** * Domain metadata key/value pairs */ export type AculDomainMetadata = Record; /** * Optional filters to apply rendering rules to specific entities */ export interface AculFilters { match_type?: Management.AculMatchTypeEnum | undefined; /** Clients filter */ clients?: Management.AculClientFilter[] | undefined; /** Organizations filter */ organizations?: Management.AculOrganizationFilter[] | undefined; /** Domains filter */ domains?: Management.AculDomainFilter[] | undefined; } export interface AculHeadTag { /** Any HTML element valid for use in the head tag */ tag?: string | undefined; attributes?: Management.AculHeadTagAttributes | undefined; content?: Management.AculHeadTagContent | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Attributes of the HTML tag. See MDN documentation for valid attributes. */ export type AculHeadTagAttributes = Record; /** * Text or markup between the element’s opening and closing tags. * You can use context variables to display dynamic values. */ export type AculHeadTagContent = string; /** Type of match to apply */ export declare const AculMatchTypeEnum: { readonly IncludesAny: "includes_any"; readonly ExcludesAny: "excludes_any"; }; export type AculMatchTypeEnum = (typeof AculMatchTypeEnum)[keyof typeof AculMatchTypeEnum]; /** * Organizations array filter items */ export type AculOrganizationFilter = Management.AculOrganizationFilterById | Management.AculOrganizationFilterByMetadata; export interface AculOrganizationFilterById { /** Organization ID */ id: string; } export interface AculOrganizationFilterByMetadata { metadata: Management.AculOrganizationMetadata; } /** * Organization metadata key/value pairs */ export type AculOrganizationMetadata = Record; /** Rendering mode to filter by */ export declare const AculRenderingModeEnum: { readonly Advanced: "advanced"; readonly Standard: "standard"; }; export type AculRenderingModeEnum = (typeof AculRenderingModeEnum)[keyof typeof AculRenderingModeEnum]; export interface AddOrganizationConnectionResponseContent { /** ID of the connection. */ connection_id?: string | undefined; /** 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. */ assign_membership_on_login?: boolean | undefined; /** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */ show_as_button?: boolean | undefined; /** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */ is_signup_enabled?: boolean | undefined; connection?: Management.OrganizationConnectionInformation | undefined; } /** * IP address to check. */ export type AnomalyIpFormat = string; /** * Data related to the user that does affect the application's core functionality. */ export type AppMetadata = Record; /** Assessors to clear. */ export declare const AssessorsTypeEnum: { readonly NewDevice: "new-device"; }; export type AssessorsTypeEnum = (typeof AssessorsTypeEnum)[keyof typeof AssessorsTypeEnum]; export interface AssociateOrganizationClientGrantResponseContent { /** ID of the client grant. */ id?: string | undefined; /** ID of the client. */ client_id?: string | undefined; /** The audience (API identifier) of this client grant */ audience?: string | undefined; /** Scopes allowed for this client grant. */ scope?: string[] | undefined; organization_usage?: Management.OrganizationUsageEnum | undefined; /** If enabled, any organization can be used with this grant. If disabled (default), the grant must be explicitly assigned to the desired organizations. */ allow_any_organization?: boolean | undefined; } export declare const AsyncApprovalNotificationsChannelsEnum: { readonly GuardianPush: "guardian-push"; readonly Email: "email"; }; export type AsyncApprovalNotificationsChannelsEnum = (typeof AsyncApprovalNotificationsChannelsEnum)[keyof typeof AsyncApprovalNotificationsChannelsEnum]; export interface AttackProtectionCaptchaArkoseResponseContent { /** The site key for the Arkose captcha provider. */ site_key?: string | undefined; /** Whether the captcha should fail open. */ fail_open?: boolean | undefined; /** The subdomain used for client requests to the Arkose captcha provider. */ client_subdomain?: string | undefined; /** The subdomain used for server-side verification requests to the Arkose captcha provider. */ verify_subdomain?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface AttackProtectionCaptchaAuthChallengeRequest { /** Whether the auth challenge should fail open. */ fail_open: boolean; } export interface AttackProtectionCaptchaAuthChallengeResponseContent { /** Whether the auth challenge should fail open. */ fail_open?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface AttackProtectionCaptchaFriendlyCaptchaResponseContent { /** The site key for the Friendly Captcha provider. */ site_key?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface AttackProtectionCaptchaHcaptchaResponseContent { /** The site key for the hCaptcha provider. */ site_key?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** The id of the active provider for the CAPTCHA. */ export declare const AttackProtectionCaptchaProviderId: { readonly Arkose: "arkose"; readonly AuthChallenge: "auth_challenge"; readonly FriendlyCaptcha: "friendly_captcha"; readonly Hcaptcha: "hcaptcha"; readonly RecaptchaV2: "recaptcha_v2"; readonly RecaptchaEnterprise: "recaptcha_enterprise"; readonly SimpleCaptcha: "simple_captcha"; }; export type AttackProtectionCaptchaProviderId = (typeof AttackProtectionCaptchaProviderId)[keyof typeof AttackProtectionCaptchaProviderId]; export interface AttackProtectionCaptchaRecaptchaEnterpriseResponseContent { /** The site key for the reCAPTCHA Enterprise provider. */ site_key?: string | undefined; /** The project ID for the reCAPTCHA Enterprise provider. */ project_id?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface AttackProtectionCaptchaRecaptchaV2ResponseContent { /** The site key for the reCAPTCHA v2 provider. */ site_key?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export type AttackProtectionCaptchaSimpleCaptchaResponseContent = Record; export interface AttackProtectionUpdateCaptchaArkose { /** The site key for the Arkose captcha provider. */ site_key: string; /** The secret key for the Arkose captcha provider. */ secret: string; /** The subdomain used for client requests to the Arkose captcha provider. */ client_subdomain?: string | undefined; /** The subdomain used for server-side verification requests to the Arkose captcha provider. */ verify_subdomain?: string | undefined; /** Whether the captcha should fail open. */ fail_open?: boolean | undefined; } export interface AttackProtectionUpdateCaptchaFriendlyCaptcha { /** The site key for the Friendly Captcha provider. */ site_key: string; /** The secret key for the Friendly Captcha provider. */ secret: string; } export interface AttackProtectionUpdateCaptchaHcaptcha { /** The site key for the hCaptcha provider. */ site_key: string; /** The secret key for the hCaptcha provider. */ secret: string; } export interface AttackProtectionUpdateCaptchaRecaptchaEnterprise { /** The site key for the reCAPTCHA Enterprise provider. */ site_key: string; /** The API key for the reCAPTCHA Enterprise provider. */ api_key: string; /** The project ID for the reCAPTCHA Enterprise provider. */ project_id: string; } export interface AttackProtectionUpdateCaptchaRecaptchaV2 { /** The site key for the reCAPTCHA v2 provider. */ site_key: string; /** The secret key for the reCAPTCHA v2 provider. */ secret: string; } export declare const AuthenticationMethodTypeEnum: { readonly RecoveryCode: "recovery-code"; readonly Totp: "totp"; readonly Push: "push"; readonly Phone: "phone"; readonly Email: "email"; readonly EmailVerification: "email-verification"; readonly WebauthnRoaming: "webauthn-roaming"; readonly WebauthnPlatform: "webauthn-platform"; readonly Guardian: "guardian"; readonly Passkey: "passkey"; readonly Password: "password"; }; export type AuthenticationMethodTypeEnum = (typeof AuthenticationMethodTypeEnum)[keyof typeof AuthenticationMethodTypeEnum]; export declare const AuthenticationTypeEnum: { readonly Phone: "phone"; readonly Email: "email"; readonly Totp: "totp"; }; export type AuthenticationTypeEnum = (typeof AuthenticationTypeEnum)[keyof typeof AuthenticationTypeEnum]; /** * List of IP addresses or CIDR blocks to allowlist */ export type BotDetectionAllowlist = Management.BotDetectionIpAddressOrCidrBlock[]; /** The policy that defines how often to show CAPTCHA */ export declare const BotDetectionChallengePolicyPasswordFlowEnum: { readonly Never: "never"; readonly WhenRisky: "when_risky"; readonly Always: "always"; }; export type BotDetectionChallengePolicyPasswordFlowEnum = (typeof BotDetectionChallengePolicyPasswordFlowEnum)[keyof typeof BotDetectionChallengePolicyPasswordFlowEnum]; /** The policy that defines how often to show CAPTCHA */ export declare const BotDetectionChallengePolicyPasswordResetFlowEnum: { readonly Never: "never"; readonly WhenRisky: "when_risky"; readonly Always: "always"; }; export type BotDetectionChallengePolicyPasswordResetFlowEnum = (typeof BotDetectionChallengePolicyPasswordResetFlowEnum)[keyof typeof BotDetectionChallengePolicyPasswordResetFlowEnum]; /** The policy that defines how often to show CAPTCHA */ export declare const BotDetectionChallengePolicyPasswordlessFlowEnum: { readonly Never: "never"; readonly WhenRisky: "when_risky"; readonly Always: "always"; }; export type BotDetectionChallengePolicyPasswordlessFlowEnum = (typeof BotDetectionChallengePolicyPasswordlessFlowEnum)[keyof typeof BotDetectionChallengePolicyPasswordlessFlowEnum]; /** * CIDR block */ export type BotDetectionCidrBlock = string; /** * IP address (IPv4 or IPv6) or CIDR block */ export type BotDetectionIpAddressOrCidrBlock = string; /** * IPv4 address */ export type BotDetectionIPv4 = string; /** * IPv6 address */ export type BotDetectionIPv6 = string; /** * IPv6 CIDR block */ export type BotDetectionIPv6CidrBlock = string; /** The level of bot detection sensitivity */ export declare const BotDetectionLevelEnum: { readonly Low: "low"; readonly Medium: "medium"; readonly High: "high"; }; export type BotDetectionLevelEnum = (typeof BotDetectionLevelEnum)[keyof typeof BotDetectionLevelEnum]; /** * Whether monitoring mode is enabled (logs but does not block) */ export type BotDetectionMonitoringModeEnabled = boolean; /** * Custom color settings. */ export interface BrandingColors { /** Accent color. */ primary?: string | undefined; page_background?: Management.BrandingPageBackground | undefined; } /** * Custom font settings. */ export interface BrandingFont { /** URL for the custom font. The URL must point to a font file and not a stylesheet. Must use HTTPS. */ url?: string | undefined; } /** * Page Background Color or Gradient. * Property contains either null to unset, a solid color as a string value #FFFFFF, or a gradient as an object. * * 

 * {
 *   type: 'linear-gradient',
 *   start: '#FFFFFF',
 *   end: '#000000',
 *   angle_deg: 35
 * }
 *
*/ export type BrandingPageBackground = (string | null) | undefined | (Record | null) | undefined; export interface BrandingThemeBorders { /** Button border radius */ button_border_radius: number; /** Button border weight */ button_border_weight: number; buttons_style: Management.BrandingThemeBordersButtonsStyleEnum; /** Input border radius */ input_border_radius: number; /** Input border weight */ input_border_weight: number; inputs_style: Management.BrandingThemeBordersInputsStyleEnum; /** Show widget shadow */ show_widget_shadow: boolean; /** Widget border weight */ widget_border_weight: number; /** Widget corner radius */ widget_corner_radius: number; } /** Buttons style */ export declare const BrandingThemeBordersButtonsStyleEnum: { readonly Pill: "pill"; readonly Rounded: "rounded"; readonly Sharp: "sharp"; }; export type BrandingThemeBordersButtonsStyleEnum = (typeof BrandingThemeBordersButtonsStyleEnum)[keyof typeof BrandingThemeBordersButtonsStyleEnum]; /** Inputs style */ export declare const BrandingThemeBordersInputsStyleEnum: { readonly Pill: "pill"; readonly Rounded: "rounded"; readonly Sharp: "sharp"; }; export type BrandingThemeBordersInputsStyleEnum = (typeof BrandingThemeBordersInputsStyleEnum)[keyof typeof BrandingThemeBordersInputsStyleEnum]; export interface BrandingThemeColors { /** Base Focus Color */ base_focus_color?: string | undefined; /** Base Hover Color */ base_hover_color?: string | undefined; /** Body text */ body_text: string; captcha_widget_theme?: Management.BrandingThemeColorsCaptchaWidgetThemeEnum | undefined; /** Error */ error: string; /** Header */ header: string; /** Icons */ icons: string; /** Input background */ input_background: string; /** Input border */ input_border: string; /** Input filled text */ input_filled_text: string; /** Input labels & placeholders */ input_labels_placeholders: string; /** Links & focused components */ links_focused_components: string; /** Primary button */ primary_button: string; /** Primary button label */ primary_button_label: string; /** Read only background */ read_only_background?: string | undefined; /** Secondary button border */ secondary_button_border: string; /** Secondary button label */ secondary_button_label: string; /** Success */ success: string; /** Widget background */ widget_background: string; /** Widget border */ widget_border: string; } /** Captcha Widget Theme */ export declare const BrandingThemeColorsCaptchaWidgetThemeEnum: { readonly Auto: "auto"; readonly Dark: "dark"; readonly Light: "light"; }; export type BrandingThemeColorsCaptchaWidgetThemeEnum = (typeof BrandingThemeColorsCaptchaWidgetThemeEnum)[keyof typeof BrandingThemeColorsCaptchaWidgetThemeEnum]; /** * Body text */ export interface BrandingThemeFontBodyText { /** Body text bold */ bold: boolean; /** Body text size */ size: number; } /** * Buttons text */ export interface BrandingThemeFontButtonsText { /** Buttons text bold */ bold: boolean; /** Buttons text size */ size: number; } /** * Input Labels */ export interface BrandingThemeFontInputLabels { /** Input Labels bold */ bold: boolean; /** Input Labels size */ size: number; } /** * Links */ export interface BrandingThemeFontLinks { /** Links bold */ bold: boolean; /** Links size */ size: number; } /** Links style */ export declare const BrandingThemeFontLinksStyleEnum: { readonly Normal: "normal"; readonly Underlined: "underlined"; }; export type BrandingThemeFontLinksStyleEnum = (typeof BrandingThemeFontLinksStyleEnum)[keyof typeof BrandingThemeFontLinksStyleEnum]; /** * Subtitle */ export interface BrandingThemeFontSubtitle { /** Subtitle bold */ bold: boolean; /** Subtitle size */ size: number; } /** * Title */ export interface BrandingThemeFontTitle { /** Title bold */ bold: boolean; /** Title size */ size: number; } export interface BrandingThemeFonts { body_text: Management.BrandingThemeFontBodyText; buttons_text: Management.BrandingThemeFontButtonsText; /** Font URL */ font_url: string; input_labels: Management.BrandingThemeFontInputLabels; links: Management.BrandingThemeFontLinks; links_style: Management.BrandingThemeFontLinksStyleEnum; /** Reference text size */ reference_text_size: number; subtitle: Management.BrandingThemeFontSubtitle; title: Management.BrandingThemeFontTitle; } export interface BrandingThemePageBackground { /** Background color */ background_color: string; /** Background image url */ background_image_url: string; page_layout: Management.BrandingThemePageBackgroundPageLayoutEnum; } /** Page Layout */ export declare const BrandingThemePageBackgroundPageLayoutEnum: { readonly Center: "center"; readonly Left: "left"; readonly Right: "right"; }; export type BrandingThemePageBackgroundPageLayoutEnum = (typeof BrandingThemePageBackgroundPageLayoutEnum)[keyof typeof BrandingThemePageBackgroundPageLayoutEnum]; export interface BrandingThemeWidget { header_text_alignment: Management.BrandingThemeWidgetHeaderTextAlignmentEnum; /** Logo height */ logo_height: number; logo_position: Management.BrandingThemeWidgetLogoPositionEnum; /** Logo url */ logo_url: string; social_buttons_layout: Management.BrandingThemeWidgetSocialButtonsLayoutEnum; } /** Header text alignment */ export declare const BrandingThemeWidgetHeaderTextAlignmentEnum: { readonly Center: "center"; readonly Left: "left"; readonly Right: "right"; }; export type BrandingThemeWidgetHeaderTextAlignmentEnum = (typeof BrandingThemeWidgetHeaderTextAlignmentEnum)[keyof typeof BrandingThemeWidgetHeaderTextAlignmentEnum]; /** Logo position */ export declare const BrandingThemeWidgetLogoPositionEnum: { readonly Center: "center"; readonly Left: "left"; readonly None: "none"; readonly Right: "right"; }; export type BrandingThemeWidgetLogoPositionEnum = (typeof BrandingThemeWidgetLogoPositionEnum)[keyof typeof BrandingThemeWidgetLogoPositionEnum]; /** Social buttons layout */ export declare const BrandingThemeWidgetSocialButtonsLayoutEnum: { readonly Bottom: "bottom"; readonly Top: "top"; }; export type BrandingThemeWidgetSocialButtonsLayoutEnum = (typeof BrandingThemeWidgetSocialButtonsLayoutEnum)[keyof typeof BrandingThemeWidgetSocialButtonsLayoutEnum]; export declare const BreachedPasswordDetectionAdminNotificationFrequencyEnum: { readonly Immediately: "immediately"; readonly Daily: "daily"; readonly Weekly: "weekly"; readonly Monthly: "monthly"; }; export type BreachedPasswordDetectionAdminNotificationFrequencyEnum = (typeof BreachedPasswordDetectionAdminNotificationFrequencyEnum)[keyof typeof BreachedPasswordDetectionAdminNotificationFrequencyEnum]; /** * The subscription level for breached password detection methods. Use "enhanced" to enable Credential Guard. * Possible values: standard, enhanced. */ export declare const BreachedPasswordDetectionMethodEnum: { readonly Standard: "standard"; readonly Enhanced: "enhanced"; }; export type BreachedPasswordDetectionMethodEnum = (typeof BreachedPasswordDetectionMethodEnum)[keyof typeof BreachedPasswordDetectionMethodEnum]; export declare const BreachedPasswordDetectionPreChangePasswordShieldsEnum: { readonly Block: "block"; readonly AdminNotification: "admin_notification"; }; export type BreachedPasswordDetectionPreChangePasswordShieldsEnum = (typeof BreachedPasswordDetectionPreChangePasswordShieldsEnum)[keyof typeof BreachedPasswordDetectionPreChangePasswordShieldsEnum]; export interface BreachedPasswordDetectionPreChangePasswordStage { /** * Action to take when a breached password is detected during a password reset. * Possible values: block, admin_notification. */ shields?: Management.BreachedPasswordDetectionPreChangePasswordShieldsEnum[] | undefined; } export declare const BreachedPasswordDetectionPreUserRegistrationShieldsEnum: { readonly Block: "block"; readonly AdminNotification: "admin_notification"; }; export type BreachedPasswordDetectionPreUserRegistrationShieldsEnum = (typeof BreachedPasswordDetectionPreUserRegistrationShieldsEnum)[keyof typeof BreachedPasswordDetectionPreUserRegistrationShieldsEnum]; export interface BreachedPasswordDetectionPreUserRegistrationStage { /** * Action to take when a breached password is detected during a signup. * Possible values: block, admin_notification. */ shields?: Management.BreachedPasswordDetectionPreUserRegistrationShieldsEnum[] | undefined; } export declare const BreachedPasswordDetectionShieldsEnum: { readonly Block: "block"; readonly UserNotification: "user_notification"; readonly AdminNotification: "admin_notification"; }; export type BreachedPasswordDetectionShieldsEnum = (typeof BreachedPasswordDetectionShieldsEnum)[keyof typeof BreachedPasswordDetectionShieldsEnum]; export interface BreachedPasswordDetectionStage { "pre-user-registration"?: Management.BreachedPasswordDetectionPreUserRegistrationStage | undefined; "pre-change-password"?: Management.BreachedPasswordDetectionPreChangePasswordStage | undefined; } /** * Account Lockout: Determines whether or not IP address is used when counting failed attempts. * Possible values: count_per_identifier_and_ip, count_per_identifier. */ export declare const BruteForceProtectionModeEnum: { readonly CountPerIdentifierAndIp: "count_per_identifier_and_ip"; readonly CountPerIdentifier: "count_per_identifier"; }; export type BruteForceProtectionModeEnum = (typeof BruteForceProtectionModeEnum)[keyof typeof BruteForceProtectionModeEnum]; export declare const BruteForceProtectionShieldsEnum: { readonly Block: "block"; readonly UserNotification: "user_notification"; }; export type BruteForceProtectionShieldsEnum = (typeof BruteForceProtectionShieldsEnum)[keyof typeof BruteForceProtectionShieldsEnum]; export interface BulkUpdateAculResponseContent { configs: Management.AculConfigs; /** Accepts any additional properties */ [key: string]: any; } export interface CertificateSubjectDnCredential { credential_type: Management.CertificateSubjectDnCredentialTypeEnum; /** Friendly name for a credential. */ name?: string | undefined; /** Subject Distinguished Name. Mutually exclusive with `pem` property. Applies to `cert_subject_dn` credential type. */ subject_dn?: string | undefined; /** PEM-formatted X509 certificate. Must be JSON escaped. Mutually exclusive with `subject_dn` property. */ pem?: string | undefined; } export declare const CertificateSubjectDnCredentialTypeEnum: { readonly CertSubjectDn: "cert_subject_dn"; }; export type CertificateSubjectDnCredentialTypeEnum = (typeof CertificateSubjectDnCredentialTypeEnum)[keyof typeof CertificateSubjectDnCredentialTypeEnum]; /** * The user's identity. If you set this value, you must also send the user_id parameter. */ export interface ChangePasswordTicketIdentity { /** user_id of the identity. */ user_id: string; provider: Management.IdentityProviderOnlyAuth0Enum; /** connection_id of the identity. */ connection_id?: string | undefined; } export interface ChangePasswordTicketResponseContent { /** URL representing the ticket. */ ticket: string; /** Accepts any additional properties */ [key: string]: any; } /** * Client authentication methods derived from the JWKS document */ export interface CimdMappedClientAuthenticationMethods { private_key_jwt?: Management.CimdMappedClientAuthenticationMethodsPrivateKeyJwt | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Private Key JWT authentication configuration */ export interface CimdMappedClientAuthenticationMethodsPrivateKeyJwt { /** Credentials derived from the JWKS document */ credentials: Management.CimdMappedPrivateKeyJwtCredential[]; /** Accepts any additional properties */ [key: string]: any; } /** * Auth0 client fields mapped from the Client ID Metadata Document */ export interface CimdMappedClientFields { /** The URL of the Client ID Metadata Document */ external_client_id?: string | undefined; /** Client name */ name?: string | undefined; /** Application type (e.g., web, native) */ app_type?: string | undefined; /** Callback URLs */ callbacks?: string[] | undefined; /** Logo URI */ logo_uri?: string | undefined; /** Human-readable brief description of this client presentable to the end-user */ description?: string | undefined; /** List of grant types */ grant_types?: string[] | undefined; /** Token endpoint authentication method */ token_endpoint_auth_method?: string | undefined; /** URL for the JSON Web Key Set containing the public keys for private_key_jwt authentication */ jwks_uri?: string | undefined; client_authentication_methods?: Management.CimdMappedClientAuthenticationMethods | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface CimdMappedPrivateKeyJwtCredential { /** Type of credential (e.g., public_key) */ credential_type: string; /** Key identifier from JWKS or calculated thumbprint */ kid: string; /** Algorithm (e.g., RS256, RS384, PS256) */ alg: string; /** Accepts any additional properties */ [key: string]: any; } /** * Validation result for the Client ID Metadata Document */ export interface CimdValidationResult { /** Whether the metadata document passed validation */ valid: boolean; /** Array of validation violation messages (if any) */ violations: string[]; /** Array of warning messages (if any) */ warnings: string[]; /** Accepts any additional properties */ [key: string]: any; } export interface Client { /** ID of this client. */ client_id?: string | undefined; /** Name of the tenant this client belongs to. */ tenant?: string | undefined; /** Name of this client (min length: 1 character, does not allow `<` or `>`). */ name?: string | undefined; /** Free text description of this client (max length: 140 characters). */ description?: string | undefined; /** Whether this is your global 'All Applications' client representing legacy tenant settings (true) or a regular client (false). */ global?: boolean | undefined; /** Client secret (which you must not make public). */ client_secret?: string | undefined; app_type?: Management.ClientAppTypeEnum | undefined; /** URL of the logo to display for this client. Recommended size is 150x150 pixels. */ logo_uri?: string | undefined; /** Whether this client a first party client (true) or not (false). */ is_first_party?: boolean | undefined; /** Whether this client conforms to strict OIDC specifications (true) or uses legacy features (false). */ oidc_conformant?: boolean | undefined; /** Comma-separated list of URLs whitelisted for Auth0 to use as a callback to the client after authentication. */ callbacks?: string[] | undefined; /** Comma-separated list of URLs allowed to make requests from JavaScript to Auth0 API (typically used with CORS). By default, all your callback URLs will be allowed. This field allows you to enter other origins if necessary. You can also use wildcards at the subdomain level (e.g., https://*.contoso.com). Query strings and hash information are not taken into account when validating these URLs. */ allowed_origins?: string[] | undefined; /** Comma-separated list of allowed origins for use with Cross-Origin Authentication, Device Flow, and web message response mode. */ web_origins?: string[] | undefined; /** List of audiences/realms for SAML protocol. Used by the wsfed addon. */ client_aliases?: string[] | undefined; /** List of allow clients and API ids that are allowed to make delegation requests. Empty means all all your clients are allowed. */ allowed_clients?: string[] | undefined; /** Comma-separated list of URLs that are valid to redirect to after logout from Auth0. Wildcards are allowed for subdomains. */ allowed_logout_urls?: string[] | undefined; session_transfer?: (Management.ClientSessionTransferConfiguration | null) | undefined; oidc_logout?: Management.ClientOidcBackchannelLogoutSettings | undefined; /** List of grant types supported for this application. Can include `authorization_code`, `implicit`, `refresh_token`, `client_credentials`, `password`, `http://auth0.com/oauth/grant-type/password-realm`, `http://auth0.com/oauth/grant-type/mfa-oob`, `http://auth0.com/oauth/grant-type/mfa-otp`, `http://auth0.com/oauth/grant-type/mfa-recovery-code`, `urn:openid:params:grant-type:ciba`, `urn:ietf:params:oauth:grant-type:device_code`, and `urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token`. */ grant_types?: string[] | undefined; jwt_configuration?: Management.ClientJwtConfiguration | undefined; signing_keys?: ((Management.ClientSigningKeys | undefined) | null) | undefined; encryption_key?: (Management.ClientEncryptionKey | null) | undefined; /** Applies only to SSO clients and determines whether Auth0 will handle Single Sign On (true) or whether the Identity Provider will (false). */ sso?: boolean | undefined; /** Whether Single Sign On is disabled (true) or enabled (true). Defaults to true. */ sso_disabled?: boolean | undefined; /** Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false). */ cross_origin_authentication?: boolean | undefined; /** URL of the location in your site where the cross origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page. */ cross_origin_loc?: string | undefined; /** Whether a custom login page is to be used (true) or the default provided login page (false). */ custom_login_page_on?: boolean | undefined; /** The content (HTML, CSS, JS) of the custom login page. */ custom_login_page?: string | undefined; /** The content (HTML, CSS, JS) of the custom login page. (Used on Previews) */ custom_login_page_preview?: string | undefined; /** HTML form template to be used for WS-Federation. */ form_template?: string | undefined; addons?: Management.ClientAddons | undefined; token_endpoint_auth_method?: Management.ClientTokenEndpointAuthMethodEnum | undefined; /** If true, trust that the IP specified in the `auth0-forwarded-for` header is the end-user's IP for brute-force-protection on token endpoint. */ is_token_endpoint_ip_header_trusted?: boolean | undefined; client_metadata?: Management.ClientMetadata | undefined; mobile?: Management.ClientMobile | undefined; /** Initiate login uri, must be https */ initiate_login_uri?: string | undefined; refresh_token?: (Management.ClientRefreshTokenConfiguration | null) | undefined; default_organization?: (Management.ClientDefaultOrganization | null) | undefined; organization_usage?: Management.ClientOrganizationUsageEnum | undefined; organization_require_behavior?: Management.ClientOrganizationRequireBehaviorEnum | undefined; /** Defines the available methods for organization discovery during the `pre_login_prompt`. Users can discover their organization either by `email`, `organization_name` or both. */ organization_discovery_methods?: Management.ClientOrganizationDiscoveryEnum[] | undefined; client_authentication_methods?: (Management.ClientAuthenticationMethod | null) | undefined; /** Makes the use of Pushed Authorization Requests mandatory for this client */ require_pushed_authorization_requests?: boolean | undefined; /** Makes the use of Proof-of-Possession mandatory for this client */ require_proof_of_possession?: boolean | undefined; signed_request_object?: Management.ClientSignedRequestObjectWithCredentialId | undefined; compliance_level?: (Management.ClientComplianceLevelEnum | null) | undefined; /** * Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as `myapp://`, or `localhost`). * If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps. * See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information. */ skip_non_verifiable_callback_uri_confirmation_prompt?: boolean | undefined; token_exchange?: Management.ClientTokenExchangeConfiguration | undefined; /** Specifies how long, in seconds, a Pushed Authorization Request URI remains valid */ par_request_expiry?: (number | null) | undefined; token_quota?: Management.TokenQuota | undefined; express_configuration?: Management.ExpressConfiguration | undefined; my_organization_configuration?: Management.ClientMyOrganizationResponseConfiguration | undefined; third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum | undefined; redirection_policy?: Management.ClientRedirectionPolicyEnum | undefined; /** The identifier of the resource server that this client is linked to. */ resource_server_identifier?: string | undefined; async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPostConfiguration | undefined; external_metadata_type?: Management.ClientExternalMetadataTypeEnum | undefined; external_metadata_created_by?: Management.ClientExternalMetadataCreatedByEnum | undefined; /** An alternate client identifier to be used during authorization flows. Only supports CIMD-based client identifiers. */ external_client_id?: string | undefined; /** URL for the JSON Web Key Set (JWKS) containing the public keys used for private_key_jwt authentication. Only present for CIMD clients using private_key_jwt authentication. */ jwks_uri?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * AWS addon configuration. */ export interface ClientAddonAws { /** AWS principal ARN, e.g. `arn:aws:iam::010616021751:saml-provider/idpname` */ principal?: string | undefined; /** AWS role ARN, e.g. `arn:aws:iam::010616021751:role/foo` */ role?: string | undefined; /** AWS token lifetime in seconds */ lifetime_in_seconds?: number | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Azure Blob Storage addon configuration. */ export interface ClientAddonAzureBlob { /** Your Azure storage account name. Usually first segment in your Azure storage URL. e.g. `https://acme-org.blob.core.windows.net` would be the account name `acme-org`. */ accountName?: string | undefined; /** Access key associated with this storage account. */ storageAccessKey?: string | undefined; /** Container to request a token for. e.g. `my-container`. */ containerName?: string | undefined; /** Entity to request a token for. e.g. `my-blob`. If blank the computed SAS will apply to the entire storage container. */ blobName?: string | undefined; /** Expiration in minutes for the generated token (default of 5 minutes). */ expiration?: number | undefined; /** Shared access policy identifier defined in your storage account resource. */ signedIdentifier?: string | undefined; /** 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. */ blob_read?: boolean | undefined; /** 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. */ blob_write?: boolean | undefined; /** Indicates if the issued token has permission to delete the blob. */ blob_delete?: boolean | undefined; /** 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 */ container_read?: boolean | undefined; /** 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. */ container_write?: boolean | undefined; /** Indicates if issued token has permission to delete any blob in the container. */ container_delete?: boolean | undefined; /** Indicates if the issued token has permission to list blobs in the container. */ container_list?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Azure Storage Bus addon configuration. */ export interface ClientAddonAzureSb { /** Your Azure Service Bus namespace. Usually the first segment of your Service Bus URL (e.g. `https://acme-org.servicebus.windows.net` would be `acme-org`). */ namespace?: string | undefined; /** Your shared access policy name defined in your Service Bus entity. */ sasKeyName?: string | undefined; /** Primary Key associated with your shared access policy. */ sasKey?: string | undefined; /** Entity you want to request a token for. e.g. `my-queue`.' */ entityPath?: string | undefined; /** Optional expiration in minutes for the generated token. Defaults to 5 minutes. */ expiration?: number | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Box SSO indicator (no configuration settings needed for Box SSO). */ export type ClientAddonBox = Record; /** * CloudBees SSO indicator (no configuration settings needed for CloudBees SSO). */ export type ClientAddonCloudBees = Record; /** * Concur SSO indicator (no configuration settings needed for Concur SSO). */ export type ClientAddonConcur = Record; /** * Dropbox SSO indicator (no configuration settings needed for Dropbox SSO). */ export type ClientAddonDropbox = Record; /** * Adobe EchoSign SSO configuration. */ export interface ClientAddonEchoSign { /** Your custom domain found in your EchoSign URL. e.g. `https://acme-org.echosign.com` would be `acme-org`. */ domain?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Egnyte SSO configuration. */ export interface ClientAddonEgnyte { /** Your custom domain found in your Egnyte URL. e.g. `https://acme-org.egnyte.com` would be `acme-org`. */ domain?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Google Firebase addon configuration. */ export interface ClientAddonFirebase { /** Google Firebase Secret. (SDK 2 only). */ secret?: string | undefined; /** Optional ID of the private key to obtain kid header in the issued token (SDK v3+ tokens only). */ private_key_id?: string | undefined; /** Private Key for signing the token (SDK v3+ tokens only). */ private_key?: string | undefined; /** ID of the Service Account you have created (shown as `client_email` in the generated JSON file, SDK v3+ tokens only). */ client_email?: string | undefined; /** Optional expiration in seconds for the generated token. Defaults to 3600 seconds (SDK v3+ tokens only). */ lifetime_in_seconds?: number | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Layer addon configuration. */ export interface ClientAddonLayer { /** Provider ID of your Layer account */ providerId: string; /** Authentication Key identifier used to sign the Layer token. */ keyId: string; /** Private key for signing the Layer token. */ privateKey: string; /** Name of the property used as the unique user id in Layer. If not specified `user_id` is used. */ principal?: string | undefined; /** Optional expiration in minutes for the generated token. Defaults to 5 minutes. */ expiration?: number | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Microsoft Dynamics CRM SSO configuration. */ export interface ClientAddonMscrm { /** Microsoft Dynamics CRM application URL. */ url: string; /** Accepts any additional properties */ [key: string]: any; } /** * New Relic SSO configuration. */ export interface ClientAddonNewRelic { /** Your New Relic Account ID found in your New Relic URL after the `/accounts/` path. e.g. `https://rpm.newrelic.com/accounts/123456/query` would be `123456`. */ account?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Okta Access Gateway SSO configuration */ export interface ClientAddonOag { } /** * Microsoft Office 365 SSO configuration. */ export interface ClientAddonOffice365 { /** Your Office 365 domain name. e.g. `acme-org.com`. */ domain?: string | undefined; /** Optional Auth0 database connection for testing an already-configured Office 365 tenant. */ connection?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Active Directory Rights Management Service SSO configuration. */ export interface ClientAddonRms { /** URL of your Rights Management Server. It can be internal or external, but users will have to be able to reach it. */ url: string; /** Accepts any additional properties */ [key: string]: any; } /** * SAML2 addon indicator (no configuration settings needed for SAML2 addon). */ export interface ClientAddonSaml { mappings?: Management.ClientAddonSamlMapping | undefined; audience?: string | undefined; recipient?: string | undefined; createUpnClaim?: boolean | undefined; mapUnknownClaimsAsIs?: boolean | undefined; passthroughClaimsWithNoMapping?: boolean | undefined; mapIdentities?: boolean | undefined; signatureAlgorithm?: string | undefined; digestAlgorithm?: string | undefined; issuer?: string | undefined; destination?: string | undefined; lifetimeInSeconds?: number | undefined; signResponse?: boolean | undefined; nameIdentifierFormat?: string | undefined; nameIdentifierProbes?: string[] | undefined; authnContextClassRef?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export type ClientAddonSamlMapping = Record; /** * SAP API addon configuration. */ export interface ClientAddonSapapi { /** 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 | undefined; /** Name of the property in the user object that maps to a SAP username. e.g. `email`. */ usernameAttribute?: string | undefined; /** Your SAP OData server OAuth2 token endpoint URL. */ tokenEndpointUrl?: string | undefined; /** Requested scope for SAP APIs. */ scope?: string | undefined; /** Service account password to use to authenticate API calls to the token endpoint. */ servicePassword?: string | undefined; /** 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 | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface ClientAddonSsoIntegration { /** SSO integration name */ name?: string | undefined; /** SSO integration version installed */ version?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Salesforce SSO configuration. */ export interface ClientAddonSalesforce { /** Arbitrary logical URL that identifies the Saleforce resource. e.g. `https://acme-org.com`. */ entity_id?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Salesforce API addon configuration. */ export interface ClientAddonSalesforceApi { /** Consumer Key assigned by Salesforce to the Connected App. */ clientid?: string | undefined; /** Name of the property in the user object that maps to a Salesforce username. e.g. `email`. */ principal?: string | undefined; /** Community name. */ communityName?: string | undefined; /** Community url section. */ community_url_section?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Salesforce Sandbox addon configuration. */ export interface ClientAddonSalesforceSandboxApi { /** Consumer Key assigned by Salesforce to the Connected App. */ clientid?: string | undefined; /** Name of the property in the user object that maps to a Salesforce username. e.g. `email`. */ principal?: string | undefined; /** Community name. */ communityName?: string | undefined; /** Community url section. */ community_url_section?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Sentry SSO configuration. */ export interface ClientAddonSentry { /** Generated slug for your Sentry organization. Found in your Sentry URL. e.g. `https://sentry.acme.com/acme-org/` would be `acme-org`. */ org_slug?: string | undefined; /** URL prefix only if running Sentry Community Edition, otherwise leave should be blank. */ base_url?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * SharePoint SSO configuration. */ export interface ClientAddonSharePoint { /** Internal SharePoint application URL. */ url?: string | undefined; external_url?: Management.ClientAddonSharePointExternalUrl | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * External SharePoint application URLs if exposed to the Internet. */ export type ClientAddonSharePointExternalUrl = string[] | string; /** * Slack team or workspace name usually first segment in your Slack URL. e.g. `https://acme-org.slack.com` would be `acme-org`. */ export interface ClientAddonSlack { /** Slack team name. */ team: string; /** Accepts any additional properties */ [key: string]: any; } /** * SpringCM SSO configuration. */ export interface ClientAddonSpringCm { /** SpringCM ACS URL, e.g. `https://na11.springcm.com/atlas/sso/SSOEndpoint.ashx`. */ acsurl?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Windows Azure Mobile Services addon configuration. */ export interface ClientAddonWams { /** Your master key for Windows Azure Mobile Services. */ masterkey?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * WS-Fed (WIF) addon indicator. Actual configuration is stored in `callback` and `client_aliases` properties on the client. */ export type ClientAddonWsFed = Record; /** * Zendesk SSO configuration. */ export interface ClientAddonZendesk { /** Zendesk account name usually first segment in your Zendesk URL. e.g. `https://acme-org.zendesk.com` would be `acme-org`. */ accountName?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Zoom SSO configuration. */ export interface ClientAddonZoom { /** Zoom account name usually first segment of your Zoom URL, e.g. `https://acme-org.zoom.us` would be `acme-org`. */ account?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Addons enabled for this client and their associated configurations. */ export interface ClientAddons { aws?: Management.ClientAddonAws | undefined; azure_blob?: Management.ClientAddonAzureBlob | undefined; azure_sb?: Management.ClientAddonAzureSb | undefined; rms?: Management.ClientAddonRms | undefined; mscrm?: Management.ClientAddonMscrm | undefined; slack?: Management.ClientAddonSlack | undefined; sentry?: Management.ClientAddonSentry | undefined; box?: Management.ClientAddonBox | undefined; cloudbees?: Management.ClientAddonCloudBees | undefined; concur?: Management.ClientAddonConcur | undefined; dropbox?: Management.ClientAddonDropbox | undefined; echosign?: Management.ClientAddonEchoSign | undefined; egnyte?: Management.ClientAddonEgnyte | undefined; firebase?: Management.ClientAddonFirebase | undefined; newrelic?: Management.ClientAddonNewRelic | undefined; office365?: Management.ClientAddonOffice365 | undefined; salesforce?: Management.ClientAddonSalesforce | undefined; salesforce_api?: Management.ClientAddonSalesforceApi | undefined; salesforce_sandbox_api?: Management.ClientAddonSalesforceSandboxApi | undefined; samlp?: Management.ClientAddonSaml | undefined; layer?: Management.ClientAddonLayer | undefined; sap_api?: Management.ClientAddonSapapi | undefined; sharepoint?: Management.ClientAddonSharePoint | undefined; springcm?: Management.ClientAddonSpringCm | undefined; wams?: Management.ClientAddonWams | undefined; wsfed?: Management.ClientAddonWsFed | undefined; zendesk?: Management.ClientAddonZendesk | undefined; zoom?: Management.ClientAddonZoom | undefined; sso_integration?: Management.ClientAddonSsoIntegration | undefined; oag?: (Management.ClientAddonOag | null) | undefined; } /** The type of application this client represents */ export declare const ClientAppTypeEnum: { readonly Native: "native"; readonly Spa: "spa"; readonly RegularWeb: "regular_web"; readonly NonInteractive: "non_interactive"; readonly ResourceServer: "resource_server"; readonly ExpressConfiguration: "express_configuration"; readonly Rms: "rms"; readonly Box: "box"; readonly Cloudbees: "cloudbees"; readonly Concur: "concur"; readonly Dropbox: "dropbox"; readonly Mscrm: "mscrm"; readonly Echosign: "echosign"; readonly Egnyte: "egnyte"; readonly Newrelic: "newrelic"; readonly Office365: "office365"; readonly Salesforce: "salesforce"; readonly Sentry: "sentry"; readonly Sharepoint: "sharepoint"; readonly Slack: "slack"; readonly Springcm: "springcm"; readonly Zendesk: "zendesk"; readonly Zoom: "zoom"; readonly SsoIntegration: "sso_integration"; readonly Oag: "oag"; }; export type ClientAppTypeEnum = (typeof ClientAppTypeEnum)[keyof typeof ClientAppTypeEnum]; /** * Array of notification channels for contacting the user when their approval is required. Valid values are `guardian-push`, `email`. */ export type ClientAsyncApprovalNotificationsChannelsApiPatchConfiguration = (Management.AsyncApprovalNotificationsChannelsEnum[] | null) | undefined; /** * Array of notification channels for contacting the user when their approval is required. Valid values are `guardian-push`, `email`. */ export type ClientAsyncApprovalNotificationsChannelsApiPostConfiguration = Management.AsyncApprovalNotificationsChannelsEnum[]; /** * Defines client authentication methods. */ export interface ClientAuthenticationMethod { private_key_jwt?: Management.ClientAuthenticationMethodPrivateKeyJwt | undefined; tls_client_auth?: Management.ClientAuthenticationMethodTlsClientAuth | undefined; self_signed_tls_client_auth?: Management.ClientAuthenticationMethodSelfSignedTlsClientAuth | undefined; } /** * Defines `private_key_jwt` client authentication method. If this property is defined, the client is enabled to use the Private Key JWT authentication method. */ export interface ClientAuthenticationMethodPrivateKeyJwt { credentials: Management.ClientAuthenticationMethodPrivateKeyJwtCredentials; } /** * A list of unique and previously created credential IDs enabled on the client for Private Key JWT authentication. */ export type ClientAuthenticationMethodPrivateKeyJwtCredentials = Management.CredentialId[]; /** * Defines `self_signed_tls_client_auth` client authentication method. If the property is defined, the client is configured to use mTLS authentication method utilizing self-signed certificate. */ export interface ClientAuthenticationMethodSelfSignedTlsClientAuth { credentials: Management.ClientAuthenticationMethodSelfSignedTlsClientAuthCredentials; } /** * A list of unique and previously created credential IDs enabled on the client for mTLS authentication utilizing self-signed certificate. */ export type ClientAuthenticationMethodSelfSignedTlsClientAuthCredentials = Management.CredentialId[]; /** * Defines `tls_client_auth` client authentication method. If the property is defined, the client is configured to use CA-based mTLS authentication method. */ export interface ClientAuthenticationMethodTlsClientAuth { credentials: Management.ClientAuthenticationMethodTlsClientAuthCredentials; } /** * A list of unique and previously created credential IDs enabled on the client for CA-based mTLS authentication. */ export type ClientAuthenticationMethodTlsClientAuthCredentials = Management.CredentialId[]; /** Defines the compliance level for this client, which may restrict it's capabilities */ export declare const ClientComplianceLevelEnum: { readonly None: "none"; readonly Fapi1AdvPkjPar: "fapi1_adv_pkj_par"; readonly Fapi1AdvMtlsPar: "fapi1_adv_mtls_par"; readonly Fapi2SpPkjMtls: "fapi2_sp_pkj_mtls"; readonly Fapi2SpMtlsMtls: "fapi2_sp_mtls_mtls"; }; export type ClientComplianceLevelEnum = (typeof ClientComplianceLevelEnum)[keyof typeof ClientComplianceLevelEnum]; /** * Defines client authentication methods. */ export interface ClientCreateAuthenticationMethod { private_key_jwt?: Management.ClientCreateAuthenticationMethodPrivateKeyJwt | undefined; tls_client_auth?: Management.ClientCreateAuthenticationMethodTlsClientAuth | undefined; self_signed_tls_client_auth?: Management.CreateClientAuthenticationMethodSelfSignedTlsClientAuth | undefined; } /** * Defines `private_key_jwt` client authentication method. If this property is defined, the client is enabled to use the Private Key JWT authentication method. */ export interface ClientCreateAuthenticationMethodPrivateKeyJwt { credentials: Management.ClientCreateAuthenticationMethodPrivateKeyJwtCredentials; } /** * Fully defined credentials that will be enabled on the client for Private Key JWT authentication. */ export type ClientCreateAuthenticationMethodPrivateKeyJwtCredentials = Management.PublicKeyCredential[]; /** * Defines `tls_client_auth` client authentication method. If the property is defined, the client is configured to use CA-based mTLS authentication method. */ export interface ClientCreateAuthenticationMethodTlsClientAuth { credentials: Management.ClientCreateAuthenticationMethodTlsClientAuthCredentials; } /** * Fully defined credentials that will be enabled on the client for CA-based mTLS authentication. */ export type ClientCreateAuthenticationMethodTlsClientAuthCredentials = Management.CertificateSubjectDnCredential[]; export interface ClientCredential { /** ID of the credential. Generated on creation. */ id?: string | undefined; /** The name given to the credential by the user. */ name?: string | undefined; /** The key identifier of the credential, generated on creation. */ kid?: string | undefined; alg?: Management.ClientCredentialAlgorithmEnum | undefined; credential_type?: Management.ClientCredentialTypeEnum | undefined; /** The X509 certificate's Subject Distinguished Name */ subject_dn?: string | undefined; /** The X509 certificate's SHA256 thumbprint */ thumbprint_sha256?: string | undefined; /** The ISO 8601 formatted date the credential was created. */ created_at?: string | undefined; /** The ISO 8601 formatted date the credential was updated. */ updated_at?: string | undefined; /** The ISO 8601 formatted date representing the expiration of the credential. */ expires_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** Algorithm which will be used with the credential. Supported algorithms: RS256,RS384,PS256 */ export declare const ClientCredentialAlgorithmEnum: { readonly Rs256: "RS256"; readonly Rs384: "RS384"; readonly Ps256: "PS256"; }; export type ClientCredentialAlgorithmEnum = (typeof ClientCredentialAlgorithmEnum)[keyof typeof ClientCredentialAlgorithmEnum]; /** The type of credential. */ export declare const ClientCredentialTypeEnum: { readonly PublicKey: "public_key"; readonly CertSubjectDn: "cert_subject_dn"; readonly X509Cert: "x509_cert"; }; export type ClientCredentialTypeEnum = (typeof ClientCredentialTypeEnum)[keyof typeof ClientCredentialTypeEnum]; /** * Defines the default Organization ID and flows */ export interface ClientDefaultOrganization { /** The default Organization ID to be used */ organization_id: string; /** The default Organization usage */ flows: Management.ClientDefaultOrganizationFlowsEnum[]; } export declare const ClientDefaultOrganizationFlowsEnum: { readonly ClientCredentials: "client_credentials"; }; export type ClientDefaultOrganizationFlowsEnum = (typeof ClientDefaultOrganizationFlowsEnum)[keyof typeof ClientDefaultOrganizationFlowsEnum]; /** * Encryption used for WsFed responses with this client. */ export interface ClientEncryptionKey { /** Encryption Public RSA Key. */ pub?: string | undefined; /** Encryption certificate for public key in X.509 (.CER) format. */ cert?: string | undefined; /** Encryption certificate name for this certificate in the format `/CN={domain}`. */ subject?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** Indicates who created the external metadata client. The value admin indicates the client was registered via the Management API. The value client indicates the client was registered dynamically. This field is only present when external_metadata_type is set. */ export declare const ClientExternalMetadataCreatedByEnum: { readonly Admin: "admin"; readonly Client: "client"; }; export type ClientExternalMetadataCreatedByEnum = (typeof ClientExternalMetadataCreatedByEnum)[keyof typeof ClientExternalMetadataCreatedByEnum]; /** Indicates the type of external metadata used to register the client. This field is omitted for regular clients. The value cimd identifies clients registered via a Client ID Metadata Document. */ export declare const ClientExternalMetadataTypeEnum: { readonly Cimd: "cimd"; }; export type ClientExternalMetadataTypeEnum = (typeof ClientExternalMetadataTypeEnum)[keyof typeof ClientExternalMetadataTypeEnum]; /** * Optional filter on allow_any_organization. */ export type ClientGrantAllowAnyOrganizationEnum = boolean; /** Used to filter the returned client grants to include only default client grants for the specified group of clients. */ export declare const ClientGrantDefaultForEnum: { readonly ThirdPartyClients: "third_party_clients"; }; export type ClientGrantDefaultForEnum = (typeof ClientGrantDefaultForEnum)[keyof typeof ClientGrantDefaultForEnum]; /** Controls how organizations may be used with this grant */ export declare const ClientGrantOrganizationNullableUsageEnum: { readonly Deny: "deny"; readonly Allow: "allow"; readonly Require: "require"; }; export type ClientGrantOrganizationNullableUsageEnum = (typeof ClientGrantOrganizationNullableUsageEnum)[keyof typeof ClientGrantOrganizationNullableUsageEnum]; /** Defines whether organizations can be used with client credentials exchanges for this grant. */ export declare const ClientGrantOrganizationUsageEnum: { readonly Deny: "deny"; readonly Allow: "allow"; readonly Require: "require"; }; export type ClientGrantOrganizationUsageEnum = (typeof ClientGrantOrganizationUsageEnum)[keyof typeof ClientGrantOrganizationUsageEnum]; export interface ClientGrantResponseContent { /** ID of the client grant. */ id?: string | undefined; /** ID of the client. */ client_id?: string | undefined; /** The audience (API identifier) of this client grant. */ audience?: string | undefined; /** Scopes allowed for this client grant. */ scope?: string[] | undefined; organization_usage?: Management.ClientGrantOrganizationUsageEnum | undefined; /** If enabled, any organization can be used with this grant. If disabled (default), the grant must be explicitly assigned to the desired organizations. */ allow_any_organization?: boolean | undefined; /** Applies this client grant as the default for all clients in the specified group. The only accepted value is `third_party_clients`, which applies the grant to all third-party clients. Per-client grants for the same audience take precedence. Mutually exclusive with `client_id`. */ default_for?: Management.ClientGrantDefaultForEnum | undefined; /** If enabled, this grant is a special grant created by Auth0. It cannot be modified or deleted directly. */ is_system?: boolean | undefined; subject_type?: Management.ClientGrantSubjectTypeEnum | undefined; /** Types of authorization_details allowed for this client grant. */ authorization_details_types?: string[] | undefined; /** If enabled, all scopes configured on the resource server are allowed for this grant. */ allow_all_scopes?: boolean | undefined; } /** The type of application access the client grant allows. */ export declare const ClientGrantSubjectTypeEnum: { readonly Client: "client"; readonly User: "user"; }; export type ClientGrantSubjectTypeEnum = (typeof ClientGrantSubjectTypeEnum)[keyof typeof ClientGrantSubjectTypeEnum]; /** * Configuration related to JWTs for the client. */ export interface ClientJwtConfiguration { /** Number of seconds the JWT will be valid for (affects `exp` claim). */ lifetime_in_seconds?: number | undefined; /** Whether the client secret is base64 encoded (true) or unencoded (false). */ secret_encoded?: boolean | undefined; scopes?: Management.ClientJwtConfigurationScopes | undefined; alg?: Management.SigningAlgorithmEnum | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Configuration related to id token claims for the client. */ export type ClientJwtConfigurationScopes = Record; /** * 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] */ export type ClientMetadata = Record; /** * Additional configuration for native mobile apps. */ export interface ClientMobile { android?: Management.ClientMobileAndroid | undefined; ios?: Management.ClientMobileiOs | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Android native app configuration. */ export interface ClientMobileAndroid { /** App package name found in AndroidManifest.xml. */ app_package_name?: string | undefined; /** SHA256 fingerprints of the app's signing certificate. Multiple fingerprints can be used to support different versions of your app, such as debug and production builds. */ sha256_cert_fingerprints?: string[] | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * iOS native app configuration. */ export interface ClientMobileiOs { /** Identifier assigned to the Apple account that signs and uploads the app to the store. */ team_id?: string | undefined; /** Assigned by developer to the app as its unique identifier inside the store. Usually this is a reverse domain plus the app name, e.g. `com.you.MyApp`. */ app_bundle_identifier?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** The allowed connection strategy values for the My Organization Configuration. */ export declare const ClientMyOrganizationConfigurationAllowedStrategiesEnum: { readonly Pingfederate: "pingfederate"; readonly Adfs: "adfs"; readonly Waad: "waad"; readonly GoogleApps: "google-apps"; readonly Okta: "okta"; readonly Oidc: "oidc"; readonly Samlp: "samlp"; }; export type ClientMyOrganizationConfigurationAllowedStrategiesEnum = (typeof ClientMyOrganizationConfigurationAllowedStrategiesEnum)[keyof typeof ClientMyOrganizationConfigurationAllowedStrategiesEnum]; /** The deletion behavior for this client. */ export declare const ClientMyOrganizationDeletionBehaviorEnum: { readonly Allow: "allow"; readonly AllowIfEmpty: "allow_if_empty"; }; export type ClientMyOrganizationDeletionBehaviorEnum = (typeof ClientMyOrganizationDeletionBehaviorEnum)[keyof typeof ClientMyOrganizationDeletionBehaviorEnum]; /** * Configuration related to the My Organization Configuration for the client. */ export interface ClientMyOrganizationPatchConfiguration { /** The connection profile ID that this client should validate against. */ connection_profile_id?: string | undefined; /** The user attribute profile ID that this client should validate against. */ user_attribute_profile_id?: string | undefined; /** The allowed connection strategies for the My Organization Configuration. */ allowed_strategies: Management.ClientMyOrganizationConfigurationAllowedStrategiesEnum[]; connection_deletion_behavior: Management.ClientMyOrganizationDeletionBehaviorEnum; /** The client ID this client uses while creating invitations through My Organization API. */ invitation_landing_client_id?: string | undefined; /** List of role IDs allowed when inviting users through the My Organization API. */ allowed_roles?: string[] | undefined; } /** * Configuration related to the My Organization Configuration for the client. */ export interface ClientMyOrganizationPostConfiguration { /** The connection profile ID that this client should validate against. */ connection_profile_id?: string | undefined; /** The user attribute profile ID that this client should validate against. */ user_attribute_profile_id?: string | undefined; /** The allowed connection strategies for the My Organization Configuration. */ allowed_strategies: Management.ClientMyOrganizationConfigurationAllowedStrategiesEnum[]; connection_deletion_behavior: Management.ClientMyOrganizationDeletionBehaviorEnum; /** The client ID this client uses while creating invitations through My Organization API. */ invitation_landing_client_id?: string | undefined; /** List of role IDs allowed when inviting users through the My Organization API. */ allowed_roles?: string[] | undefined; } /** * Configuration related to the My Organization Configuration for the client. */ export interface ClientMyOrganizationResponseConfiguration { /** The connection profile ID that this client should validate against. */ connection_profile_id?: string | undefined; /** The user attribute profile ID that this client should validate against. */ user_attribute_profile_id?: string | undefined; /** The allowed connection strategies for the My Organization Configuration. */ allowed_strategies: Management.ClientMyOrganizationConfigurationAllowedStrategiesEnum[]; connection_deletion_behavior: Management.ClientMyOrganizationDeletionBehaviorEnum; /** The client ID this client uses while creating invitations through My Organization API. */ invitation_landing_client_id?: string | undefined; /** List of role IDs allowed when inviting users through the My Organization API. */ allowed_roles?: string[] | undefined; } /** * Configuration for OIDC backchannel logout initiators */ export interface ClientOidcBackchannelLogoutInitiators { mode?: Management.ClientOidcBackchannelLogoutInitiatorsModeEnum | undefined; selected_initiators?: Management.ClientOidcBackchannelLogoutInitiatorsEnum[] | undefined; /** Accepts any additional properties */ [key: string]: any; } /** The `selected_initiators` property contains the list of initiators to be enabled for the given application. */ export declare const ClientOidcBackchannelLogoutInitiatorsEnum: { readonly RpLogout: "rp-logout"; readonly IdpLogout: "idp-logout"; readonly PasswordChanged: "password-changed"; readonly SessionExpired: "session-expired"; readonly SessionRevoked: "session-revoked"; readonly AccountDeleted: "account-deleted"; readonly EmailIdentifierChanged: "email-identifier-changed"; readonly MfaPhoneUnenrolled: "mfa-phone-unenrolled"; readonly AccountDeactivated: "account-deactivated"; }; export type ClientOidcBackchannelLogoutInitiatorsEnum = (typeof ClientOidcBackchannelLogoutInitiatorsEnum)[keyof typeof ClientOidcBackchannelLogoutInitiatorsEnum]; /** The `mode` property determines the configuration method for enabling initiators. `custom` enables only the initiators listed in the selected_initiators array, `all` enables all current and future initiators. */ export declare const ClientOidcBackchannelLogoutInitiatorsModeEnum: { readonly Custom: "custom"; readonly All: "all"; }; export type ClientOidcBackchannelLogoutInitiatorsModeEnum = (typeof ClientOidcBackchannelLogoutInitiatorsModeEnum)[keyof typeof ClientOidcBackchannelLogoutInitiatorsModeEnum]; /** * Controls whether session metadata is included in the logout token. Default value is null. */ export interface ClientOidcBackchannelLogoutSessionMetadata { /** The `include` property determines whether session metadata is included in the logout token. */ include?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Configuration for OIDC backchannel logout */ export interface ClientOidcBackchannelLogoutSettings { /** Comma-separated list of URLs that are valid to call back from Auth0 for OIDC backchannel logout. Currently only one URL is allowed. */ backchannel_logout_urls?: string[] | undefined; backchannel_logout_initiators?: Management.ClientOidcBackchannelLogoutInitiators | undefined; backchannel_logout_session_metadata?: (Management.ClientOidcBackchannelLogoutSessionMetadata | null) | undefined; /** Accepts any additional properties */ [key: string]: any; } /** Method for discovering organizations during the `pre_login_prompt`. `email` allows users to find their organization by entering their email address and performing domain matching, while `organization_name` requires users to enter the organization name directly. These methods can be combined. */ export declare const ClientOrganizationDiscoveryEnum: { readonly Email: "email"; readonly OrganizationName: "organization_name"; }; export type ClientOrganizationDiscoveryEnum = (typeof ClientOrganizationDiscoveryEnum)[keyof typeof ClientOrganizationDiscoveryEnum]; /** Defines how to proceed during an authentication transaction when `client.organization_usage: 'require'`. Can be `no_prompt` (default), `pre_login_prompt` or `post_login_prompt`. `post_login_prompt` requires `oidc_conformant: true`. */ export declare const ClientOrganizationRequireBehaviorEnum: { readonly NoPrompt: "no_prompt"; readonly PreLoginPrompt: "pre_login_prompt"; readonly PostLoginPrompt: "post_login_prompt"; }; export type ClientOrganizationRequireBehaviorEnum = (typeof ClientOrganizationRequireBehaviorEnum)[keyof typeof ClientOrganizationRequireBehaviorEnum]; /** Defines how to proceed during an authentication transaction when `client.organization_usage: 'require'`. Can be `no_prompt` (default), `pre_login_prompt` or `post_login_prompt`. `post_login_prompt` requires `oidc_conformant: true`. */ export declare const ClientOrganizationRequireBehaviorPatchEnum: { readonly NoPrompt: "no_prompt"; readonly PreLoginPrompt: "pre_login_prompt"; readonly PostLoginPrompt: "post_login_prompt"; }; export type ClientOrganizationRequireBehaviorPatchEnum = (typeof ClientOrganizationRequireBehaviorPatchEnum)[keyof typeof ClientOrganizationRequireBehaviorPatchEnum]; /** Defines how to proceed during an authentication transaction with regards an organization. Can be `deny` (default), `allow` or `require`. */ export declare const ClientOrganizationUsageEnum: { readonly Deny: "deny"; readonly Allow: "allow"; readonly Require: "require"; }; export type ClientOrganizationUsageEnum = (typeof ClientOrganizationUsageEnum)[keyof typeof ClientOrganizationUsageEnum]; /** Defines how to proceed during an authentication transaction with regards an organization. Can be `deny` (default), `allow` or `require`. */ export declare const ClientOrganizationUsagePatchEnum: { readonly Deny: "deny"; readonly Allow: "allow"; readonly Require: "require"; }; export type ClientOrganizationUsagePatchEnum = (typeof ClientOrganizationUsagePatchEnum)[keyof typeof ClientOrganizationUsagePatchEnum]; /** Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows. `open_redirect_protection` shows an error page instead of redirecting, and hides the callback domain from email templates. `allow_always` enables standard redirect behavior. Defaults to `open_redirect_protection` for third-party clients. Only applies when `is_first_party` is `false` and `third_party_security_mode` is `strict`. */ export declare const ClientRedirectionPolicyEnum: { readonly AllowAlways: "allow_always"; readonly OpenRedirectProtection: "open_redirect_protection"; }; export type ClientRedirectionPolicyEnum = (typeof ClientRedirectionPolicyEnum)[keyof typeof ClientRedirectionPolicyEnum]; /** * Refresh token configuration */ export interface ClientRefreshTokenConfiguration { rotation_type: Management.RefreshTokenRotationTypeEnum; expiration_type: Management.RefreshTokenExpirationTypeEnum; /** Period in seconds where the previous refresh token can be exchanged without triggering breach detection */ leeway?: number | undefined; /** Period (in seconds) for which refresh tokens will remain valid */ token_lifetime?: number | undefined; /** Prevents tokens from having a set lifetime when `true` (takes precedence over `token_lifetime` values) */ infinite_token_lifetime?: boolean | undefined; /** Period (in seconds) for which refresh tokens will remain valid without use */ idle_token_lifetime?: number | undefined; /** Prevents tokens from expiring without use when `true` (takes precedence over `idle_token_lifetime` values) */ infinite_idle_token_lifetime?: boolean | undefined; /** A collection of policies governing multi-resource refresh token exchange (MRRT), defining how refresh tokens can be used across different resource servers */ policies?: (Management.ClientRefreshTokenPolicy[] | null) | undefined; } 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 */ scope: string[]; } export declare const ClientSessionTransferAllowedAuthenticationMethodsEnum: { readonly Cookie: "cookie"; readonly Query: "query"; }; export type ClientSessionTransferAllowedAuthenticationMethodsEnum = (typeof ClientSessionTransferAllowedAuthenticationMethodsEnum)[keyof typeof ClientSessionTransferAllowedAuthenticationMethodsEnum]; /** * Native to Web SSO Configuration */ export interface ClientSessionTransferConfiguration { /** Indicates whether an app can issue a Session Transfer Token through Token Exchange. If set to 'false', the app will not be able to issue a Session Transfer Token. Usually configured in the native application. Default value is `false`. */ can_create_session_transfer_token?: boolean | undefined; /** 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. Default value is `true`, applicable only in Native to Web SSO context. */ enforce_cascade_revocation?: boolean | undefined; /** Indicates whether an app can create a session from a Session Transfer Token received via indicated methods. Can include `cookie` and/or `query`. Usually configured in the web application. Default value is an empty array []. */ allowed_authentication_methods?: (Management.ClientSessionTransferAllowedAuthenticationMethodsEnum[] | null) | undefined; enforce_device_binding?: Management.ClientSessionTransferDeviceBindingEnum | undefined; /** Indicates whether Refresh Tokens are allowed to be issued when authenticating with a Session Transfer Token. Usually configured in the web application. Default value is `false`. */ allow_refresh_token?: boolean | undefined; /** 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. Default value is `true`, applicable only in Native to Web SSO context. */ enforce_online_refresh_tokens?: boolean | undefined; } /** Indicates whether device binding security should be enforced for the app. If set to 'ip', the app will enforce device binding by IP, meaning that consumption of Session Transfer Token must be done from the same IP of the issuer. Likewise, if set to 'asn', device binding is enforced by ASN, meaning consumption of Session Transfer Token must be done from the same ASN as the issuer. If set to 'none', device binding is not enforced. Usually configured in the web application. Default value is `ip`. */ export declare const ClientSessionTransferDeviceBindingEnum: { readonly Ip: "ip"; readonly Asn: "asn"; readonly None: "none"; }; export type ClientSessionTransferDeviceBindingEnum = (typeof ClientSessionTransferDeviceBindingEnum)[keyof typeof ClientSessionTransferDeviceBindingEnum]; /** * JWT-secured Authorization Requests (JAR) settings. */ export interface ClientSignedRequestObjectWithCredentialId { /** Indicates whether the JAR requests are mandatory */ required?: boolean | undefined; credentials?: Management.CredentialId[] | undefined; } /** * JWT-secured Authorization Requests (JAR) settings. */ export interface ClientSignedRequestObjectWithPublicKey { /** Indicates whether the JAR requests are mandatory */ required?: boolean | undefined; credentials?: Management.PublicKeyCredential[] | undefined; } export interface ClientSigningKey { /** Signing certificate public key and chain in PKCS#7 (.P7B) format. */ pkcs7?: string | undefined; /** Signing certificate public key in X.509 (.CER) format. */ cert?: string | undefined; /** Subject name for this certificate in the format `/CN={domain}`. */ subject?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Signing certificates associated with this client. */ export type ClientSigningKeys = (Management.ClientSigningKey[] | null) | undefined; /** Security mode for third-party clients. `strict` enforces enhanced security controls: OAuth 2.1 alignment, explicit API authorization, and a curated set of supported features. `permissive` preserves pre-existing behavior and is only available to tenants with prior third-party client usage. Set on creation and cannot be modified. */ export declare const ClientThirdPartySecurityModeEnum: { readonly Strict: "strict"; readonly Permissive: "permissive"; }; export type ClientThirdPartySecurityModeEnum = (typeof ClientThirdPartySecurityModeEnum)[keyof typeof ClientThirdPartySecurityModeEnum]; /** Defines the requested authentication method for the token endpoint. Can be `none` (public client without a client secret), `client_secret_post` (client uses HTTP POST parameters), or `client_secret_basic` (client uses HTTP Basic). */ export declare const ClientTokenEndpointAuthMethodEnum: { readonly None: "none"; readonly ClientSecretPost: "client_secret_post"; readonly ClientSecretBasic: "client_secret_basic"; }; export type ClientTokenEndpointAuthMethodEnum = (typeof ClientTokenEndpointAuthMethodEnum)[keyof typeof ClientTokenEndpointAuthMethodEnum]; /** Defines the requested authentication method for the token endpoint. Can be `none` (public client without a client secret), `client_secret_post` (client uses HTTP POST parameters), or `client_secret_basic` (client uses HTTP Basic). */ export declare const ClientTokenEndpointAuthMethodOrNullEnum: { readonly None: "none"; readonly ClientSecretPost: "client_secret_post"; readonly ClientSecretBasic: "client_secret_basic"; }; export type ClientTokenEndpointAuthMethodOrNullEnum = (typeof ClientTokenEndpointAuthMethodOrNullEnum)[keyof typeof ClientTokenEndpointAuthMethodOrNullEnum]; /** * Configuration for token exchange. */ export interface ClientTokenExchangeConfiguration { /** List the enabled token exchange types for this client. */ allow_any_profile_of_type?: Management.ClientTokenExchangeTypeEnum[] | undefined; } /** * Configuration for token exchange. */ export interface ClientTokenExchangeConfigurationOrNull { /** List the enabled token exchange types for this client. */ allow_any_profile_of_type?: Management.ClientTokenExchangeTypeEnum[] | undefined; } /** Token exchange type. `on_behalf_of_token_exchange`: enables On-Behalf-Of token exchange (Generally Available). `custom_authentication`: enables custom token exchange profiles (Early Access, requires entitlement). */ export declare const ClientTokenExchangeTypeEnum: { readonly CustomAuthentication: "custom_authentication"; readonly OnBehalfOfTokenExchange: "on_behalf_of_token_exchange"; }; export type ClientTokenExchangeTypeEnum = (typeof ClientTokenExchangeTypeEnum)[keyof typeof ClientTokenExchangeTypeEnum]; export interface ConnectedAccount { /** The unique identifier for the connected account. */ id: string; /** The name of the connection associated with the account. */ connection: string; /** The unique identifier of the connection associated with the account. */ connection_id: string; /** The authentication strategy used by the connection. */ strategy: string; access_type: Management.ConnectedAccountAccessTypeEnum; /** The scopes granted for this connected account. */ scopes?: string[] | undefined; /** ISO 8601 timestamp when the connected account was created. */ created_at: string; /** ISO 8601 timestamp when the connected account expires. */ expires_at?: string | undefined; /** The identifier of the organization associated with the connected account. */ organization_id?: string | undefined; } /** The access type for the connected account. */ export declare const ConnectedAccountAccessTypeEnum: { readonly Offline: "offline"; }; export type ConnectedAccountAccessTypeEnum = (typeof ConnectedAccountAccessTypeEnum)[keyof typeof ConnectedAccountAccessTypeEnum]; /** * The URL of the OAuth 1.0a access-token endpoint. This endpoint is used to exchange the temporary request token obtained from the request-token endpoint for an access token during the OAuth 1.0a authentication flow. */ export type ConnectionAccessTokenUrloAuth1 = Management.ConnectionHttpsUrlWithHttpFallback255; /** * A list of the Authentication Context Class References that this OP supports */ export type ConnectionAcrValuesSupported = string[]; /** * Expiration timestamp for the `admin_access_token` in ISO 8601 format. Auth0 uses this value to determine when to refresh the token. */ export type ConnectionAdminAccessTokenExpiresInGoogleApps = string; /** * Google Workspace admin access token used to retrieve extended user attributes (such as group memberships, admin status, and suspension state) from the [Google Directory API](https://developers.google.com/admin-sdk/directory). This token is automatically managed by Auth0. */ export type ConnectionAdminAccessTokenGoogleApps = string; /** * Google Workspace admin refresh token used to obtain new access tokens for the [Google Directory API](https://developers.google.com/admin-sdk/directory). This token is granted when a Google Workspace admin authorizes Auth0 to access directory data. */ export type ConnectionAdminRefreshTokenGoogleApps = string; /** * IP address of the AD connector agent used to validate that authentication requests originate from the corporate network for Kerberos authentication (managed by the AD Connector agent). */ export type ConnectionAgentIpad = string; /** * When enabled, allows direct username/password authentication through the AD connector agent instead of WS-Federation protocol (managed by the AD Connector agent). */ export type ConnectionAgentModeAd = boolean; /** * Version identifier of the installed AD connector agent software (managed by the AD Connector agent). */ export type ConnectionAgentVersionAd = string; /** * List of allowed audiences in the ID token for Google Native Social Login */ export type ConnectionAllowedAudiencesGoogleOAuth2 = string[]; /** Specifies the API behavior for password authentication */ export declare const ConnectionApiBehaviorEnum: { readonly Required: "required"; readonly Optional: "optional"; }; export type ConnectionApiBehaviorEnum = (typeof ConnectionApiBehaviorEnum)[keyof typeof ConnectionApiBehaviorEnum]; export type ConnectionApiEnableGroups = boolean; /** * Enables integration with the Google Workspace Admin SDK Directory API for groups. When true, Auth0 can synchronize groups & group memberships and supports inbound directory provisioning for groups. Defaults to false. */ export type ConnectionApiEnableGroupsGoogleApps = Management.ConnectionApiEnableGroups; export type ConnectionApiEnableUsers = boolean; /** * Enables integration with the Google Workspace Admin SDK Directory API. When true, Auth0 can retrieve extended user attributes (admin status, suspension status, group memberships) and supports inbound directory provisioning (SCIM). Defaults to true. */ export type ConnectionApiEnableUsersGoogleApps = Management.ConnectionApiEnableUsers; /** * The Azure AD application domain (e.g., 'contoso.onmicrosoft.com'). Used primarily with WS-Federation protocol and Azure AD v1 endpoints. */ export type ConnectionAppDomainAzureAd = string; export interface ConnectionAttributeIdentifier { /** Determines if the attribute is used for identification */ active?: boolean | undefined; default_method?: Management.DefaultMethodEmailIdentifierEnum | undefined; } /** * Object containing mapping details for incoming claims */ export type ConnectionAttributeMapAttributes = Record; /** * Configuration for mapping claims from the identity provider to Auth0 user profile attributes. Allows customizing which IdP claims populate user fields and how they are transformed. */ export interface ConnectionAttributeMapOidc { attributes?: Management.ConnectionAttributeMapAttributes | undefined; mapping_mode?: Management.ConnectionMappingModeEnumOidc | undefined; userinfo_scope?: Management.ConnectionAttributeMapUserinfoScope | undefined; } /** * Mapping of claims received from the identity provider (IdP) */ export interface ConnectionAttributeMapOkta { attributes?: Management.ConnectionAttributeMapAttributes | undefined; mapping_mode?: Management.ConnectionMappingModeEnumOkta | undefined; userinfo_scope?: Management.ConnectionAttributeMapUserinfoScope | undefined; } /** * Scopes to send to the IdP's Userinfo endpoint */ export type ConnectionAttributeMapUserinfoScope = string; /** * Attribute configuration */ export interface ConnectionAttributes { email?: Management.EmailAttribute | undefined; phone_number?: Management.PhoneAttribute | undefined; username?: Management.UsernameAttribute | undefined; } /** * Additional properties for OAuth2 connection authentication parameters */ export type ConnectionAuthParamsAdditionalPropertiesOAuth2 = string; /** * Authentication Parameters (must be valid JSON string) */ export type ConnectionAuthParamsEmail = string; /** * Maps parameter names from Auth0's /authorize endpoint to the identity provider's authorization endpoint parameters. For example, mapping 'audience' to 'resource' transforms the parameter name during authorization requests. Applied after authParams merging. See https://auth0.com/docs/authenticate/identity-providers/social-identity-providers/oauth2#pass-dynamic-parameters */ export type ConnectionAuthParamsMap = Record; /** * Additional static parameters included in every authorization request to the identity provider. These parameters are merged with runtime parameters before the authorization redirect. Keys and values are passed as-is to the identity provider's authorization endpoint. See https://auth0.com/docs/authenticate/identity-providers/social-identity-providers/oauth2#pass-static-parameters */ export type ConnectionAuthParamsOAuth2 = Record; /** * Options for enabling authentication methods. */ export interface ConnectionAuthenticationMethods { password?: Management.ConnectionPasswordAuthenticationMethod | undefined; passkey?: Management.ConnectionPasskeyAuthenticationMethod | undefined; email_otp?: Management.ConnectionEmailOtpAuthenticationMethod | undefined; phone_otp?: Management.ConnectionPhoneOtpAuthenticationMethod | undefined; } /** * Configure the purpose of a connection to be used for authentication during login. */ export interface ConnectionAuthenticationPurpose { active: boolean; } export type ConnectionAuthorizationEndpoint = string; /** * Base URL override for the Exact Online API endpoint used for OAuth2 authorization and API requests. Defaults to https://start.exactonline.nl. */ export type ConnectionBaseUrlExact = Management.ConnectionHttpsUrlWithHttpFallback; /** * Enables Auth0's brute force protection to prevent credential stuffing attacks. When enabled, blocks suspicious login attempts from specific IP addresses after repeated failures. */ export type ConnectionBruteForceProtection = boolean; export type ConnectionCalculatedThumbprintSaml = Management.ConnectionSha1Thumbprint; /** * Array of X.509 certificates in PEM format used for validating SAML signatures from the AD identity provider (managed by the AD Connector agent). */ export type ConnectionCertsAd = string[]; /** * JSON array containing a list of the Claim Types that the OpenID Provider supports. These Claim Types are described in Section 5.6 of OpenID Connect Core 1.0 [OpenID.Core]. If omitted, the implementation supports only normal Claims. */ export type ConnectionClaimTypesSupported = string[]; /** * Languages and scripts supported for values in Claims being returned, represented as a JSON array of BCP47 [RFC5646] language tag values. Not all languages and scripts are necessarily supported for all Claim values. */ export type ConnectionClaimsLocalesSupported = string[]; /** * Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support. If omitted, the default value is false. */ export type ConnectionClaimsParameterSupported = boolean; /** * JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list. */ export type ConnectionClaimsSupported = string[]; /** * OAuth 2.0 client identifier issued by the identity provider during application registration. This value identifies your Auth0 connection to the identity provider. */ export type ConnectionClientIdBitbucket = string; /** * OAuth 2.0 client identifier issued by the identity provider during application registration. This value identifies your Auth0 connection to the identity provider. */ export type ConnectionClientId = string; /** * OAuth 2.0 client identifier obtained from Amazon Developer Console during Login with Amazon application registration. When not provided, Auth0 development keys are used for testing purposes. */ export type ConnectionClientIdAmazon = Management.ConnectionClientId; export type ConnectionClientIdAzureAd = Management.ConnectionClientId; /** * OAuth2.0 client identifier for the Exact Online connection, obtained when registering your application in the Exact App Center. */ export type ConnectionClientIdExact = Management.ConnectionClientId; /** * Your Facebook App ID. You can find this in your [Facebook Developers Console](https://developers.facebook.com/apps) under the App Settings section. */ export type ConnectionClientIdFacebook = Management.ConnectionClientId; /** * Your Google OAuth 2.0 client ID. You can find this in your [Google Cloud Console](https://console.cloud.google.com/apis/credentials) under the OAuth 2.0 Client IDs section. */ export type ConnectionClientIdGoogleApps = Management.ConnectionClientId; /** * Your Google OAuth 2.0 client ID. You can find this in your [Google Cloud Console](https://console.cloud.google.com/apis/credentials) under the OAuth 2.0 Client IDs section. */ export type ConnectionClientIdGoogleOAuth2 = string; /** * LINE Channel ID issued by LINE during application registration. This value identifies your Auth0 connection to LINE. */ export type ConnectionClientIdLine = string; /** * LinkedIn application client identifier */ export type ConnectionClientIdLinkedin = string; /** * OAuth 1.0a client ID (consumer key) that identifies the client to the provider and is used to sign OAuth 1.0a requests. */ export type ConnectionClientIdOAuth1 = Management.ConnectionClientId; export type ConnectionClientIdOAuth2 = Management.ConnectionClientId; export type ConnectionClientIdOidc = Management.ConnectionClientId; /** * OAuth 2.0 client identifier issued by PayPal during application registration. This value identifies your Auth0 connection to PayPal. Leave empty to use Auth0 Dev Keys. */ export type ConnectionClientIdPaypal = Management.ConnectionClientId; /** * The OAuth 2.0 client identifier */ export type ConnectionClientIdSalesforce = string; /** * OAuth 2.0 client identifier issued by the identity provider during application registration. This value identifies your Auth0 connection to the identity provider. */ export type ConnectionClientIdWindowsLive = string; /** * The response protocol used to communicate with the default application. */ export type ConnectionClientProtocolSaml = Management.ConnectionOptionsIdpInitiatedClientProtocolEnumSaml; /** * OAuth 2.0 client secret issued by the identity provider during application registration. Used to authenticate your Auth0 connection when exchanging authorization codes for tokens. May be null for public clients. */ export type ConnectionClientSecret = string; /** * OAuth 2.0 client secret obtained from Amazon Developer Console during Login with Amazon application registration. Used to authenticate your application when exchanging authorization codes for tokens. */ export type ConnectionClientSecretAmazon = Management.ConnectionClientSecret; /** * The client secret (application password) from your Azure AD app registration. Used to authenticate your application when exchanging authorization codes for tokens. */ export type ConnectionClientSecretAzureAd = string; export type ConnectionClientSecretBitbucket = Management.ConnectionClientSecret; /** * OAuth2.0 client secret for the Exact Online connection, obtained when registering your application in the Exact App Center. */ export type ConnectionClientSecretExact = Management.ConnectionClientSecret; /** * Your Facebook App Secret. You can find this in your [Facebook Developers Console](https://developers.facebook.com/apps) under the App Settings section. */ export type ConnectionClientSecretFacebook = Management.ConnectionClientSecret; /** * Your Google OAuth 2.0 client secret. You can find this in your [Google Cloud Console](https://console.cloud.google.com/apis/credentials) under the OAuth 2.0 Client IDs section. */ export type ConnectionClientSecretGoogleApps = Management.ConnectionClientSecret; /** * Your Google OAuth 2.0 client secret. You can find this in your [Google Cloud Console](https://console.cloud.google.com/apis/credentials) under the OAuth 2.0 Client IDs section. */ export type ConnectionClientSecretGoogleOAuth2 = string; /** * LINE Channel Secret issued by provider during application registration. This value is used to authenticate your Auth0 connection to the identity provider. */ export type ConnectionClientSecretLine = string; /** * OAuth 2.0 client secret issued by the identity provider during application registration. This value is used to authenticate your Auth0 connection to the identity provider. */ export type ConnectionClientSecretLinkedin = string; /** * OAuth 1.0a client secret paired with the consumer key to sign request-token and access-token requests for this connection. Treat as a sensitive credential and supply the exact secret issued by the upstream provider. */ export type ConnectionClientSecretOAuth1 = Management.ConnectionClientSecret; export type ConnectionClientSecretOAuth2 = Management.ConnectionClientSecret; export type ConnectionClientSecretOidc = Management.ConnectionClientSecret; /** * OAuth 2.0 client secret issued by PayPal during application registration. Leave empty to use Auth0 Dev Keys. */ export type ConnectionClientSecretPaypal = Management.ConnectionClientSecret; /** * The OAuth 2.0 client secret */ export type ConnectionClientSecretSalesforce = string; export type ConnectionClientSecretWindowsLive = Management.ConnectionClientSecret; export interface ConnectionCommon { display_name?: Management.ConnectionDisplayName | undefined; enabled_clients?: Management.ConnectionEnabledClients | undefined; is_domain_connection?: Management.ConnectionIsDomainConnection | undefined; metadata?: Management.ConnectionsMetadata | undefined; } /** * The base URL of your Salesforce Community (Experience Cloud) site. When specified, authentication flows will use this Community URL instead of the standard Salesforce login page, enabling users to authenticate through your branded Community portal. */ export type ConnectionCommunityBaseUrlSalesforce = Management.ConnectionHttpsUrlWithHttpFallback; /** * A hash of configuration key/value pairs. */ export type ConnectionConfiguration = Record; /** * Configure the purpose of a connection to be used for connected accounts and Token Vault. */ export interface ConnectionConnectedAccountsPurpose { active: boolean; cross_app_access?: boolean | undefined; } /** * Configure the purpose of a connection to be used for connected accounts and Token Vault. */ export interface ConnectionConnectedAccountsPurposeXaa { cross_app_access?: boolean | undefined; active: boolean; } /** * OAuth 2.0 PKCE (Proof Key for Code Exchange) settings. PKCE enhances security for public clients by preventing authorization code interception attacks. 'auto' (recommended) uses the strongest method supported by the IdP. */ export interface ConnectionConnectionSettings { pkce?: Management.ConnectionConnectionSettingsPkceEnum | undefined; } /** PKCE configuration. */ export declare const ConnectionConnectionSettingsPkceEnum: { readonly Auto: "auto"; readonly S256: "S256"; readonly Plain: "plain"; readonly Disabled: "disabled"; }; export type ConnectionConnectionSettingsPkceEnum = (typeof ConnectionConnectionSettingsPkceEnum)[keyof typeof ConnectionConnectionSettingsPkceEnum]; /** * Custom HTTP headers sent with token exchange requests to the identity provider's token endpoint. Provided as key-value pairs (e.g., {'X-Custom-Header': 'value'}). Auth0's User-Agent header is always included by default. */ export type ConnectionCustomHeadersOAuth2 = Record; /** * A map of scripts used to integrate with a custom database. */ export interface ConnectionCustomScripts { login?: string | undefined; get_user?: string | undefined; delete?: string | undefined; change_password?: string | undefined; verify?: string | undefined; create?: string | undefined; change_username?: string | undefined; change_email?: string | undefined; change_phone_number?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * When true, enables detailed SAML debugging by issuing 'w' (warning) events in tenant logs containing SAML request/response details. WARNING: Potentially exposes sensitive user information (PII, credentials) and should only be enabled temporarily for debugging purposes. */ export type ConnectionDebugSaml = boolean; /** * Private key used to decrypt encrypted SAML Assertions received from the identity provider. Required when the identity provider encrypts assertions for enhanced security. Can be a string (PEM) or an object with key-value pairs. */ export type ConnectionDecryptionKeySaml = /** * Key pair with 'key' and 'cert' properties. */ { cert?: string | undefined; key?: string | undefined; } /** * Private key in PEM format. */ | string; /** * The URL where Auth0 will send SAML authentication requests (the Identity Provider's SSO URL). Must be a valid HTTPS URL. */ export type ConnectionDestinationUrlSaml = Management.ConnectionHttpsUrlWithHttpFallback255; /** Algorithm used for computing digest values when signing SAML requests and logout requests. Defaults to 'sha256'. */ export declare const ConnectionDigestAlgorithmEnumSaml: { readonly Sha1: "sha1"; readonly Sha256: "sha256"; }; export type ConnectionDigestAlgorithmEnumSaml = (typeof ConnectionDigestAlgorithmEnumSaml)[keyof typeof ConnectionDigestAlgorithmEnumSaml]; /** * Algorithm used for computing digest values when signing SAML requests and logout requests. Defaults to 'sha256'. */ export type ConnectionDigestAlgorithmSaml = Management.ConnectionDigestAlgorithmEnumSaml; /** * Indicates whether to disable self-service change password. Set to true to stop the "Forgot Password" being displayed on login pages */ export type ConnectionDisableSelfServiceChangePassword = boolean; /** * When true, prevents new user registration through this connection. Existing users can still authenticate. Useful for invite-only applications or during user migration. */ export type ConnectionDisableSignup = boolean; /** * Controls whether new user signups are allowed via SMS authentication */ export type ConnectionDisableSignupSms = Management.ConnectionDisableSignup; /** * URL of the identity provider's OIDC Discovery endpoint (/.well-known/openid-configuration). When provided and oidc_metadata is empty, Auth0 automatically retrieves the provider's configuration including endpoints and supported features. */ export type ConnectionDiscoveryUrl = Management.ConnectionHttpsUrlWithHttpFallback255; /** * Connection name used in the new universal login experience */ export type ConnectionDisplayName = string; /** * JSON array containing a list of the JWS signing algorithms (alg values) supported by the Token Endpoint for the signature on the JWT [JWT] used to authenticate the Client at the Token Endpoint for the private_key_jwt and client_secret_jwt authentication methods. Servers SHOULD support RS256. The value none MUST NOT be used. */ export type ConnectionDisplayValuesSupported = string[]; /** * Email domains associated with this connection for Home Realm Discovery (HRD). When a user's email matches one of these domains, they are automatically routed to this connection during authentication. */ export type ConnectionDomainAliases = Management.ConnectionDomainAliasesItemsOne[]; /** * List of domain names that can be used with identifier-first authentication flow to route users to this AD connection; each domain must be a valid DNS name up to 256 characters */ export type ConnectionDomainAliasesAd = string[]; /** * Alternative domain names associated with this Azure AD tenant. Allows users from multiple verified domains to authenticate through this connection. Can be an array of domain strings. */ export type ConnectionDomainAliasesAzureAd = string[]; export type ConnectionDomainAliasesItemsOne = string; /** * Domain aliases for the connection */ export type ConnectionDomainAliasesSaml = Management.ConnectionDomainAliasesItemsOne[]; /** * Primary Google Workspace domain name that users must belong to. */ export type ConnectionDomainGoogleApps = string; /** * Domain of the Okta organization (e.g., dev-123456.okta.com). Should be just the domain of the okta server with no scheme or trailing backslash. Discovery runs only when connection.options.oidc_metadata is empty and a domain is provided */ export type ConnectionDomainOkta = string; /** Algorithm used for DPoP proof JWT signing. */ export declare const ConnectionDpopSigningAlgEnum: { readonly Es256: "ES256"; readonly Ed25519: "Ed25519"; }; export type ConnectionDpopSigningAlgEnum = (typeof ConnectionDpopSigningAlgEnum)[keyof typeof ConnectionDpopSigningAlgEnum]; /** * JSON array containing a list of the JWS signing algorithms (alg values) supported for DPoP proof JWT signing. */ export type ConnectionDpopSigningAlgValuesSupported = string[]; /** * Email body content */ export type ConnectionEmailBodyEmail = string; /** * Email template configuration */ export interface ConnectionEmailEmail { body?: Management.ConnectionEmailBodyEmail | undefined; from?: Management.ConnectionEmailFromEmail | undefined; subject?: Management.ConnectionEmailSubjectEmail | undefined; /** Email template syntax type */ syntax?: ConnectionEmailEmail.Syntax | undefined; } export declare namespace ConnectionEmailEmail { /** Email template syntax type */ const Syntax: { readonly Liquid: "liquid"; }; type Syntax = (typeof Syntax)[keyof typeof Syntax]; } /** * From email address */ export type ConnectionEmailFromEmail = string; /** * Email OTP authentication enablement */ export interface ConnectionEmailOtpAuthenticationMethod { /** Determines whether email OTP is enabled */ enabled?: boolean | undefined; } /** * Email subject line */ export type ConnectionEmailSubjectEmail = string; /** * Set to true to inject context into custom DB scripts (warning: cannot be disabled once enabled) */ export type ConnectionEnableScriptContext = boolean; export interface ConnectionEnabledClient { /** The client id */ client_id: string; /** Accepts any additional properties */ [key: string]: any; } /** * DEPRECATED property. Use the PATCH /v2/connections/{id}/clients endpoint to enable the connection for a set of clients. */ export type ConnectionEnabledClients = string[]; /** * Set to true to use a legacy user store */ export type ConnectionEnabledDatabaseCustomization = boolean; /** * URL of the identity provider's logout/end session endpoint. When configured as a static URL, users are redirected here after logging out from Auth0. Must use HTTPS scheme. */ export type ConnectionEndSessionEndpoint = string; /** * The entity identifier (Issuer) for the SAML Service Provider. When not provided, defaults to 'urn:auth0:{tenant}:{connection}'. This value is included in SAML AuthnRequest messages sent to the identity provider. */ export type ConnectionEntityIdSaml = string; /** * Indicates to store whether the user is a domain administrator. */ export type ConnectionExtAdmin = boolean; /** * Indicates to store whether the user has agreed to the terms of service. */ export type ConnectionExtAgreedTerms = boolean; /** * Fetches the `agreedToTerms` flag from the Google Directory profile. */ export type ConnectionExtAgreedTermsGoogleApps = Management.ConnectionExtAgreedTerms; /** * Indicates whether to store a list of the Office 365 assigned plans for the user. */ export type ConnectionExtAssignedPlans = boolean; export type ConnectionExtGroups = boolean; /** * When enabled (true), retrieves and stores Azure AD security group memberships for the user. Requires Microsoft Graph API permissions (Directory.Read.All). Allows configuring max_groups_to_retrieve. */ export type ConnectionExtGroupsAzureAd = Management.ConnectionExtGroups; /** * Enables enrichment with Google group memberships (required for `ext_groups_extended`). */ export type ConnectionExtGroupsGoogleApps = Management.ConnectionExtGroups; /** * Fetches the Google Directory admin flag for the signing-in user. */ export type ConnectionExtIsAdminGoogleApps = Management.ConnectionExtAdmin; /** * Indicates to store whether a user's account is suspended. */ export type ConnectionExtIsSuspended = boolean; /** * Fetches the Google Directory suspended flag for the signing-in user. */ export type ConnectionExtIsSuspendedGoogleApps = Management.ConnectionExtIsSuspended; /** * When enabled (true), retrieves extended profile attributes from Azure AD via Microsoft Graph API (job title, department, office location, etc.). Requires Graph API permissions. Only available with Azure AD v1 or when explicitly enabled for v2. */ export type ConnectionExtProfile = boolean; /** * Federated Connections Access Tokens */ export interface ConnectionFederatedConnectionsAccessTokens { /** Enables refresh tokens and access tokens collection for federated connections */ active?: boolean | undefined; } /** * Mapping of user profile fields returned from the OAuth2 provider to Auth0 user attributes */ export type ConnectionFieldsMap = Record; /** * Maps SAML assertion attributes from the identity provider to Auth0 user profile attributes. Format: { 'auth0_field': 'saml_attribute' } or { 'auth0_field': ['saml_attr1', 'saml_attr2'] } for fallback options. Merged with default mappings for email, name, given_name, family_name, and groups. */ export type ConnectionFieldsMapSaml = Record; export declare namespace ConnectionFieldsMapSaml { type Value = string | string[]; } export interface ConnectionForList { /** The name of the connection */ name?: string | undefined; /** Connection name used in login screen */ display_name?: string | undefined; options?: Management.ConnectionOptions | undefined; /** The connection's identifier */ id?: string | undefined; /** The type of the connection, related to the identity provider */ strategy?: string | undefined; /** Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm. */ realms?: string[] | undefined; /** True if the connection is domain level */ is_domain_connection?: boolean | undefined; /** Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. */ show_as_button?: boolean | undefined; metadata?: Management.ConnectionsMetadata | undefined; authentication?: Management.ConnectionAuthenticationPurpose | undefined; connected_accounts?: Management.ConnectionConnectedAccountsPurpose | undefined; } /** * Connection to be added to the organization. */ export interface ConnectionForOrganization { /** ID of the connection. */ connection_id: string; /** 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. */ assign_membership_on_login?: boolean | undefined; /** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */ show_as_button?: boolean | undefined; /** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */ is_signup_enabled?: boolean | undefined; } /** * When set to true, the gateway receives HTTP request details including IP address and User Agent from the client. */ export type ConnectionForwardReqInfoSms = boolean; /** * Additional OAuth scopes to request from Amazon beyond the standard profile and postal_code scopes. These scopes must be valid Amazon Login scopes. */ export type ConnectionFreeformScopesAmazon = Management.ConnectionScopeArray; /** * Array of custom OAuth 2.0 scopes to request from Google during authentication. Use this to request scopes not covered by the predefined scope options. */ export type ConnectionFreeformScopesGoogleOAuth2 = Management.ConnectionScopeArray; /** * Array of custom OAuth 2.0 scopes to request from Linkedin during authentication. Use this to request scopes not covered by the predefined scope options. */ export type ConnectionFreeformScopesLinkedin = Management.ConnectionScopeArray; /** * Additional OAuth scopes to request from PayPal beyond the standard attribute scopes. Enter valid PayPal scopes from their documentation. Invalid scopes may cause authentication errors. */ export type ConnectionFreeformScopesPaypal = Management.ConnectionScopeArray; /** * Additional OAuth scopes to request from Salesforce beyond the standard profile permissions. Enter valid scopes from the Salesforce documentation. Invalid scopes may cause authentication errors. */ export type ConnectionFreeformScopesSalesforce = Management.ConnectionScopeArray; /** * Custom OAuth scopes not predefined in the standard scope list. */ export type ConnectionFreeformScopesWindowsLive = Management.ConnectionScopeArray; /** * The sender phone number or alphanumeric sender ID for outgoing SMS messages */ export type ConnectionFromSms = string; /** * Token-based authentication settings to be applied when connection is using an sms strategy. */ export interface ConnectionGatewayAuthentication { /** The Authorization header type. */ method: string; /** The subject to be added to the JWT payload. */ subject?: string | undefined; /** The audience to be added to the JWT payload. */ audience: string; /** The secret to be used for signing tokens. */ secret: string; /** Set to true if the provided secret is base64 encoded. */ secret_base64_encoded?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * `aud` claim value in the JWT sent to the SMS gateway. Identifies the gateway service (e.g., 'urn:MySmsGateway'). */ export type ConnectionGatewayAuthenticationAudienceSms = string; /** * The Authorization header type when calling the SMS gateway. Set to 'bearer' for JWT token authentication. */ export type ConnectionGatewayAuthenticationMethodSms = string; /** * Optional token-based authentication configuration for the SMS gateway */ export interface ConnectionGatewayAuthenticationSms { audience: Management.ConnectionGatewayAuthenticationAudienceSms; method: Management.ConnectionGatewayAuthenticationMethodSms; /** The secret used to sign the JSON Web Token sent to the SMS gateway */ secret: string; /** Set to true if the secret is base64-url-encoded */ secret_base64_encoded?: boolean | undefined; subject?: Management.ConnectionGatewayAuthenticationSubjectSms | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * `sub` claim value in the JWT sent to the SMS gateway. Identifies the requester (e.g., 'urn:Auth0'). */ export type ConnectionGatewayAuthenticationSubjectSms = string; /** * The URL of your SMS gateway. Auth0 must be able to reach this URL for it to use your gateway to send messages on your behalf. */ export type ConnectionGatewayUrlSms = Management.ConnectionHttpsUrlWithHttpFallback255; /** * Expected 'iss' (Issuer) claim value for JWT tokens in Global Token Revocation requests from the identity provider. When configured, Auth0 validates the JWT issuer matches this value before processing token revocation. Must be used together with global_token_revocation_jwt_sub. */ export type ConnectionGlobalTokenRevocationJwtIssSaml = string; /** * Expected 'sub' (Subject) claim value for JWT tokens in Global Token Revocation requests from the identity provider. When configured, Auth0 validates the JWT subject matches this value before processing token revocation. Must be used together with global_token_revocation_jwt_iss. */ export type ConnectionGlobalTokenRevocationJwtSubSaml = string; /** * A list of the OAuth 2.0 Grant Type values that this OP supports. Dynamic OpenID Providers MUST support the authorization_code and implicit Grant Type values and MAY support other Grant Types. If omitted, the default value is ["authorization_code", "implicit"]. */ export type ConnectionGrantTypesSupported = string[]; /** * When enabled, users who sign in with their Google account through a social login will be automatically routed to this Google Workspace connection if their email domain matches the configured tenant_domain or domain_aliases. This ensures enterprise users authenticate through their organization's Google Workspace identity provider rather than through a generic Google social login, enabling access to directory-based attributes and enforcing organizational security policies. Defaults to true for new connections. */ export type ConnectionHandleLoginFromSocialGoogleApps = boolean; export type ConnectionHttpsUrlWithHttpFallback = string; export type ConnectionHttpsUrlWithHttpFallback2048 = Management.ConnectionHttpsUrlWithHttpFallback; export type ConnectionHttpsUrlWithHttpFallback255 = Management.ConnectionHttpsUrlWithHttpFallback; /** * https url of the icon to be shown */ export type ConnectionIconUrl = string; /** * URL for the connection icon displayed in Auth0 login pages. Accepts HTTPS URLs. Used for visual branding in authentication flows. */ export type ConnectionIconUrlAdfs = Management.ConnectionIconUrl; /** * URL for the connection icon displayed in Auth0 login pages. Accepts HTTPS URLs. Used for visual branding in authentication flows. */ export type ConnectionIconUrlAzureAd = Management.ConnectionIconUrl; /** * URL for the connection icon displayed in Auth0 login pages. Accepts HTTPS URLs. Used for visual branding in authentication flows. */ export type ConnectionIconUrlGoogleApps = Management.ConnectionIconUrl; /** * URL for the connection icon displayed in Auth0 login pages. Accepts HTTPS URLs. Used for visual branding in authentication flows. */ export type ConnectionIconUrlGoogleOAuth2 = Management.ConnectionIconUrl; /** * URL for the connection icon displayed in Auth0 login pages. Accepts HTTPS URLs. Used for visual branding in authentication flows. */ export type ConnectionIconUrlSaml = Management.ConnectionIconUrl; /** * The connection's identifier */ export type ConnectionId = string; /** * JSON array containing a list of the JWE encryption algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT */ export type ConnectionIdTokenEncryptionAlgValuesSupported = string[]; /** * JSON array containing a list of the JWE encryption algorithms (enc values) supported by the OP for the ID Token to encode the Claims in a JWT [JWT]. */ export type ConnectionIdTokenEncryptionEncValuesSupported = string[]; /** Algorithm allowed to verify the ID tokens. */ export declare const ConnectionIdTokenSignedResponseAlgEnum: { readonly Es256: "ES256"; readonly Es384: "ES384"; readonly Ps256: "PS256"; readonly Ps384: "PS384"; readonly Rs256: "RS256"; readonly Rs384: "RS384"; readonly Rs512: "RS512"; }; export type ConnectionIdTokenSignedResponseAlgEnum = (typeof ConnectionIdTokenSignedResponseAlgEnum)[keyof typeof ConnectionIdTokenSignedResponseAlgEnum]; /** * List of algorithms allowed to verify the ID tokens. */ export type ConnectionIdTokenSignedResponseAlgs = (Management.ConnectionIdTokenSignedResponseAlgEnum[] | null) | undefined; /** * A list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT. The algorithm RS256 MUST be included. The value none MAY be supported, but MUST NOT be used unless the Response Type used returns no ID Token from the Authorization Endpoint (such as when using the Authorization Code Flow). https://datatracker.ietf.org/doc/html/rfc7518 */ export type ConnectionIdTokenSigningAlgValuesSupported = string[]; /** * Order of precedence for attribute types. If the property is not specified, the default precedence of attributes will be used. */ export type ConnectionIdentifierPrecedence = Management.ConnectionIdentifierPrecedenceEnum[]; /** Order of precedence for attribute types */ export declare const ConnectionIdentifierPrecedenceEnum: { readonly Email: "email"; readonly PhoneNumber: "phone_number"; readonly Username: "username"; }; export type ConnectionIdentifierPrecedenceEnum = (typeof ConnectionIdentifierPrecedenceEnum)[keyof typeof ConnectionIdentifierPrecedenceEnum]; /** * The Azure AD endpoint version for authentication. 'microsoft-identity-platform-v2.0' (recommended, default) supports modern OAuth 2.0 features. 'azure-active-directory-v1.0' is the legacy endpoint with protocol limitations. Selection affects available features. */ export type ConnectionIdentityApiAzureAd = Management.ConnectionIdentityApiEnumAzureAd; /** Identity API version to use */ export declare const ConnectionIdentityApiEnumAzureAd: { readonly MicrosoftIdentityPlatformV20: "microsoft-identity-platform-v2.0"; readonly AzureActiveDirectoryV10: "azure-active-directory-v1.0"; }; export type ConnectionIdentityApiEnumAzureAd = (typeof ConnectionIdentityApiEnumAzureAd)[keyof typeof ConnectionIdentityApiEnumAzureAd]; /** The identity provider identifier for the connection */ export declare const ConnectionIdentityProviderEnum: { readonly Ad: "ad"; readonly Adfs: "adfs"; readonly Amazon: "amazon"; readonly Apple: "apple"; readonly Dropbox: "dropbox"; readonly Bitbucket: "bitbucket"; readonly Auth0Oidc: "auth0-oidc"; readonly Auth0: "auth0"; readonly Baidu: "baidu"; readonly Bitly: "bitly"; readonly Box: "box"; readonly Custom: "custom"; readonly Daccount: "daccount"; readonly Dwolla: "dwolla"; readonly Email: "email"; readonly EvernoteSandbox: "evernote-sandbox"; readonly Evernote: "evernote"; readonly Exact: "exact"; readonly Facebook: "facebook"; readonly Fitbit: "fitbit"; readonly Github: "github"; readonly GoogleApps: "google-apps"; readonly GoogleOauth2: "google-oauth2"; readonly Instagram: "instagram"; readonly Ip: "ip"; readonly Line: "line"; readonly Linkedin: "linkedin"; readonly Oauth1: "oauth1"; readonly Oauth2: "oauth2"; readonly Office365: "office365"; readonly Oidc: "oidc"; readonly Okta: "okta"; readonly Paypal: "paypal"; readonly PaypalSandbox: "paypal-sandbox"; readonly Pingfederate: "pingfederate"; readonly Planningcenter: "planningcenter"; readonly SalesforceCommunity: "salesforce-community"; readonly SalesforceSandbox: "salesforce-sandbox"; readonly Salesforce: "salesforce"; readonly Samlp: "samlp"; readonly Sharepoint: "sharepoint"; readonly Shopify: "shopify"; readonly Shop: "shop"; readonly Sms: "sms"; readonly Soundcloud: "soundcloud"; readonly Thirtysevensignals: "thirtysevensignals"; readonly Twitter: "twitter"; readonly Untappd: "untappd"; readonly Vkontakte: "vkontakte"; readonly Waad: "waad"; readonly Weibo: "weibo"; readonly Windowslive: "windowslive"; readonly Wordpress: "wordpress"; readonly Yahoo: "yahoo"; readonly Yandex: "yandex"; }; export type ConnectionIdentityProviderEnum = (typeof ConnectionIdentityProviderEnum)[keyof typeof ConnectionIdentityProviderEnum]; /** * Enables lazy migration mode for importing users from an external database. When a user authenticates, their credentials are validated against the legacy store, then the user is created in Auth0 for future logins. */ export type ConnectionImportMode = boolean; /** * Array of IP address ranges in CIDR notation used to determine if authentication requests originate from the corporate network for Kerberos or certificate authentication. */ export type ConnectionIpsAd = string[]; /** * true promotes to a domain-level connection so that third-party applications can use it. false does not promote the connection, so only first-party applications with the connection enabled can use it. (Defaults to false.) */ export type ConnectionIsDomainConnection = boolean; export type ConnectionIssuer = Management.ConnectionHttpsUrlWithHttpFallback255; export type ConnectionJwksUri = Management.ConnectionHttpsUrlWithHttpFallback255; export interface ConnectionKey { /** The key id of the signing key */ kid: string; /** The public certificate of the signing key */ cert: string; /** The public certificate of the signing key in pkcs7 format */ pkcs?: string | undefined; /** True if the key is the the current key */ current?: boolean | undefined; /** True if the key is the the next key */ next?: boolean | undefined; /** True if the key is the the previous key */ previous?: boolean | undefined; /** The date and time when the key became the current key */ current_since?: string | undefined; /** The cert fingerprint */ fingerprint: string; /** The cert thumbprint */ thumbprint: string; /** Signing key algorithm */ algorithm?: string | undefined; key_use?: Management.ConnectionKeyUseEnum | undefined; subject_dn?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** Signing key use, whether for encryption or signing */ export declare const ConnectionKeyUseEnum: { readonly Encryption: "encryption"; readonly Signing: "signing"; }; export type ConnectionKeyUseEnum = (typeof ConnectionKeyUseEnum)[keyof typeof ConnectionKeyUseEnum]; /** Method used to map incoming claims when strategy=oidc. */ export declare const ConnectionMappingModeEnumOidc: { readonly BindAll: "bind_all"; readonly UseMap: "use_map"; }; export type ConnectionMappingModeEnumOidc = (typeof ConnectionMappingModeEnumOidc)[keyof typeof ConnectionMappingModeEnumOidc]; /** Method used to map incoming claims when strategy=okta. */ export declare const ConnectionMappingModeEnumOkta: { readonly BasicProfile: "basic_profile"; readonly UseMap: "use_map"; }; export type ConnectionMappingModeEnumOkta = (typeof ConnectionMappingModeEnumOkta)[keyof typeof ConnectionMappingModeEnumOkta]; /** * Maximum number of Azure AD groups to retrieve per user during authentication. Helps prevent performance issues for users in many groups. Only applies when ext_groups is enabled. Leave empty to use platform default. */ export type ConnectionMaxGroupsToRetrieve = string; /** * Twilio Messaging Service SID */ export type ConnectionMessagingServiceSidSms = string; /** * HTTPS URL to the identity provider's SAML metadata document. When provided, Auth0 automatically fetches and parses the metadata to extract signInEndpoint, signOutEndpoint, signingCert, signSAMLRequest, and protocolBinding. Use metadataUrl OR metadataXml, not both. */ export type ConnectionMetadataUrlSaml = Management.ConnectionHttpsUrlWithHttpFallback2048; /** * Standard IdP metadata XML payload used across SAML-compatible strategies. */ export type ConnectionMetadataXml = string; /** * Inline XML alternative to 'adfs_server'. Cannot be set together with 'adfs_server'. */ export type ConnectionMetadataXmlAdfs = Management.ConnectionMetadataXml; /** * SAML metadata XML document from the identity provider. When provided, automatically parsed to extract signInEndpoint, signOutEndpoint, signingCert, signSAMLRequest, and protocolBinding. Deleted after parsing to avoid persisting large documents. Not persisted to database - deleted after parsing metadata. Use metadataUrl OR metadataXml, not both. */ export type ConnectionMetadataXmlSaml = Management.ConnectionMetadataXml; /** * Multi-factor authentication configuration */ export interface ConnectionMfa { /** Indicates whether MFA is active for this connection */ active?: boolean | undefined; /** Indicates whether to return MFA enrollment settings */ return_enroll_settings?: boolean | undefined; } /** * The name of the connection. Must start and end with an alphanumeric character and can only contain alphanumeric characters and '-'. Max length 128 */ export type ConnectionName = string; /** * Connection name prefix template. */ export type ConnectionNamePrefixTemplate = string; /** * An array of user fields that should not be stored in the Auth0 database (https://auth0.com/docs/security/data-security/denylist) */ export type ConnectionNonPersistentAttrs = string[]; export type ConnectionOpPolicyUri = Management.ConnectionHttpsUrlWithHttpFallback255; export type ConnectionOpTosUri = Management.ConnectionHttpsUrlWithHttpFallback255; /** * In order to return options in the response, the `read:connections_options` scope must be present */ export type ConnectionOptions = Record; /** * Options for the 'ad' connection */ export interface ConnectionOptionsAd extends Management.ConnectionOptionsCommon { agentIP?: Management.ConnectionAgentIpad | undefined; agentMode?: Management.ConnectionAgentModeAd | undefined; agentVersion?: Management.ConnectionAgentVersionAd | undefined; brute_force_protection?: Management.ConnectionBruteForceProtection | undefined; /** Enables client SSL certificate authentication for the AD connector, requiring HTTPS on the sign-in endpoint */ certAuth?: boolean | undefined; certs?: Management.ConnectionCertsAd | undefined; /** When enabled, disables caching of AD connector authentication results to ensure real-time validation against the directory */ disable_cache?: boolean | undefined; /** When enabled, hides the 'Forgot Password' link on login pages to prevent users from initiating self-service password resets */ disable_self_service_change_password?: boolean | undefined; domain_aliases?: Management.ConnectionDomainAliasesAd | undefined; icon_url?: Management.ConnectionIconUrl | undefined; ips?: Management.ConnectionIpsAd | undefined; /** Enables Windows Integrated Authentication (Kerberos) for seamless SSO when users authenticate from within the corporate network IP ranges */ kerberos?: boolean | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; signInEndpoint?: Management.ConnectionSignInEndpointAd | undefined; tenant_domain?: Management.ConnectionTenantDomainAd | undefined; thumbprints?: Management.ConnectionThumbprintsAd | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'adfs' connection */ export interface ConnectionOptionsAdfs extends Management.ConnectionOptionsCommon { /** ADFS federation metadata host or XML URL used to discover WS-Fed endpoints and certificates. Errors if adfs_server and fedMetadataXml are both absent. */ adfs_server?: string | undefined; domain_aliases?: Management.ConnectionDomainAliases | undefined; /** The entity identifier (Issuer) for the ADFS Service Provider. When not provided, defaults to 'urn:auth0:{tenant}:{connection}'. */ entityId?: string | undefined; fedMetadataXml?: Management.ConnectionMetadataXmlAdfs | undefined; icon_url?: Management.ConnectionIconUrlAdfs | undefined; prev_thumbprints?: Management.ConnectionThumbprints | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; should_trust_email_verified_connection?: Management.ConnectionShouldTrustEmailVerifiedConnectionEnum | undefined; signInEndpoint?: Management.ConnectionSignInEndpointAdfs | undefined; tenant_domain?: Management.ConnectionTenantDomain | undefined; thumbprints?: Management.ConnectionThumbprints | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; /** Custom ADFS claim to use as the unique user identifier. When provided, this attribute is prepended to the default user_id mapping list with highest priority. Accepts a string (single ADFS claim name). */ user_id_attribute?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'amazon' connection */ export interface ConnectionOptionsAmazon extends Management.ConnectionOptionsCommon { client_id?: Management.ConnectionClientIdAmazon | undefined; client_secret?: Management.ConnectionClientSecretAmazon | undefined; freeform_scopes?: Management.ConnectionFreeformScopesAmazon | undefined; /** When enabled, requests the user's postal code from Amazon during authentication. This adds the 'postal_code' scope to the authorization request. */ postal_code?: boolean | undefined; /** When enabled, requests the user's basic profile information (name, email, user ID) from Amazon during authentication. This scope is always enabled for Amazon connections. */ profile?: boolean | undefined; scope?: Management.ConnectionScopeAmazon | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'apple' connection */ export interface ConnectionOptionsApple extends Management.ConnectionOptionsCommon { /** Apple App Secret (must be a PEM) */ app_secret?: (string | null) | undefined; /** Apple Services ID */ client_id?: (string | null) | undefined; /** User has the option to obfuscate the email with Apple's relay service */ email?: boolean | undefined; /** Array of freeform scopes */ freeform_scopes?: string[] | undefined; /** Apple Key ID */ kid?: (string | null) | undefined; /** Whether to request name from Apple */ name?: boolean | undefined; /** Space separated list of scopes */ scope?: string | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; /** Apple Team ID */ team_id?: (string | null) | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'auth0' connection */ export interface ConnectionOptionsAuth0 extends Management.ConnectionOptionsCommon { attributes?: Management.ConnectionAttributes | undefined; authentication_methods?: (Management.ConnectionAuthenticationMethods | null) | undefined; brute_force_protection?: Management.ConnectionBruteForceProtection | undefined; configuration?: Management.ConnectionConfiguration | undefined; customScripts?: Management.ConnectionCustomScripts | undefined; disable_self_service_change_password?: Management.ConnectionDisableSelfServiceChangePassword | undefined; disable_signup?: Management.ConnectionDisableSignup | undefined; enable_script_context?: Management.ConnectionEnableScriptContext | undefined; enabledDatabaseCustomization?: Management.ConnectionEnabledDatabaseCustomization | undefined; import_mode?: Management.ConnectionImportMode | undefined; mfa?: Management.ConnectionMfa | undefined; passkey_options?: (Management.ConnectionPasskeyOptions | null) | undefined; passwordPolicy?: (Management.ConnectionPasswordPolicyEnum | null) | undefined; password_complexity_options?: (Management.ConnectionPasswordComplexityOptions | null) | undefined; password_dictionary?: (Management.ConnectionPasswordDictionaryOptions | null) | undefined; password_history?: (Management.ConnectionPasswordHistoryOptions | null) | undefined; password_no_personal_info?: (Management.ConnectionPasswordNoPersonalInfoOptions | null) | undefined; password_options?: Management.ConnectionPasswordOptions | undefined; precedence?: Management.ConnectionIdentifierPrecedence | undefined; realm_fallback?: Management.ConnectionRealmFallback | undefined; requires_username?: Management.ConnectionRequiresUsername | undefined; validation?: (Management.ConnectionValidationOptions | null) | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'auth0-oidc' connection */ export interface ConnectionOptionsAuth0Oidc { client_id?: Management.ConnectionClientId | undefined; client_secret?: Management.ConnectionClientSecret | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'waad' connection */ export interface ConnectionOptionsAzureAd extends Management.ConnectionOptionsCommon { /** Enable users API */ api_enable_users?: boolean | undefined; app_domain?: Management.ConnectionAppDomainAzureAd | undefined; /** The Application ID URI (App ID URI) for the Azure AD application. Required when using Azure AD v1 with the Resource Owner Password flow. Used to identify the resource being requested in OAuth token requests. */ app_id?: string | undefined; /** Includes basic user profile information from Azure AD (name, email, given_name, family_name). Always enabled and required - represents the minimum profile data retrieved during authentication. */ basic_profile?: boolean | undefined; client_id: Management.ConnectionClientIdAzureAd; client_secret?: Management.ConnectionClientSecretAzureAd | undefined; domain_aliases?: Management.ConnectionDomainAliasesAzureAd | undefined; /** When false, prevents storing the user's Azure AD access token in the Auth0 user profile. When true (default), the access token is persisted for API access. */ ext_access_token?: boolean | undefined; /** When false, prevents storing whether the user's Azure AD account is enabled. When true (default), the account enabled status is persisted in the user profile. */ ext_account_enabled?: boolean | undefined; ext_admin?: Management.ConnectionExtAdmin | undefined; ext_agreed_terms?: Management.ConnectionExtAgreedTerms | undefined; /** When false, prevents storing the list of Microsoft 365/Office 365 licenses assigned to the user. When true (default), license information is persisted in the user profile. */ ext_assigned_licenses?: boolean | undefined; ext_assigned_plans?: Management.ConnectionExtAssignedPlans | undefined; /** When false, prevents storing the user's Azure ID identifier. When true (default), the Azure ID is persisted. Note: 'oid' (Object ID) is the recommended unique identifier for single-tenant connections. */ ext_azure_id?: boolean | undefined; /** When false, prevents storing the user's city from Azure AD. When true (default), city information is persisted in the user profile. */ ext_city?: boolean | undefined; /** When false, prevents storing the user's country from Azure AD. When true (default), country information is persisted in the user profile. */ ext_country?: boolean | undefined; /** When false, prevents storing the user's department from Azure AD. When true (default), department information is persisted in the user profile. */ ext_department?: boolean | undefined; /** When false, prevents storing whether directory synchronization is enabled for the user. When true (default), directory sync status is persisted in the user profile. */ ext_dir_sync_enabled?: boolean | undefined; /** When false, prevents storing the user's email address from Azure AD. When true (default), email is persisted in the user profile. */ ext_email?: boolean | undefined; /** When false, prevents storing the token expiration time (in seconds). When true (default), expiration information is persisted in the user profile. */ ext_expires_in?: boolean | undefined; /** When false, prevents storing the user's family name (last name) from Azure AD. When true (default), family name is persisted in the user profile. */ ext_family_name?: boolean | undefined; /** When false, prevents storing the user's fax number from Azure AD. When true (default), fax information is persisted in the user profile. */ ext_fax?: boolean | undefined; /** When false, prevents storing the user's given name (first name) from Azure AD. When true (default), given name is persisted in the user profile. */ ext_given_name?: boolean | undefined; /** When false, prevents storing the list of Azure AD group IDs the user is a member of. When true (default), group membership IDs are persisted. See ext_groups for retrieving group details. */ ext_group_ids?: boolean | undefined; ext_groups?: Management.ConnectionExtGroupsAzureAd | undefined; ext_is_suspended?: Management.ConnectionExtIsSuspended | undefined; /** When false, prevents storing the user's job title from Azure AD. When true (default), job title information is persisted in the user profile. */ ext_job_title?: boolean | undefined; /** When false, prevents storing the timestamp of the last directory synchronization. When true (default), the last sync date is persisted in the user profile. */ ext_last_sync?: boolean | undefined; /** When false, prevents storing the user's mobile phone number from Azure AD. When true (default), mobile number is persisted in the user profile. */ ext_mobile?: boolean | undefined; /** When false, prevents storing the user's full name from Azure AD. When true (default), full name is persisted in the user profile. */ ext_name?: boolean | undefined; /** When true, stores all groups the user is member of, including transitive group memberships (groups within groups). When false (default), only direct group memberships are included. */ ext_nested_groups?: boolean | undefined; /** When false, prevents storing the user's nickname or display name from Azure AD. When true (default), nickname is persisted in the user profile. */ ext_nickname?: boolean | undefined; /** When false, prevents storing the user's Object ID (oid) from Azure AD. When true (default), the oid is persisted. Note: 'oid' is the recommended unique identifier for single-tenant connections and required for SCIM. */ ext_oid?: boolean | undefined; /** When false, prevents storing the user's phone number from Azure AD. When true (default), phone number is persisted in the user profile. */ ext_phone?: boolean | undefined; /** When false, prevents storing the user's office location from Azure AD. When true (default), office location is persisted in the user profile. */ ext_physical_delivery_office_name?: boolean | undefined; /** When false, prevents storing the user's postal code from Azure AD. When true (default), postal code is persisted in the user profile. */ ext_postal_code?: boolean | undefined; /** When false, prevents storing the user's preferred language from Azure AD. When true (default), language preference is persisted in the user profile. */ ext_preferred_language?: boolean | undefined; ext_profile?: Management.ConnectionExtProfile | undefined; /** When false, prevents storing the list of service plans provisioned to the user. When true (default), provisioned plans are persisted in the user profile. */ ext_provisioned_plans?: boolean | undefined; /** When false, prevents storing provisioning errors that occurred during synchronization. When true (default), error information is persisted. Useful for troubleshooting sync issues. */ ext_provisioning_errors?: boolean | undefined; /** When false, prevents storing all proxy email addresses (email aliases) for the user. When true (default), proxy addresses are persisted in the user profile. */ ext_proxy_addresses?: boolean | undefined; /** When false, prevents storing the user's Passport User ID (puid). When true (default), puid is persisted in the user profile. Legacy attribute. */ ext_puid?: boolean | undefined; /** When false, prevents storing the Azure AD refresh token. When true (default), the refresh token is persisted for offline access. Required for token refresh in long-lived applications. */ ext_refresh_token?: boolean | undefined; /** When false, prevents storing Azure AD application roles assigned to the user. When true (default), role information is persisted. Useful for RBAC in applications. */ ext_roles?: boolean | undefined; /** When false, prevents storing the user's state (province/region) from Azure AD. When true (default), state information is persisted in the user profile. */ ext_state?: boolean | undefined; /** When false, prevents storing the user's street address from Azure AD. When true (default), street address is persisted in the user profile. */ ext_street?: boolean | undefined; /** When false, prevents storing the user's telephone number from Azure AD. When true (default), telephone number is persisted in the user profile. */ ext_telephoneNumber?: boolean | undefined; /** When false, prevents storing the user's Azure AD tenant ID. When true (default), tenant ID is persisted. Useful for identifying which Azure AD organization the user belongs to. */ ext_tenantid?: boolean | undefined; /** When false, prevents storing the user's User Principal Name (UPN) from Azure AD. When true (default), UPN is persisted. UPN is the user's logon name (e.g., user@contoso.com). */ ext_upn?: boolean | undefined; /** When false, prevents storing the user's usage location for license assignment. When true (default), usage location is persisted in the user profile. */ ext_usage_location?: boolean | undefined; /** When false, prevents storing an alternative user ID. When true (default), this user ID is persisted in the user profile. */ ext_user_id?: boolean | undefined; federated_connections_access_tokens?: (Management.ConnectionFederatedConnectionsAccessTokens | null) | undefined; /** Indicates whether admin consent has been granted for the required Azure AD permissions. Read-only status field managed by Auth0 during the OAuth authorization flow. */ granted?: boolean | undefined; icon_url?: Management.ConnectionIconUrlAzureAd | undefined; identity_api?: Management.ConnectionIdentityApiAzureAd | undefined; max_groups_to_retrieve?: Management.ConnectionMaxGroupsToRetrieve | undefined; scope?: Management.ConnectionScopeAzureAd | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; should_trust_email_verified_connection?: Management.ConnectionShouldTrustEmailVerifiedConnectionEnum | undefined; tenant_domain?: Management.ConnectionTenantDomainAzureAdOne | undefined; tenantId?: Management.ConnectionTenantIdAzureAd | undefined; thumbprints?: Management.ConnectionThumbprints | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; /** Indicates WS-Federation protocol usage. When true, uses WS-Federation; when false, uses OpenID Connect. */ use_wsfed?: boolean | undefined; useCommonEndpoint?: Management.ConnectionUseCommonEndpointAzureAd | undefined; userid_attribute?: Management.ConnectionUseridAttributeAzureAd | undefined; waad_protocol?: Management.ConnectionWaadProtocol | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'baidu' connection */ export interface ConnectionOptionsBaidu extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'bitbucket' connection */ export interface ConnectionOptionsBitbucket extends Management.ConnectionOptionsCommon { client_id?: Management.ConnectionClientIdBitbucket | undefined; client_secret?: Management.ConnectionClientSecretBitbucket | undefined; freeform_scopes?: Management.ConnectionScopeArray | undefined; profile?: Management.ConnectionProfileBitbucket | undefined; scope?: Management.ConnectionScopeArray | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'bitly' connection */ export interface ConnectionOptionsBitly extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'box' connection */ export interface ConnectionOptionsBox extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * OAuth 2.0 client identifier issued by the identity provider during application registration. This value identifies your Auth0 connection to the identity provider. */ export type ConnectionOptionsClientIdGithub = string; /** * OAuth 2.0 client identifier issued by the identity provider during application registration. This value identifies your Auth0 connection to the identity provider. */ export type ConnectionOptionsClientIdTwitter = string; /** * OAuth 2.0 client secret issued by the identity provider during application registration. This value is used to authenticate your Auth0 connection to the identity provider. */ export type ConnectionOptionsClientSecretGithub = string; /** * OAuth 2.0 client secret issued by the identity provider during application registration. This value is used to authenticate your Auth0 connection to the identity provider. */ export type ConnectionOptionsClientSecretTwitter = string; /** * Common attributes for connection options including non-persistent attributes and Cross App Access */ export interface ConnectionOptionsCommon { non_persistent_attrs?: Management.ConnectionNonPersistentAttrs | undefined; } /** * common options for OIDC connections */ export interface ConnectionOptionsCommonOidc { authorization_endpoint?: Management.ConnectionAuthorizationEndpoint | undefined; client_id: Management.ConnectionClientIdOidc; client_secret?: Management.ConnectionClientSecretOidc | undefined; connection_settings?: Management.ConnectionConnectionSettings | undefined; domain_aliases?: Management.ConnectionDomainAliases | undefined; dpop_signing_alg?: Management.ConnectionDpopSigningAlgEnum | undefined; federated_connections_access_tokens?: (Management.ConnectionFederatedConnectionsAccessTokens | null) | undefined; icon_url?: Management.ConnectionIconUrl | undefined; id_token_signed_response_algs?: ((Management.ConnectionIdTokenSignedResponseAlgs | undefined) | null) | undefined; issuer?: Management.ConnectionIssuer | undefined; jwks_uri?: Management.ConnectionJwksUri | undefined; oidc_metadata?: Management.ConnectionOptionsOidcMetadata | undefined; scope?: Management.ConnectionScopeOidc | undefined; send_back_channel_nonce?: Management.ConnectionSendBackChannelNonce | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; tenant_domain?: Management.ConnectionTenantDomain | undefined; token_endpoint?: Management.ConnectionTokenEndpoint | undefined; token_endpoint_auth_method?: (Management.ConnectionTokenEndpointAuthMethodEnum | null) | undefined; token_endpoint_auth_signing_alg?: (Management.ConnectionTokenEndpointAuthSigningAlgEnum | null) | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; userinfo_endpoint?: Management.ConnectionUserinfoEndpoint | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Common options for SAML-based enterprise connections (shared by samlp and pingfederate). */ export interface ConnectionOptionsCommonSaml { cert?: Management.ConnectionSigningCertificateDerSaml | undefined; decryptionKey?: Management.ConnectionDecryptionKeySaml | undefined; digestAlgorithm?: Management.ConnectionDigestAlgorithmSaml | undefined; domain_aliases?: Management.ConnectionDomainAliasesSaml | undefined; entityId?: Management.ConnectionEntityIdSaml | undefined; icon_url?: Management.ConnectionIconUrlSaml | undefined; idpinitiated?: Management.ConnectionOptionsIdpinitiatedSaml | undefined; protocolBinding?: Management.ConnectionProtocolBindingSaml | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; signInEndpoint?: Management.ConnectionSignInEndpointSaml | undefined; signSAMLRequest?: Management.ConnectionSignSamlRequestSaml | undefined; signatureAlgorithm?: Management.ConnectionSignatureAlgorithmSaml | undefined; tenant_domain?: Management.ConnectionTenantDomainSaml | undefined; thumbprints?: Management.ConnectionThumbprintsSaml | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; } /** * Options for 'custom' connections */ export type ConnectionOptionsCustom = Record; /** * Options for the 'daccount' connection */ export interface ConnectionOptionsDaccount extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * When true, enables DEFLATE compression for SAML requests sent via HTTP-Redirect binding. */ export type ConnectionOptionsDeflateSaml = boolean; /** * Options for the 'dropbox' connection */ export interface ConnectionOptionsDropbox extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'dwolla' connection */ export interface ConnectionOptionsDwolla extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'email' connection */ export interface ConnectionOptionsEmail extends Management.ConnectionOptionsCommon { authParams?: Management.ConnectionAuthParamsEmail | undefined; brute_force_protection: Management.ConnectionBruteForceProtection; disable_signup?: Management.ConnectionDisableSignup | undefined; email: Management.ConnectionEmailEmail; /** Connection name */ name: string; totp?: Management.ConnectionTotpEmail | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the evernote family of connections */ export interface ConnectionOptionsEvernote extends Management.ConnectionOptionsOAuth1Common { /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'exact' connection */ export interface ConnectionOptionsExact extends Management.ConnectionOptionsCommon { baseUrl?: Management.ConnectionBaseUrlExact | undefined; client_id?: Management.ConnectionClientIdExact | undefined; client_secret?: Management.ConnectionClientSecretExact | undefined; /** Enables retrieval of basic profile attributes from Exact Online including name, username, picture, email, gender, and language. */ profile?: boolean | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'facebook' connection */ export interface ConnectionOptionsFacebook extends Management.ConnectionOptionsCommon { client_id?: Management.ConnectionClientIdFacebook | undefined; client_secret?: Management.ConnectionClientSecretFacebook | undefined; freeform_scopes?: Management.ConnectionScopeArrayFacebook | undefined; upstream_params?: Management.ConnectionUpstreamParamsFacebook | undefined; scope?: Management.ConnectionScopeFacebook | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; /** Grants permission to both read and manage ads for ad accounts you own or have been granted access to by the owner. By default, your app may only access ad accounts owned by admins of the app when in developer mode. */ ads_management?: boolean | undefined; /** Grants access to the Ads Insights API to pull ads report information for ad accounts you own or have been granted access to by the owner of other ad accounts. */ ads_read?: boolean | undefined; /** Provides access to a social context. Deprecated on April 30th, 2019. */ allow_context_profile_field?: boolean | undefined; /** Grants permission to read and write with the Business Manager API. */ business_management?: boolean | undefined; /** Grants permission to access a person's primary email address. */ email?: boolean | undefined; /** Grants permission to publicly available group member information. */ groups_access_member_info?: boolean | undefined; /** Grants permission to retrieve all the information captured within a lead. */ leads_retrieval?: boolean | undefined; /** Enables your app to read a person's notifications and mark them as read. This permission does not let you send notifications to a person. Deprecated in Graph API v2.3. */ manage_notifications?: boolean | undefined; /** Grants permission to retrieve Page Access Tokens for the Pages and Apps that the person administers. Apps need both manage_pages and publish_pages to be able to publish as a Page. */ manage_pages?: boolean | undefined; /** Allows the app to perform POST and DELETE operations on endpoints used for managing a Page's Call To Action buttons. */ pages_manage_cta?: boolean | undefined; /** Grants permission to manage Instant Articles on behalf of Facebook Pages administered by people using your app. */ pages_manage_instant_articles?: boolean | undefined; /** Grants permission to send and receive messages through a Facebook Page. */ pages_messaging?: boolean | undefined; /** Grants permission to use the phone number messaging feature. */ pages_messaging_phone_number?: boolean | undefined; /** Grants permission to send messages using Facebook Pages at any time after the first user interaction. Your app may only send advertising or promotional content through sponsored messages or within 24 hours of user interaction. */ pages_messaging_subscriptions?: boolean | undefined; /** Grants access to show the list of the Pages that a person manages. */ pages_show_list?: boolean | undefined; /** Provides access to a user's public profile information including id, first_name, last_name, middle_name, name, name_format, picture, and short_name. This is the most basic permission and is required by Facebook. */ public_profile?: boolean | undefined; /** Allows your app to publish to the Open Graph using Built-in Actions, Achievements, Scores, or Custom Actions. Deprecated on August 1st, 2018. */ publish_actions?: boolean | undefined; /** Grants permission to publish posts, comments, and like Pages managed by a person using your app. Your app must also have manage_pages to publish as a Page. */ publish_pages?: boolean | undefined; /** Grants permission to post content into a group on behalf of a user who has granted the app this permission. */ publish_to_groups?: boolean | undefined; /** Grants permission to publish live videos to the app User's timeline. */ publish_video?: boolean | undefined; /** Grants read-only access to the Audience Network Insights data for Apps the person owns. */ read_audience_network_insights?: boolean | undefined; /** Grants read-only access to the Insights data for Pages, Apps, and web domains the person owns. */ read_insights?: boolean | undefined; /** Provides the ability to read the messages in a person's Facebook Inbox through the inbox edge and the thread node. Deprecated in Graph API v2.3. */ read_mailbox?: boolean | undefined; /** Grants permission to read from the Page Inboxes of the Pages managed by a person. This permission is often used alongside the manage_pages permission. */ read_page_mailboxes?: boolean | undefined; /** Provides access to read the posts in a person's News Feed, or the posts on their Profile. Deprecated in Graph API v2.3. */ read_stream?: boolean | undefined; /** Grants permission to access a person's age range. */ user_age_range?: boolean | undefined; /** Grants permission to access a person's birthday. */ user_birthday?: boolean | undefined; /** Grants read-only access to the Events a person is a host of or has RSVPed to. This permission is restricted to a limited set of partners and usage requires prior approval by Facebook. */ user_events?: boolean | undefined; /** Grants permission to access a list of friends that also use said app. This permission is restricted to a limited set of partners and usage requires prior approval by Facebook. */ user_friends?: boolean | undefined; /** Grants permission to access a person's gender. */ user_gender?: boolean | undefined; /** Enables your app to read the Groups a person is a member of through the groups edge on the User object. Deprecated in Graph API v2.3. */ user_groups?: boolean | undefined; /** Grants permission to access a person's hometown location set in their User Profile. */ user_hometown?: boolean | undefined; /** Grants permission to access the list of all Facebook Pages that a person has liked. */ user_likes?: boolean | undefined; /** Grants permission to access the Facebook Profile URL of the user of your app. */ user_link?: boolean | undefined; /** Provides access to a person's current city through the location field on the User object. The current city is set by a person on their Profile. */ user_location?: boolean | undefined; /** Enables your app to read the Groups a person is an admin of through the groups edge on the User object. Deprecated in Graph API v3.0. */ user_managed_groups?: boolean | undefined; /** Provides access to the photos a person has uploaded or been tagged in. This permission is restricted to a limited set of partners and usage requires prior approval by Facebook. */ user_photos?: boolean | undefined; /** Provides access to the posts on a person's Timeline including their own posts, posts they are tagged in, and posts other people make on their Timeline. This permission is restricted to a limited set of partners and usage requires prior approval by Facebook. */ user_posts?: boolean | undefined; /** Provides access to a person's statuses. These are posts on Facebook which don't include links, videos or photos. Deprecated in Graph API v2.3. */ user_status?: boolean | undefined; /** Provides access to the Places a person has been tagged at in photos, videos, statuses and links. This permission is restricted to a limited set of partners and usage requires prior approval by Facebook. */ user_tagged_places?: boolean | undefined; /** Provides access to the videos a person has uploaded or been tagged in. This permission is restricted to a limited set of partners and usage requires prior approval by Facebook. */ user_videos?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'fitbit' connection */ export interface ConnectionOptionsFitbit extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Array of custom OAuth 2.0 scopes to request from GitHub during authentication. Use this to request scopes not covered by the predefined scope options. */ export type ConnectionOptionsFreeformScopesGithub = Management.ConnectionScopeArray; /** * Options for the 'github' connection */ export interface ConnectionOptionsGitHub extends Management.ConnectionOptionsCommon { client_id?: Management.ConnectionOptionsClientIdGithub | undefined; client_secret?: Management.ConnectionOptionsClientSecretGithub | undefined; freeform_scopes?: Management.ConnectionOptionsFreeformScopesGithub | undefined; scope?: Management.ConnectionOptionsScopeGithub | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; /** Requests the GitHub admin:org scope so Auth0 can fully manage organizations, teams, and memberships on behalf of the user. */ admin_org?: boolean | undefined; /** Requests the admin:public_key scope to allow creating, updating, and deleting the user's SSH public keys. */ admin_public_key?: boolean | undefined; /** Requests the admin:repo_hook scope so Auth0 can read, write, ping, and delete repository webhooks. */ admin_repo_hook?: boolean | undefined; /** Requests the delete_repo scope so the user can remove repositories they administer while signing in through Auth0. */ delete_repo?: boolean | undefined; /** Requests the user:email scope so Auth0 pulls addresses from GitHub's /user/emails endpoint and populates the profile. */ email?: boolean | undefined; /** Requests the user:follow scope to allow following or unfollowing GitHub users for the signed-in account. */ follow?: boolean | undefined; /** Requests the gist scope so the application can create or update gists on behalf of the user. */ gist?: boolean | undefined; /** Requests the notifications scope to read GitHub inbox notifications; repo also implicitly grants this access. */ notifications?: boolean | undefined; /** Controls the GitHub read:user call that returns the user's basic profile (name, avatar, profile URL) and is on by default for successful logins. */ profile?: boolean | undefined; /** Requests the public_repo scope for read and write operations on public repositories, deployments, and statuses. */ public_repo?: boolean | undefined; /** Requests the read:org scope so Auth0 can view organizations, teams, and membership lists without making changes. */ read_org?: boolean | undefined; /** Requests the read:public_key scope so Auth0 can list and inspect the user's SSH public keys. */ read_public_key?: boolean | undefined; /** Requests the read:repo_hook scope to read and ping repository webhooks. */ read_repo_hook?: boolean | undefined; /** Requests the read:user scope to load extended profile information, implicitly covering user:email and user:follow. */ read_user?: boolean | undefined; /** Requests the repo scope for read and write access to both public and private repositories, deployments, and statuses. */ repo?: boolean | undefined; /** Requests the repo_deployment scope in order to read and write deployment statuses for repositories. */ repo_deployment?: boolean | undefined; /** Requests the repo:status scope to manage commit statuses on public and private repositories. */ repo_status?: boolean | undefined; /** Requests the write:org scope so Auth0 can change whether organization memberships are publicized. */ write_org?: boolean | undefined; /** Requests the write:public_key scope to create or update SSH public keys for the user. */ write_public_key?: boolean | undefined; /** Requests the write:repo_hook scope so Auth0 can read, create, update, and ping repository webhooks. */ write_repo_hook?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'google-apps' connection */ export interface ConnectionOptionsGoogleApps extends Management.ConnectionOptionsCommon { admin_access_token?: Management.ConnectionAdminAccessTokenGoogleApps | undefined; admin_access_token_expiresin?: Management.ConnectionAdminAccessTokenExpiresInGoogleApps | undefined; admin_refresh_token?: Management.ConnectionAdminRefreshTokenGoogleApps | undefined; /** When true, allows customization of OAuth scopes requested during user login. Custom scopes are appended to the mandatory email and profile scopes. When false or omitted, only the default email and profile scopes are used. This property is automatically enabled when Token Vault or Connected Accounts features are activated. */ allow_setting_login_scopes?: boolean | undefined; api_enable_groups?: Management.ConnectionApiEnableGroupsGoogleApps | undefined; api_enable_users?: Management.ConnectionApiEnableUsersGoogleApps | undefined; client_id: Management.ConnectionClientIdGoogleApps; client_secret?: Management.ConnectionClientSecretGoogleApps | undefined; domain?: Management.ConnectionDomainGoogleApps | undefined; domain_aliases?: Management.ConnectionDomainAliases | undefined; /** Whether the OAuth flow requests the `email` scope. */ email?: boolean | undefined; ext_agreed_terms?: Management.ConnectionExtAgreedTermsGoogleApps | undefined; ext_groups?: Management.ConnectionExtGroupsGoogleApps | undefined; /** Controls whether enriched group entries include `id`, `email`, `name` (true) or only the group name (false); can only be set when `ext_groups` is true. */ ext_groups_extended?: boolean | undefined; ext_is_admin?: Management.ConnectionExtIsAdminGoogleApps | undefined; ext_is_suspended?: Management.ConnectionExtIsSuspendedGoogleApps | undefined; federated_connections_access_tokens?: (Management.ConnectionFederatedConnectionsAccessTokens | null) | undefined; handle_login_from_social?: Management.ConnectionHandleLoginFromSocialGoogleApps | undefined; icon_url?: Management.ConnectionIconUrlGoogleApps | undefined; /** Determines how Auth0 generates the user_id for Google Workspace users. When false (default), the user's email address is used. When true, Google's stable numeric user ID is used instead, which persists even if the user's email changes. This setting can only be configured when creating the connection and cannot be changed afterward. */ map_user_id_to_id?: boolean | undefined; /** Whether the OAuth flow requests the `profile` scope. */ profile?: boolean | undefined; scope?: Management.ConnectionScopeGoogleApps | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; tenant_domain?: Management.ConnectionTenantDomainGoogleApps | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'google-oauth2' connection */ export interface ConnectionOptionsGoogleOAuth2 extends Management.ConnectionOptionsCommon { allowed_audiences?: Management.ConnectionAllowedAudiencesGoogleOAuth2 | undefined; client_id?: Management.ConnectionClientIdGoogleOAuth2 | undefined; client_secret?: Management.ConnectionClientSecretGoogleOAuth2 | undefined; freeform_scopes?: Management.ConnectionFreeformScopesGoogleOAuth2 | undefined; icon_url?: Management.ConnectionIconUrlGoogleOAuth2 | undefined; scope?: Management.ConnectionScopeGoogleOAuth2 | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; /** View and manage user's ad applications, ad units, and channels in AdSense */ adsense_management?: boolean | undefined; /** View user's configuration information and reports */ analytics?: boolean | undefined; /** View and manage user's posts and blogs on Blogger and Blogger comments */ blogger?: boolean | undefined; /** See, edit, share, and permanently delete all the calendars you can access using Google Calendar */ calendar?: boolean | undefined; /** Run as a Calendar add-on */ calendar_addons_execute?: boolean | undefined; /** View and edit events on all your calendars */ calendar_events?: boolean | undefined; /** View events on all your calendars */ calendar_events_readonly?: boolean | undefined; /** View your Calendar settings */ calendar_settings_readonly?: boolean | undefined; /** Read access to user's chrome web store */ chrome_web_store?: boolean | undefined; /** Full access to the authenticated user's contacts */ contacts?: boolean | undefined; /** Full access to the authenticated user's contacts */ contacts_new?: boolean | undefined; /** Read-only access to the authenticated user's 'Other contacts' */ contacts_other_readonly?: boolean | undefined; /** Read-only access to the authenticated user's contacts */ contacts_readonly?: boolean | undefined; /** View and manage user's products, feeds, and subaccounts */ content_api_for_shopping?: boolean | undefined; /** Grants read and write access to the Coordinate API */ coordinate?: boolean | undefined; /** Grants read access to the Coordinate API */ coordinate_readonly?: boolean | undefined; /** Read-only access to the authenticated user's corporate directory (if applicable) */ directory_readonly?: boolean | undefined; /** Access to Google Docs document list feed */ document_list?: boolean | undefined; /** Full access to all files and folders in the user's Google Drive */ drive?: boolean | undefined; /** View and add to the activity record of files in your Drive */ drive_activity?: boolean | undefined; /** View the activity record of files in your Drive */ drive_activity_readonly?: boolean | undefined; /** Access to the application's configuration data in the user's Google Drive */ drive_appdata?: boolean | undefined; /** View apps authorized to access your Drive */ drive_apps_readonly?: boolean | undefined; /** Access to files created or opened by the app */ drive_file?: boolean | undefined; /** Access to file metadata, including listing files and folders */ drive_metadata?: boolean | undefined; /** Read-only access to file metadata */ drive_metadata_readonly?: boolean | undefined; /** Read-only access to the user's Google Photos */ drive_photos_readonly?: boolean | undefined; /** Read-only access to all files and folders in the user's Google Drive */ drive_readonly?: boolean | undefined; /** Modify the behavior of Google Apps Scripts */ drive_scripts?: boolean | undefined; /** Email and verified email flag */ email?: boolean | undefined; /** Full access to the account's mailboxes, including permanent deletion of threads and messages */ gmail?: boolean | undefined; /** Read all resources and their metadata—no write operations */ gmail_compose?: boolean | undefined; /** Insert and import messages only */ gmail_insert?: boolean | undefined; /** Create, read, update, and delete labels only */ gmail_labels?: boolean | undefined; /** Read resources metadata including labels, history records, and email message headers, but not the message body or attachments */ gmail_metadata?: boolean | undefined; /** All read/write operations except immediate, permanent deletion of threads and messages, bypassing Trash */ gmail_modify?: boolean | undefined; /** Full access to the account's mailboxes, including permanent deletion of threads and messages */ gmail_new?: boolean | undefined; /** Read all resources and their metadata—no write operations */ gmail_readonly?: boolean | undefined; /** Send messages only. No read or modify privileges on mailbox */ gmail_send?: boolean | undefined; /** Manage basic mail settings */ gmail_settings_basic?: boolean | undefined; /** Manage sensitive mail settings, including forwarding rules and aliases. Note: Operations guarded by this scope are restricted to administrative use only */ gmail_settings_sharing?: boolean | undefined; /** View and manage user's publisher data in the Google Affiliate Network */ google_affiliate_network?: boolean | undefined; /** View and manage user's books and library in Google Books */ google_books?: boolean | undefined; /** View and manage user's data stored in Google Cloud Storage */ google_cloud_storage?: boolean | undefined; /** Full access to all files and folders in the user's Google Drive */ google_drive?: boolean | undefined; /** Access to files created or opened by the app */ google_drive_files?: boolean | undefined; /** Associate user with its public Google profile */ google_plus?: boolean | undefined; /** View and manage user's best-available current location and location history in Google Latitude */ latitude_best?: boolean | undefined; /** View and manage user's city-level current location and location history in Google Latitude */ latitude_city?: boolean | undefined; /** View and manage user's votes, topics, and submissions */ moderator?: boolean | undefined; /** Request a refresh token when the user authorizes your application */ offline_access?: boolean | undefined; /** View and manage user's friends, applications and profile and status */ orkut?: boolean | undefined; /** View and manage user's Google photos, videos, photo and video tags and comments */ picasa_web?: boolean | undefined; /** Name, public profile URL, photo, country, language, and timezone */ profile?: boolean | undefined; /** View and manage user's sites on Google Sites */ sites?: boolean | undefined; /** Full access to create, edit, organize, and delete all your tasks */ tasks?: boolean | undefined; /** Read-only access to view your tasks and task lists */ tasks_readonly?: boolean | undefined; /** View, manage and view statistics user's short URLs */ url_shortener?: boolean | undefined; /** View and manage user's sites and messages, view keywords */ webmaster_tools?: boolean | undefined; /** Manage your YouTube account */ youtube?: boolean | undefined; /** See a list of your current active channel members, their current level, and when they became a member */ youtube_channelmemberships_creator?: boolean | undefined; /** Manage your YouTube account */ youtube_new?: boolean | undefined; /** View your YouTube account */ youtube_readonly?: boolean | undefined; /** Manage your YouTube videos */ youtube_upload?: boolean | undefined; /** View and manage your assets and associated content on YouTube */ youtubepartner?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'ip' connection */ export type ConnectionOptionsIp = Record; /** The response protocol used to communicate with the default application. */ export declare const ConnectionOptionsIdpInitiatedClientProtocolEnumSaml: { readonly Oidc: "oidc"; readonly Samlp: "samlp"; readonly Wsfed: "wsfed"; }; export type ConnectionOptionsIdpInitiatedClientProtocolEnumSaml = (typeof ConnectionOptionsIdpInitiatedClientProtocolEnumSaml)[keyof typeof ConnectionOptionsIdpInitiatedClientProtocolEnumSaml]; /** * Configuration for IdP-Initiated SAML Single Sign-On. When enabled, allows users to initiate login directly from their SAML identity provider without first visiting Auth0. The IdP must include the connection parameter in the post-back URL (Assertion Consumer Service URL). */ export interface ConnectionOptionsIdpinitiatedSaml { /** The query string sent to the default application */ client_authorizequery?: string | undefined; /** The client ID to use for IdP-initiated login requests. */ client_id?: string | undefined; client_protocol?: Management.ConnectionClientProtocolSaml | undefined; /** When true, enables IdP-initiated login support for this SAML connection. Allows users to log in directly from the identity provider without first visiting Auth0. */ enabled?: boolean | undefined; } /** * Options for the 'instagram' connection */ export interface ConnectionOptionsInstagram extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'line' connection */ export interface ConnectionOptionsLine extends Management.ConnectionOptionsCommon { client_id?: Management.ConnectionClientIdLine | undefined; client_secret?: Management.ConnectionClientSecretLine | undefined; freeform_scopes?: Management.ConnectionScopeArray | undefined; scope?: Management.ConnectionScopeArray | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; /** Permission to request the user's email address from LINE. When enabled, adds the 'email' scope to OAuth requests. Note: LINE requires special approval to access user email addresses. */ email?: boolean | undefined; /** Permission to request the user's basic profile information from LINE. When enabled, adds the 'profile' scope to OAuth requests. LINE requires this scope to retrieve user display name, profile picture, and status message. */ profile?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'linkedin' connection */ export interface ConnectionOptionsLinkedin extends Management.ConnectionOptionsCommon { client_id?: Management.ConnectionClientIdLinkedin | undefined; client_secret?: Management.ConnectionClientSecretLinkedin | undefined; freeform_scopes?: Management.ConnectionFreeformScopesLinkedin | undefined; scope?: Management.ConnectionScopeLinkedin | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; /** The strategy_version property determines which LinkedIn API version and OAuth scopes are used for authentication. Version 1 uses legacy scopes (r_basicprofile, r_fullprofile, r_network), Version 2 uses updated scopes (r_liteprofile, r_basicprofile), and Version 3 uses OpenID Connect scopes (profile, email, openid). If not specified, the connection defaults to Version 3. */ strategy_version?: Management.ConnectionStrategyVersionEnumLinkedin | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; /** Request the LinkedIn lite profile scope (r_liteprofile) to retrieve member id, localized first/last name, and profile picture. Off by default. */ basic_profile?: boolean | undefined; /** Request the email address scope (r_emailaddress) to return the member's primary email. Off by default. */ email?: boolean | undefined; /** Request the legacy full profile scope (r_fullprofile) for extended attributes. Deprecated by LinkedIn; use only if enabled for your app. Off by default. */ full_profile?: boolean | undefined; /** Request legacy network access (first-degree connections). Deprecated by LinkedIn and typically unavailable to new apps. Off by default. */ network?: boolean | undefined; /** Request OpenID Connect authentication support (openid scope). When enabled, the connection will request the 'openid' scope from LinkedIn, allowing the use of OpenID Connect flows for authentication and enabling the issuance of ID tokens. This is off by default and should only be enabled if your LinkedIn application is configured for OpenID Connect. */ openid?: boolean | undefined; /** Always-true flag that ensures the LinkedIn profile scope (r_basicprofile/r_liteprofile/profile) is requested. */ profile?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'oauth1' connection */ export interface ConnectionOptionsOAuth1 extends Management.ConnectionOptionsCommon { accessTokenURL?: Management.ConnectionAccessTokenUrloAuth1 | undefined; client_id?: Management.ConnectionClientIdOAuth1 | undefined; client_secret?: Management.ConnectionClientSecretOAuth1 | undefined; requestTokenURL?: Management.ConnectionRequestTokenUrloAuth1 | undefined; scripts?: Management.ConnectionScriptsOAuth1 | undefined; signatureMethod?: Management.ConnectionSignatureMethodOAuth1 | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; userAuthorizationURL?: Management.ConnectionUserAuthorizationUrloAuth1 | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface ConnectionOptionsOAuth1Common extends Management.ConnectionOptionsCommon { /** OAuth 1.0 client identifier issued by the identity provider during application registration. This value identifies your Auth0 connection to the identity provider. */ client_id?: string | undefined; /** OAuth 1.0 client secret issued by the identity provider during application registration. Used to authenticate your Auth0 connection when signing requests and exchanging request tokens and verifiers for access tokens. May be null for public clients. */ client_secret?: string | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; } /** * Options for the 'oauth2' connection */ export interface ConnectionOptionsOAuth2 extends Management.ConnectionOptionsCommon { authParams?: Management.ConnectionAuthParamsOAuth2 | undefined; authParamsMap?: Management.ConnectionAuthParamsMap | undefined; authorizationURL?: Management.ConnectionAuthorizationEndpoint | undefined; client_id?: Management.ConnectionClientIdOAuth2 | undefined; client_secret?: Management.ConnectionClientSecretOAuth2 | undefined; customHeaders?: Management.ConnectionCustomHeadersOAuth2 | undefined; fieldsMap?: Management.ConnectionFieldsMap | undefined; icon_url?: Management.ConnectionIconUrl | undefined; logoutUrl?: Management.ConnectionEndSessionEndpoint | undefined; /** When true, enables Proof Key for Code Exchange (PKCE) for the authorization code flow. PKCE provides additional security by preventing authorization code interception attacks. */ pkce_enabled?: boolean | undefined; scope?: Management.ConnectionScopeOAuth2 | undefined; scripts?: Management.ConnectionScriptsOAuth2 | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; tokenURL?: Management.ConnectionTokenEndpoint | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; /** When true, uses space-delimited scopes (per OAuth 2.0 spec) instead of comma-delimited when calling the identity provider's authorization endpoint. Only relevant when using the connection_scope parameter. See https://auth0.com/docs/authenticate/identity-providers/adding-scopes-for-an-external-idp#pass-scopes-to-authorize-endpoint */ useOauthSpecScope?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface ConnectionOptionsOAuth2Common extends Management.ConnectionOptionsCommon { client_id?: Management.ConnectionClientId | undefined; client_secret?: Management.ConnectionClientSecret | undefined; scope?: Management.ConnectionScopeOAuth2 | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; } /** * Options for the 'oidc' connection */ export interface ConnectionOptionsOidc extends Management.ConnectionOptionsCommonOidc, Management.ConnectionOptionsCommon { attribute_map?: Management.ConnectionAttributeMapOidc | undefined; discovery_url?: Management.ConnectionDiscoveryUrl | undefined; type?: Management.ConnectionTypeEnumOidc | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * OpenID Connect Provider Metadata as per https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata */ export interface ConnectionOptionsOidcMetadata { acr_values_supported?: Management.ConnectionAcrValuesSupported | undefined; authorization_endpoint: Management.ConnectionAuthorizationEndpoint; claim_types_supported?: Management.ConnectionClaimTypesSupported | undefined; claims_locales_supported?: Management.ConnectionClaimsLocalesSupported | undefined; claims_parameter_supported?: Management.ConnectionClaimsParameterSupported | undefined; claims_supported?: Management.ConnectionClaimsSupported | undefined; display_values_supported?: Management.ConnectionDisplayValuesSupported | undefined; dpop_signing_alg_values_supported?: Management.ConnectionDpopSigningAlgValuesSupported | undefined; end_session_endpoint?: Management.ConnectionEndSessionEndpoint | undefined; grant_types_supported?: Management.ConnectionGrantTypesSupported | undefined; id_token_encryption_alg_values_supported?: Management.ConnectionIdTokenEncryptionAlgValuesSupported | undefined; id_token_encryption_enc_values_supported?: Management.ConnectionIdTokenEncryptionEncValuesSupported | undefined; id_token_signing_alg_values_supported: Management.ConnectionIdTokenSigningAlgValuesSupported; issuer: Management.ConnectionIssuer; jwks_uri: Management.ConnectionJwksUri; op_policy_uri?: Management.ConnectionOpPolicyUri | undefined; op_tos_uri?: Management.ConnectionOpTosUri | undefined; registration_endpoint?: Management.ConnectionRegistrationEndpoint | undefined; request_object_encryption_alg_values_supported?: Management.ConnectionRequestObjectEncryptionAlgValuesSupported | undefined; request_object_encryption_enc_values_supported?: Management.ConnectionRequestObjectEncryptionEncValuesSupported | undefined; request_object_signing_alg_values_supported?: Management.ConnectionRequestObjectSigningAlgValuesSupported | undefined; request_parameter_supported?: Management.ConnectionRequestParameterSupported | undefined; request_uri_parameter_supported?: Management.ConnectionRequestUriParameterSupported | undefined; require_request_uri_registration?: Management.ConnectionRequireRequestUriRegistration | undefined; response_modes_supported?: Management.ConnectionResponseModesSupported | undefined; response_types_supported?: Management.ConnectionResponseTypesSupported | undefined; scopes_supported?: ((Management.ConnectionScopesSupported | undefined) | null) | undefined; service_documentation?: Management.ConnectionServiceDocumentation | undefined; subject_types_supported?: Management.ConnectionSubjectTypesSupported | undefined; token_endpoint?: Management.ConnectionTokenEndpoint | undefined; token_endpoint_auth_methods_supported?: Management.ConnectionTokenEndpointAuthMethodsSupported | undefined; token_endpoint_auth_signing_alg_values_supported?: Management.ConnectionTokenEndpointAuthSigningAlgValuesSupported | undefined; ui_locales_supported?: Management.ConnectionUiLocalesSupported | undefined; userinfo_encryption_alg_values_supported?: Management.ConnectionUserinfoEncryptionAlgValuesSupported | undefined; userinfo_encryption_enc_values_supported?: Management.ConnectionUserinfoEncryptionEncValuesSupported | undefined; userinfo_endpoint?: Management.ConnectionUserinfoEndpoint | undefined; userinfo_signing_alg_values_supported?: Management.ConnectionUserinfoSigningAlgValuesSupported | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'office365' connection */ export interface ConnectionOptionsOffice365 { client_id?: Management.ConnectionClientId | undefined; client_secret?: Management.ConnectionClientSecret | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'okta' connection */ export interface ConnectionOptionsOkta extends Management.ConnectionOptionsCommon, Management.ConnectionOptionsCommonOidc { attribute_map?: Management.ConnectionAttributeMapOkta | undefined; domain?: Management.ConnectionDomainOkta | undefined; type?: Management.ConnectionTypeEnumOkta | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'paypal' and 'paypal-sandbox' connections */ export interface ConnectionOptionsPaypal extends Management.ConnectionOptionsCommon { client_id?: Management.ConnectionClientIdPaypal | undefined; client_secret?: Management.ConnectionClientSecretPaypal | undefined; freeform_scopes?: Management.ConnectionFreeformScopesPaypal | undefined; scope?: Management.ConnectionScopePaypal | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; /** When enabled, requests the 'address' scope from PayPal to access the user's address information. */ address?: boolean | undefined; /** When enabled, requests the 'email' scope from PayPal to access the user's email address. */ email?: boolean | undefined; /** When enabled, requests the 'phone' scope from PayPal to access the user's phone number. */ phone?: boolean | undefined; /** When enabled, requests the 'profile' scope from PayPal to access basic profile information including first name, last name, date of birth, time zone, locale, and language. This scope is always enabled by the system. */ profile?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'pingfederate' connection */ export interface ConnectionOptionsPingFederate extends Management.ConnectionOptionsCommonSaml, Management.ConnectionOptionsCommon { pingFederateBaseUrl: Management.ConnectionPingFederateBaseUrl; signingCert?: Management.ConnectionSigningCertificatePemPingFederate | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'planningcenter' connection */ export interface ConnectionOptionsPlanningCenter extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** Allowed protocol identifiers for Twitter connections. Use oauth1 for the legacy v1.1 OAuth flow or oauth2 for the newer OAuth 2.0 flow. */ export declare const ConnectionOptionsProtocolEnumTwitter: { readonly Oauth1: "oauth1"; readonly Oauth2: "oauth2"; }; export type ConnectionOptionsProtocolEnumTwitter = (typeof ConnectionOptionsProtocolEnumTwitter)[keyof typeof ConnectionOptionsProtocolEnumTwitter]; /** * Options for the 'samlp' connection */ export interface ConnectionOptionsSaml extends Management.ConnectionOptionsCommonSaml, Management.ConnectionOptionsCommon { debug?: Management.ConnectionDebugSaml | undefined; deflate?: Management.ConnectionOptionsDeflateSaml | undefined; destinationUrl?: Management.ConnectionDestinationUrlSaml | undefined; /** When true, disables sending SAML logout requests (SingleLogoutService) to the identity provider during user sign-out. The user will be logged out of Auth0 but will remain logged into the identity provider. Defaults to false (federated logout enabled). */ disableSignout?: boolean | undefined; fieldsMap?: Management.ConnectionFieldsMapSaml | undefined; global_token_revocation_jwt_iss?: Management.ConnectionGlobalTokenRevocationJwtIssSaml | undefined; global_token_revocation_jwt_sub?: Management.ConnectionGlobalTokenRevocationJwtSubSaml | undefined; metadataUrl?: Management.ConnectionMetadataUrlSaml | undefined; metadataXml?: Management.ConnectionMetadataXmlSaml | undefined; recipientUrl?: Management.ConnectionRecipientUrlSaml | undefined; requestTemplate?: Management.ConnectionRequestTemplateSaml | undefined; signingCert?: Management.ConnectionSigningCertSaml | undefined; signing_key?: Management.ConnectionSigningKeySaml | undefined; signOutEndpoint?: Management.ConnectionSignOutEndpointSaml | undefined; user_id_attribute?: Management.ConnectionUserIdAttributeSaml | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'sms' connection */ export interface ConnectionOptionsSms extends Management.ConnectionOptionsCommon { /** Whether brute force protection is enabled */ brute_force_protection?: boolean | undefined; disable_signup?: Management.ConnectionDisableSignupSms | undefined; forward_req_info?: Management.ConnectionForwardReqInfoSms | undefined; from?: Management.ConnectionFromSms | undefined; gateway_authentication?: (Management.ConnectionGatewayAuthenticationSms | null) | undefined; gateway_url?: Management.ConnectionGatewayUrlSms | undefined; messaging_service_sid?: Management.ConnectionMessagingServiceSidSms | undefined; /** Connection name */ name?: string | undefined; provider?: Management.ConnectionProviderSms | undefined; syntax?: Management.ConnectionTemplateSyntaxEnumSms | undefined; template?: Management.ConnectionTemplateSms | undefined; totp?: Management.ConnectionTotpSms | undefined; twilio_sid?: Management.ConnectionTwilioSidSms | undefined; twilio_token?: Management.ConnectionTwilioTokenSms | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the salesforce family of connections (salesforce, salesforce-sandbox, salesforce-community) */ export interface ConnectionOptionsSalesforce extends Management.ConnectionOptionsCommon { client_id?: Management.ConnectionClientIdSalesforce | undefined; client_secret?: Management.ConnectionClientSecretSalesforce | undefined; freeform_scopes?: Management.ConnectionFreeformScopesSalesforce | undefined; /** When enabled, requests the Salesforce profile scope to retrieve basic user information including user_id, organization_id, username, display_name, email, status, photos, and URLs. */ profile?: boolean | undefined; scope?: Management.ConnectionScopeSalesforce | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'salesforce-community' connection */ export interface ConnectionOptionsSalesforceCommunity extends Management.ConnectionOptionsSalesforce { community_base_url?: Management.ConnectionCommunityBaseUrlSalesforce | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Scope options for GitHub connections. */ export type ConnectionOptionsScopeGithub = Management.ConnectionScopeArray; /** * Array of OAuth 2.0 scopes to request from Twitter during authentication. Use this to request scopes not covered by the predefined scope options. */ export type ConnectionOptionsScopeTwitter = Management.ConnectionScopeArray; /** * Options for the 'sharepoint' connection */ export interface ConnectionOptionsSharepoint extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'shop' connection */ export interface ConnectionOptionsShop extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'shopify' connection */ export interface ConnectionOptionsShopify extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'soundcloud' connection */ export interface ConnectionOptionsSoundcloud extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'thirtysevensignals' connection */ export interface ConnectionOptionsThirtySevenSignals extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'twitter' connection */ export interface ConnectionOptionsTwitter extends Management.ConnectionOptionsCommon { client_id?: Management.ConnectionOptionsClientIdTwitter | undefined; client_secret?: Management.ConnectionOptionsClientSecretTwitter | undefined; freeform_scopes?: Management.ConnectionScopeArray | undefined; protocol?: Management.ConnectionOptionsProtocolEnumTwitter | undefined; scope?: Management.ConnectionOptionsScopeTwitter | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; /** Request long-lived refresh tokens so your app can act on behalf of users even when they’re not actively signed in. Typical Twitter use case: keeping a background service synced without forcing users to reauthorize every session. */ offline_access?: boolean | undefined; /** Pull account profile metadata such as display name, bio, location, and URL so downstream apps can prefill or personalize user experiences. */ profile?: boolean | undefined; /** Allow the application to read a user’s public and protected Tweets—required for timelines, analytics, or moderation workflows. */ tweet_read?: boolean | undefined; /** Read non-Tweet user information (e.g., followers/following, account settings) to power relationship graphs or audience insights. */ users_read?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'untappd' connection */ export interface ConnectionOptionsUntappd extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'vkontakte' connection */ export interface ConnectionOptionsVkontakte extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'weibo' connection */ export interface ConnectionOptionsWeibo extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'windowslive' connection */ export interface ConnectionOptionsWindowsLive extends Management.ConnectionOptionsCommon { client_id?: Management.ConnectionClientIdWindowsLive | undefined; client_secret?: Management.ConnectionClientSecretWindowsLive | undefined; freeform_scopes?: Management.ConnectionFreeformScopesWindowsLive | undefined; scope?: Management.ConnectionScopeArrayWindowsLive | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; strategy_version?: Management.ConnectionStrategyVersionEnumWindowsLive | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; /** When enabled, requests access to user's applications. */ applications?: boolean | undefined; /** When enabled, requests permission to create applications. */ applications_create?: boolean | undefined; /** When enabled, requests read access to user's basic profile information and contacts list. */ basic?: boolean | undefined; /** When enabled, requests read access to user's birth day, month, and year. */ birthday?: boolean | undefined; /** When enabled, requests read access to user's calendars and events. */ calendars?: boolean | undefined; /** When enabled, requests read and write access to user's calendars and events. */ calendars_update?: boolean | undefined; /** When enabled, requests read access to contacts' birth day and birth month. */ contacts_birthday?: boolean | undefined; /** When enabled, requests read access to user's calendars and shared calendars/events from others. */ contacts_calendars?: boolean | undefined; /** When enabled, requests permission to create new contacts in user's address book. */ contacts_create?: boolean | undefined; /** When enabled, requests read access to user's and shared albums, photos, videos, and audio. */ contacts_photos?: boolean | undefined; /** When enabled, requests read access to OneDrive files shared by other users. */ contacts_skydrive?: boolean | undefined; /** When enabled, allows the app to have the same access to information in the directory as the signed-in user. */ directory_accessasuser_all?: boolean | undefined; /** When enabled, allows the app to read data in your organization's directory, such as users, groups, and apps. */ directory_read_all?: boolean | undefined; /** When enabled, allows the app to read and write data in your organization's directory, such as users and groups. */ directory_readwrite_all?: boolean | undefined; /** When enabled, requests read access to personal, preferred, and business email addresses. */ emails?: boolean | undefined; /** When enabled, requests permission to create events on user's default calendar. */ events_create?: boolean | undefined; /** When enabled, requests permission to read the user's calendars. */ graph_calendars?: boolean | undefined; /** When enabled, requests permission to read and write the user's calendars. */ graph_calendars_update?: boolean | undefined; /** When enabled, requests permission to read the user's contacts. */ graph_contacts?: boolean | undefined; /** When enabled, requests permission to read and write the user's contacts. */ graph_contacts_update?: boolean | undefined; /** When enabled, requests permission to read the user's device information. */ graph_device?: boolean | undefined; /** When enabled, requests permission to send commands to the user's devices. */ graph_device_command?: boolean | undefined; /** When enabled, requests permission to read the user's emails. */ graph_emails?: boolean | undefined; /** When enabled, requests permission to read and write the user's emails. */ graph_emails_update?: boolean | undefined; /** When enabled, requests permission to read the user's files. */ graph_files?: boolean | undefined; /** When enabled, requests permission to read all files the user has access to. */ graph_files_all?: boolean | undefined; /** When enabled, requests permission to read and write all files the user has access to. */ graph_files_all_update?: boolean | undefined; /** When enabled, requests permission to read and write the user's files. */ graph_files_update?: boolean | undefined; /** When enabled, requests permission to read the user's OneNote notebooks. */ graph_notes?: boolean | undefined; /** When enabled, requests permission to create new OneNote notebooks. */ graph_notes_create?: boolean | undefined; /** When enabled, requests permission to read and write the user's OneNote notebooks. */ graph_notes_update?: boolean | undefined; /** When enabled, requests permission to read the user's tasks. */ graph_tasks?: boolean | undefined; /** When enabled, requests permission to read and write the user's tasks. */ graph_tasks_update?: boolean | undefined; /** When enabled, requests permission to read the user's profile. */ graph_user?: boolean | undefined; /** When enabled, requests permission to read the user's activity history. */ graph_user_activity?: boolean | undefined; /** When enabled, requests permission to read and write the user's profile. */ graph_user_update?: boolean | undefined; /** When enabled, allows the app to read all group properties and memberships. */ group_read_all?: boolean | undefined; /** When enabled, allows the app to create groups, read all group properties and memberships, update group properties and memberships, and delete groups. */ group_readwrite_all?: boolean | undefined; /** When enabled, allows the app to create, read, update, and delete all mail in all mailboxes. */ mail_readwrite_all?: boolean | undefined; /** When enabled, allows the app to send mail as users in the organization. */ mail_send?: boolean | undefined; /** When enabled, requests access to user's Windows Live Messenger data. */ messenger?: boolean | undefined; /** When enabled, requests a refresh token for offline access. */ offline_access?: boolean | undefined; /** When enabled, requests read access to personal, business, and mobile phone numbers. */ phone_numbers?: boolean | undefined; /** When enabled, requests read access to user's photos, videos, audio, and albums. */ photos?: boolean | undefined; /** When enabled, requests read access to personal and business postal addresses. */ postal_addresses?: boolean | undefined; /** When enabled, allows the app to read the role-based access control (RBAC) settings for your company's directory. */ rolemanagement_read_all?: boolean | undefined; /** When enabled, allows the app to read and write the role-based access control (RBAC) settings for your company's directory. */ rolemanagement_readwrite_directory?: boolean | undefined; /** When enabled, requests permission to share content with other users. */ share?: boolean | undefined; /** When enabled, provides single sign-in behavior for users already signed into their Microsoft account. */ signin?: boolean | undefined; /** When enabled, allows the app to read documents and list items in all SharePoint site collections. */ sites_read_all?: boolean | undefined; /** When enabled, allows the app to create, read, update, and delete documents and list items in all SharePoint site collections. */ sites_readwrite_all?: boolean | undefined; /** When enabled, requests read access to user's files stored on OneDrive. */ skydrive?: boolean | undefined; /** When enabled, requests read and write access to user's OneDrive files. */ skydrive_update?: boolean | undefined; /** When enabled, allows the app to read the names and descriptions of all teams. */ team_readbasic_all?: boolean | undefined; /** When enabled, allows the app to read and write all teams' information and change team membership. */ team_readwrite_all?: boolean | undefined; /** When enabled, allows the app to read the full set of profile properties, reports, and managers of all users. */ user_read_all?: boolean | undefined; /** When enabled, allows the app to read a basic set of profile properties of all users in the directory. */ user_readbasic_all?: boolean | undefined; /** When enabled, requests read access to employer and work position information. */ work_profile?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'wordpress' connection */ export interface ConnectionOptionsWordpress extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'yahoo' connection */ export interface ConnectionOptionsYahoo extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Options for the 'yandex' connection */ export interface ConnectionOptionsYandex extends Management.ConnectionOptionsOAuth2Common { /** Accepts any additional properties */ [key: string]: any; } /** * Passkey authentication enablement */ export interface ConnectionPasskeyAuthenticationMethod { /** Determines whether passkeys are enabled */ enabled?: boolean | undefined; } /** Controls the UI used to challenge the user for their passkey. */ export declare const ConnectionPasskeyChallengeUiEnum: { readonly Both: "both"; readonly Autofill: "autofill"; readonly Button: "button"; }; export type ConnectionPasskeyChallengeUiEnum = (typeof ConnectionPasskeyChallengeUiEnum)[keyof typeof ConnectionPasskeyChallengeUiEnum]; /** * Options for the passkey authentication method */ export interface ConnectionPasskeyOptions { challenge_ui?: Management.ConnectionPasskeyChallengeUiEnum | undefined; /** Enables or disables progressive enrollment of passkeys for the connection. */ progressive_enrollment_enabled?: boolean | undefined; /** Enables or disables enrollment prompt for local passkey when user authenticates using a cross-device passkey for the connection. */ local_enrollment_enabled?: boolean | undefined; } /** * Password authentication enablement */ export interface ConnectionPasswordAuthenticationMethod { /** Determines whether passwords are enabled */ enabled?: boolean | undefined; api_behavior?: Management.ConnectionApiBehaviorEnum | undefined; signup_behavior?: Management.ConnectionSignupBehaviorEnum | undefined; } /** * Password complexity options */ export interface ConnectionPasswordComplexityOptions { /** Minimum password length */ min_length?: number | undefined; } /** * Options for password dictionary policy */ export interface ConnectionPasswordDictionaryOptions { enable: boolean; /** Custom Password Dictionary. An array of up to 200 entries. */ dictionary?: string[] | undefined; } /** * Options for password history policy */ export interface ConnectionPasswordHistoryOptions { enable: boolean; size?: number | undefined; } /** * Options for personal info in passwords policy */ export interface ConnectionPasswordNoPersonalInfoOptions { enable: boolean; } /** * Password policy options for flexible password policy configuration */ export interface ConnectionPasswordOptions { complexity?: Management.ConnectionPasswordOptionsComplexity | undefined; dictionary?: Management.ConnectionPasswordOptionsDictionary | undefined; history?: Management.ConnectionPasswordOptionsHistory | undefined; profile_data?: Management.ConnectionPasswordOptionsProfileData | undefined; } /** * Password complexity requirements configuration */ export interface ConnectionPasswordOptionsComplexity { /** Minimum password length required (1-72 characters) */ min_length?: number | undefined; /** Required character types that must be present in passwords. Valid options: uppercase, lowercase, number, special */ character_types?: Management.PasswordCharacterTypeEnum[] | undefined; character_type_rule?: Management.PasswordCharacterTypeRulePolicyEnum | undefined; identical_characters?: Management.PasswordIdenticalCharactersPolicyEnum | undefined; sequential_characters?: Management.PasswordSequentialCharactersPolicyEnum | undefined; max_length_exceeded?: Management.PasswordMaxLengthExceededPolicyEnum | undefined; } /** * Dictionary-based password restriction policy to prevent common passwords */ export interface ConnectionPasswordOptionsDictionary { /** Enables dictionary checking to prevent use of common passwords and custom blocked words */ active?: boolean | undefined; /** Array of custom words to block in passwords. Maximum 200 items, each up to 50 characters */ custom?: string[] | undefined; default?: Management.PasswordDefaultDictionariesEnum | undefined; } /** * Password history policy configuration to prevent password reuse */ export interface ConnectionPasswordOptionsHistory { /** Enables password history checking to prevent users from reusing recent passwords */ active?: boolean | undefined; /** Number of previous passwords to remember and prevent reuse (1-24) */ size?: number | undefined; } /** * Personal information restriction policy to prevent use of profile data in passwords */ export interface ConnectionPasswordOptionsProfileData { /** Prevents users from including profile data (like name, email) in their passwords */ active?: boolean | undefined; /** Blocked profile fields. An array of up to 12 entries. */ blocked_fields?: string[] | undefined; } /** Password strength level */ export declare const ConnectionPasswordPolicyEnum: { readonly None: "none"; readonly Low: "low"; readonly Fair: "fair"; readonly Good: "good"; readonly Excellent: "excellent"; }; export type ConnectionPasswordPolicyEnum = (typeof ConnectionPasswordPolicyEnum)[keyof typeof ConnectionPasswordPolicyEnum]; /** * Phone OTP authentication enablement */ export interface ConnectionPhoneOtpAuthenticationMethod { /** Determines whether phone OTP is enabled */ enabled?: boolean | undefined; } /** * URL provided by PingFederate which returns information used for creating the connection */ export type ConnectionPingFederateBaseUrl = Management.ConnectionPingFederateBaseUrlPingFederate; /** * PingFederate base URL constrained to HTTP/HTTPS with length bounds */ export type ConnectionPingFederateBaseUrlPingFederate = Management.ConnectionHttpsUrlWithHttpFallback; export interface ConnectionProfile { id?: Management.ConnectionProfileId | undefined; name?: Management.ConnectionProfileName | undefined; organization?: Management.ConnectionProfileOrganization | undefined; connection_name_prefix_template?: Management.ConnectionNamePrefixTemplate | undefined; enabled_features?: Management.ConnectionProfileEnabledFeatures | undefined; connection_config?: Management.ConnectionProfileConfig | undefined; strategy_overrides?: Management.ConnectionProfileStrategyOverrides | undefined; } /** * `profile` is a boolean that controls whether basic profile information (name, picture, email) is requested from Bitbucket during authentication. When `true`, the connection requests access to the user's basic profile data. */ export type ConnectionProfileBitbucket = boolean; /** * Connection profile configuration. */ export interface ConnectionProfileConfig { } /** * Enabled features for the connection profile. */ export type ConnectionProfileEnabledFeatures = Management.EnabledFeaturesEnum[]; /** * Connection Profile identifier. */ export type ConnectionProfileId = string; /** * The name of the connection profile. */ export type ConnectionProfileName = string; /** * The organization of the connection profile. */ export interface ConnectionProfileOrganization { show_as_button?: Management.ConnectionProfileOrganizationShowAsButtonEnum | undefined; assign_membership_on_login?: Management.ConnectionProfileOrganizationAssignMembershipOnLoginEnum | undefined; } /** Indicates if membership should be assigned on login. */ export declare const ConnectionProfileOrganizationAssignMembershipOnLoginEnum: { readonly None: "none"; readonly Optional: "optional"; readonly Required: "required"; }; export type ConnectionProfileOrganizationAssignMembershipOnLoginEnum = (typeof ConnectionProfileOrganizationAssignMembershipOnLoginEnum)[keyof typeof ConnectionProfileOrganizationAssignMembershipOnLoginEnum]; /** Indicates if the organization should be shown as a button. */ export declare const ConnectionProfileOrganizationShowAsButtonEnum: { readonly None: "none"; readonly Optional: "optional"; readonly Required: "required"; }; export type ConnectionProfileOrganizationShowAsButtonEnum = (typeof ConnectionProfileOrganizationShowAsButtonEnum)[keyof typeof ConnectionProfileOrganizationShowAsButtonEnum]; /** * Connection Profile Strategy Override */ export interface ConnectionProfileStrategyOverride { enabled_features?: Management.ConnectionProfileStrategyOverridesEnabledFeatures | undefined; connection_config?: Management.ConnectionProfileStrategyOverridesConnectionConfig | undefined; } /** * Strategy-specific overrides for this attribute */ export interface ConnectionProfileStrategyOverrides { pingfederate?: Management.ConnectionProfileStrategyOverride | undefined; ad?: Management.ConnectionProfileStrategyOverride | undefined; adfs?: Management.ConnectionProfileStrategyOverride | undefined; waad?: Management.ConnectionProfileStrategyOverride | undefined; "google-apps"?: Management.ConnectionProfileStrategyOverride | undefined; okta?: Management.ConnectionProfileStrategyOverride | undefined; oidc?: Management.ConnectionProfileStrategyOverride | undefined; samlp?: Management.ConnectionProfileStrategyOverride | undefined; } /** * Connection profile strategy overrides connection configuration. */ export interface ConnectionProfileStrategyOverridesConnectionConfig { } /** * Enabled features for a connections profile strategy override. */ export type ConnectionProfileStrategyOverridesEnabledFeatures = Management.EnabledFeaturesEnum[]; /** * The structure of the template, which can be used as the payload for creating or updating a Connection Profile. */ export interface ConnectionProfileTemplate { name?: Management.ConnectionProfileName | undefined; organization?: Management.ConnectionProfileOrganization | undefined; connection_name_prefix_template?: Management.ConnectionNamePrefixTemplate | undefined; enabled_features?: Management.ConnectionProfileEnabledFeatures | undefined; connection_config?: Management.ConnectionProfileConfig | undefined; strategy_overrides?: Management.ConnectionProfileStrategyOverrides | undefined; } export interface ConnectionProfileTemplateItem { /** The id of the template. */ id?: string | undefined; /** The user-friendly name of the template displayed in the UI. */ display_name?: string | undefined; template?: Management.ConnectionProfileTemplate | undefined; } /** * The connection's options (depend on the connection strategy) */ export interface ConnectionPropertiesOptions { validation?: (Management.ConnectionValidationOptions | null) | undefined; /** An array of user fields that should not be stored in the Auth0 database (https://auth0.com/docs/security/data-security/denylist) */ non_persistent_attrs?: (string[] | null) | undefined; /** Order of precedence for attribute types. If the property is not specified, the default precedence of attributes will be used. */ precedence?: Management.ConnectionIdentifierPrecedenceEnum[] | undefined; attributes?: Management.ConnectionAttributes | undefined; /** Set to true to inject context into custom DB scripts (warning: cannot be disabled once enabled) */ enable_script_context?: boolean | undefined; /** Set to true to use a legacy user store */ enabledDatabaseCustomization?: boolean | undefined; /** Enable this if you have a legacy user store and you want to gradually migrate those users to the Auth0 user store */ import_mode?: boolean | undefined; /** Stores encrypted string only configurations for connections */ configuration?: (Record | null) | undefined; customScripts?: Management.ConnectionCustomScripts | undefined; authentication_methods?: (Management.ConnectionAuthenticationMethods | null) | undefined; passkey_options?: (Management.ConnectionPasskeyOptions | null) | undefined; passwordPolicy?: (Management.ConnectionPasswordPolicyEnum | null) | undefined; password_complexity_options?: (Management.ConnectionPasswordComplexityOptions | null) | undefined; password_history?: (Management.ConnectionPasswordHistoryOptions | null) | undefined; password_no_personal_info?: (Management.ConnectionPasswordNoPersonalInfoOptions | null) | undefined; password_dictionary?: (Management.ConnectionPasswordDictionaryOptions | null) | undefined; api_enable_users?: boolean | undefined; api_enable_groups?: boolean | undefined; basic_profile?: boolean | undefined; ext_admin?: boolean | undefined; ext_is_suspended?: boolean | undefined; ext_agreed_terms?: boolean | undefined; ext_groups?: boolean | undefined; ext_assigned_plans?: boolean | undefined; ext_profile?: boolean | undefined; disable_self_service_change_password?: boolean | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; gateway_authentication?: (Management.ConnectionGatewayAuthentication | null) | undefined; federated_connections_access_tokens?: (Management.ConnectionFederatedConnectionsAccessTokens | null) | undefined; password_options?: Management.ConnectionPasswordOptions | undefined; /** Accepts any additional properties */ [key: string]: any; } /** Valid SAML protocol bindings */ export declare const ConnectionProtocolBindingEnumSaml: { readonly UrnOasisNamesTcSaml20BindingsHttpPost: "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"; readonly UrnOasisNamesTcSaml20BindingsHttpRedirect: "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"; }; export type ConnectionProtocolBindingEnumSaml = (typeof ConnectionProtocolBindingEnumSaml)[keyof typeof ConnectionProtocolBindingEnumSaml]; /** * SAML protocol binding mechanism for sending authentication requests to the identity provider. */ export type ConnectionProtocolBindingSaml = Management.ConnectionProtocolBindingEnumSaml; /** SMS provider values. Use 'sms_gateway' to use a custom SMS gateway instead of Twilio. */ export declare const ConnectionProviderEnumSms: { readonly SmsGateway: "sms_gateway"; readonly Twilio: "twilio"; }; export type ConnectionProviderEnumSms = (typeof ConnectionProviderEnumSms)[keyof typeof ConnectionProviderEnumSms]; /** * SMS provider. Set to 'sms_gateway' to use a custom SMS gateway instead of Twilio. */ export type ConnectionProviderSms = Management.ConnectionProviderEnumSms; /** * A ticket URL used for provisioning the connection */ export type ConnectionProvisioningTicketUrl = string; /** * Purposes for a connection */ export interface ConnectionPurposes { authentication?: Management.ConnectionAuthenticationPurpose | undefined; connected_accounts?: Management.ConnectionConnectedAccountsPurpose | undefined; } /** * Indicates whether to use realm fallback. */ export type ConnectionRealmFallback = boolean; /** * Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm. */ export type ConnectionRealms = string[]; /** * The URL where Auth0 will send SAML authentication requests (the Identity Provider's SSO URL). Must be a valid HTTPS URL. */ export type ConnectionRecipientUrlSaml = Management.ConnectionHttpsUrlWithHttpFallback255; export type ConnectionRegistrationEndpoint = Management.ConnectionHttpsUrlWithHttpFallback255; /** * JSON array containing a list of the JWE encryption algorithms (alg values) supported by the OP for Request Objects. These algorithms are used both when the Request Object is passed by value and when it is passed by reference. */ export type ConnectionRequestObjectEncryptionAlgValuesSupported = string[]; /** * JSON array containing a list of the JWE encryption algorithms (enc values) supported by the OP for Request Objects. These algorithms are used both when the Request Object is passed by value and when it is passed by reference. */ export type ConnectionRequestObjectEncryptionEncValuesSupported = string[]; /** * JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects, which are described in Section 6.1 of OpenID Connect Core 1.0 [OpenID.Core]. These algorithms are used both when the Request Object is passed by value (using the request parameter) and when it is passed by reference (using the request_uri parameter). Servers SHOULD support none and RS256. */ export type ConnectionRequestObjectSigningAlgValuesSupported = string[]; /** * Boolean value specifying whether the OP supports use of the request parameter, with true indicating support. If omitted, the default value is false. */ export type ConnectionRequestParameterSupported = boolean; /** * Custom XML template for SAML authentication requests. Supports variable substitution using @@variableName@@ syntax. When not provided, uses default SAML AuthnRequest template. See https://auth0.com/docs/authenticate/protocols/saml/saml-sso-integrations/configure-auth0-saml-service-provider#customize-the-request-template */ export type ConnectionRequestTemplateSaml = string; /** * The URL of the OAuth 1.0a request-token endpoint. This endpoint is used to obtain a temporary request token during the OAuth 1.0a authentication flow. */ export type ConnectionRequestTokenUrloAuth1 = Management.ConnectionHttpsUrlWithHttpFallback255; /** * Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support. If omitted, the default value is false. */ export type ConnectionRequestUriParameterSupported = boolean; /** * Boolean value specifying whether the OP requires use of the request_uri parameter. If omitted, the default value is false. */ export type ConnectionRequireRequestUriRegistration = boolean; /** * Indicates whether the user is required to provide a username in addition to an email address. */ export type ConnectionRequiresUsername = boolean; export interface ConnectionResponseCommon extends Management.CreateConnectionCommon { id: Management.ConnectionId; realms?: Management.ConnectionRealms | undefined; } /** * Response for connections with strategy=ad */ export interface ConnectionResponseContentAd extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentAd.Strategy; options?: Management.ConnectionOptionsAd | undefined; provisioning_ticket_url?: Management.ConnectionProvisioningTicketUrl | undefined; } export declare namespace ConnectionResponseContentAd { const Strategy: { readonly Ad: "ad"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=adfs */ export interface ConnectionResponseContentAdfs extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentAdfs.Strategy; options?: Management.ConnectionOptionsAdfs | undefined; provisioning_ticket_url?: Management.ConnectionProvisioningTicketUrl | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace ConnectionResponseContentAdfs { const Strategy: { readonly Adfs: "adfs"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=amazon */ export interface ConnectionResponseContentAmazon extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentAmazon.Strategy; options?: Management.ConnectionOptionsAmazon | undefined; } export declare namespace ConnectionResponseContentAmazon { const Strategy: { readonly Amazon: "amazon"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=apple */ export interface ConnectionResponseContentApple extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentApple.Strategy; options?: Management.ConnectionOptionsApple | undefined; } export declare namespace ConnectionResponseContentApple { const Strategy: { readonly Apple: "apple"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=auth0 */ export interface ConnectionResponseContentAuth0 extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentAuth0.Strategy; options?: Management.ConnectionOptionsAuth0 | undefined; } export declare namespace ConnectionResponseContentAuth0 { const Strategy: { readonly Auth0: "auth0"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=auth0-oidc */ export interface ConnectionResponseContentAuth0Oidc extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentAuth0Oidc.Strategy; options?: Management.ConnectionOptionsAuth0Oidc | undefined; } export declare namespace ConnectionResponseContentAuth0Oidc { const Strategy: { readonly Auth0Oidc: "auth0-oidc"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=waad */ export interface ConnectionResponseContentAzureAd extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentAzureAd.Strategy; options?: Management.ConnectionOptionsAzureAd | undefined; provisioning_ticket_url?: Management.ConnectionProvisioningTicketUrl | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace ConnectionResponseContentAzureAd { const Strategy: { readonly Waad: "waad"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=baidu */ export interface ConnectionResponseContentBaidu extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentBaidu.Strategy; options?: Management.ConnectionOptionsBaidu | undefined; } export declare namespace ConnectionResponseContentBaidu { const Strategy: { readonly Baidu: "baidu"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=bitbucket */ export interface ConnectionResponseContentBitbucket extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentBitbucket.Strategy; options?: Management.ConnectionOptionsBitbucket | undefined; } export declare namespace ConnectionResponseContentBitbucket { const Strategy: { readonly Bitbucket: "bitbucket"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=bitly */ export interface ConnectionResponseContentBitly extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentBitly.Strategy; options?: Management.ConnectionOptionsBitly | undefined; } export declare namespace ConnectionResponseContentBitly { const Strategy: { readonly Bitly: "bitly"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=box */ export interface ConnectionResponseContentBox extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentBox.Strategy; options?: Management.ConnectionOptionsBox | undefined; } export declare namespace ConnectionResponseContentBox { const Strategy: { readonly Box: "box"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=custom */ export interface ConnectionResponseContentCustom extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentCustom.Strategy; options?: Management.ConnectionOptionsCustom | undefined; provisioning_ticket_url?: Management.ConnectionProvisioningTicketUrl | undefined; } export declare namespace ConnectionResponseContentCustom { const Strategy: { readonly Custom: "custom"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=daccount */ export interface ConnectionResponseContentDaccount extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentDaccount.Strategy; options?: Management.ConnectionOptionsDaccount | undefined; } export declare namespace ConnectionResponseContentDaccount { const Strategy: { readonly Daccount: "daccount"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=dropbox */ export interface ConnectionResponseContentDropbox extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentDropbox.Strategy; options?: Management.ConnectionOptionsDropbox | undefined; } export declare namespace ConnectionResponseContentDropbox { const Strategy: { readonly Dropbox: "dropbox"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=dwolla */ export interface ConnectionResponseContentDwolla extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentDwolla.Strategy; options?: Management.ConnectionOptionsDwolla | undefined; } export declare namespace ConnectionResponseContentDwolla { const Strategy: { readonly Dwolla: "dwolla"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=email */ export interface ConnectionResponseContentEmail extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentEmail.Strategy; options?: Management.ConnectionOptionsEmail | undefined; } export declare namespace ConnectionResponseContentEmail { const Strategy: { readonly Email: "email"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=evernote */ export interface ConnectionResponseContentEvernote extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentEvernote.Strategy; options?: Management.ConnectionOptionsEvernote | undefined; } export declare namespace ConnectionResponseContentEvernote { const Strategy: { readonly Evernote: "evernote"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=evernote-sandbox */ export interface ConnectionResponseContentEvernoteSandbox extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentEvernoteSandbox.Strategy; options?: Management.ConnectionOptionsEvernote | undefined; } export declare namespace ConnectionResponseContentEvernoteSandbox { const Strategy: { readonly EvernoteSandbox: "evernote-sandbox"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=exact */ export interface ConnectionResponseContentExact extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentExact.Strategy; options?: Management.ConnectionOptionsExact | undefined; } export declare namespace ConnectionResponseContentExact { const Strategy: { readonly Exact: "exact"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=facebook */ export interface ConnectionResponseContentFacebook extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentFacebook.Strategy; options?: Management.ConnectionOptionsFacebook | undefined; } export declare namespace ConnectionResponseContentFacebook { const Strategy: { readonly Facebook: "facebook"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=fitbit */ export interface ConnectionResponseContentFitbit extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentFitbit.Strategy; options?: Management.ConnectionOptionsFitbit | undefined; } export declare namespace ConnectionResponseContentFitbit { const Strategy: { readonly Fitbit: "fitbit"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=github */ export interface ConnectionResponseContentGitHub extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentGitHub.Strategy; options?: Management.ConnectionOptionsGitHub | undefined; } export declare namespace ConnectionResponseContentGitHub { const Strategy: { readonly Github: "github"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=google-apps */ export interface ConnectionResponseContentGoogleApps extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentGoogleApps.Strategy; options?: Management.ConnectionOptionsGoogleApps | undefined; provisioning_ticket_url?: Management.ConnectionProvisioningTicketUrl | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace ConnectionResponseContentGoogleApps { const Strategy: { readonly GoogleApps: "google-apps"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=google-oauth2 */ export interface ConnectionResponseContentGoogleOAuth2 extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentGoogleOAuth2.Strategy; options?: Management.ConnectionOptionsGoogleOAuth2 | undefined; } export declare namespace ConnectionResponseContentGoogleOAuth2 { const Strategy: { readonly GoogleOauth2: "google-oauth2"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=ip */ export interface ConnectionResponseContentIp extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentIp.Strategy; options?: Management.ConnectionOptionsIp | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace ConnectionResponseContentIp { const Strategy: { readonly Ip: "ip"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=instagram */ export interface ConnectionResponseContentInstagram extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentInstagram.Strategy; options?: Management.ConnectionOptionsInstagram | undefined; } export declare namespace ConnectionResponseContentInstagram { const Strategy: { readonly Instagram: "instagram"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=line */ export interface ConnectionResponseContentLine extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentLine.Strategy; options?: Management.ConnectionOptionsLine | undefined; } export declare namespace ConnectionResponseContentLine { const Strategy: { readonly Line: "line"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=linkedin */ export interface ConnectionResponseContentLinkedin extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentLinkedin.Strategy; options?: Management.ConnectionOptionsLinkedin | undefined; } export declare namespace ConnectionResponseContentLinkedin { const Strategy: { readonly Linkedin: "linkedin"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=oauth1 */ export interface ConnectionResponseContentOAuth1 extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentOAuth1.Strategy; options?: Management.ConnectionOptionsOAuth1 | undefined; } export declare namespace ConnectionResponseContentOAuth1 { const Strategy: { readonly Oauth1: "oauth1"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=oauth2 */ export interface ConnectionResponseContentOAuth2 extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentOAuth2.Strategy; options?: Management.ConnectionOptionsOAuth2 | undefined; } export declare namespace ConnectionResponseContentOAuth2 { const Strategy: { readonly Oauth2: "oauth2"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=oidc */ export interface ConnectionResponseContentOidc extends Management.ConnectionResponseCommon { strategy: ConnectionResponseContentOidc.Strategy; authentication?: Management.ConnectionAuthenticationPurpose | undefined; connected_accounts?: Management.ConnectionConnectedAccountsPurposeXaa | undefined; options?: Management.ConnectionOptionsOidc | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace ConnectionResponseContentOidc { const Strategy: { readonly Oidc: "oidc"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=office365 */ export interface ConnectionResponseContentOffice365 extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentOffice365.Strategy; options?: Management.ConnectionOptionsOffice365 | undefined; provisioning_ticket_url?: Management.ConnectionProvisioningTicketUrl | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace ConnectionResponseContentOffice365 { const Strategy: { readonly Office365: "office365"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=okta */ export interface ConnectionResponseContentOkta extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentOkta.Strategy; options?: Management.ConnectionOptionsOkta | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace ConnectionResponseContentOkta { const Strategy: { readonly Okta: "okta"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=paypal */ export interface ConnectionResponseContentPaypal extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentPaypal.Strategy; options?: Management.ConnectionOptionsPaypal | undefined; } export declare namespace ConnectionResponseContentPaypal { const Strategy: { readonly Paypal: "paypal"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=paypal-sandbox */ export interface ConnectionResponseContentPaypalSandbox extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentPaypalSandbox.Strategy; options?: Management.ConnectionOptionsPaypal | undefined; } export declare namespace ConnectionResponseContentPaypalSandbox { const Strategy: { readonly PaypalSandbox: "paypal-sandbox"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=pingfederate */ export interface ConnectionResponseContentPingFederate extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentPingFederate.Strategy; options?: Management.ConnectionOptionsPingFederate | undefined; provisioning_ticket_url?: Management.ConnectionProvisioningTicketUrl | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace ConnectionResponseContentPingFederate { const Strategy: { readonly Pingfederate: "pingfederate"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=planningcenter */ export interface ConnectionResponseContentPlanningCenter extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentPlanningCenter.Strategy; options?: Management.ConnectionOptionsPlanningCenter | undefined; } export declare namespace ConnectionResponseContentPlanningCenter { const Strategy: { readonly Planningcenter: "planningcenter"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=samlp */ export interface ConnectionResponseContentSaml extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentSaml.Strategy; options?: Management.ConnectionOptionsSaml | undefined; provisioning_ticket_url?: Management.ConnectionProvisioningTicketUrl | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace ConnectionResponseContentSaml { const Strategy: { readonly Samlp: "samlp"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=sms */ export interface ConnectionResponseContentSms extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentSms.Strategy; options?: Management.ConnectionOptionsSms | undefined; } export declare namespace ConnectionResponseContentSms { const Strategy: { readonly Sms: "sms"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=salesforce */ export interface ConnectionResponseContentSalesforce extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentSalesforce.Strategy; options?: Management.ConnectionOptionsSalesforce | undefined; } export declare namespace ConnectionResponseContentSalesforce { const Strategy: { readonly Salesforce: "salesforce"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=salesforce-community */ export interface ConnectionResponseContentSalesforceCommunity extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentSalesforceCommunity.Strategy; options?: Management.ConnectionOptionsSalesforceCommunity | undefined; } export declare namespace ConnectionResponseContentSalesforceCommunity { const Strategy: { readonly SalesforceCommunity: "salesforce-community"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=salesforce-sandbox */ export interface ConnectionResponseContentSalesforceSandbox extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentSalesforceSandbox.Strategy; options?: Management.ConnectionOptionsSalesforce | undefined; } export declare namespace ConnectionResponseContentSalesforceSandbox { const Strategy: { readonly SalesforceSandbox: "salesforce-sandbox"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=sharepoint */ export interface ConnectionResponseContentSharepoint extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentSharepoint.Strategy; options?: Management.ConnectionOptionsSharepoint | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace ConnectionResponseContentSharepoint { const Strategy: { readonly Sharepoint: "sharepoint"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=shop */ export interface ConnectionResponseContentShop extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentShop.Strategy; options?: Management.ConnectionOptionsShop | undefined; } export declare namespace ConnectionResponseContentShop { const Strategy: { readonly Shop: "shop"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=shopify */ export interface ConnectionResponseContentShopify extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentShopify.Strategy; options?: Management.ConnectionOptionsShopify | undefined; } export declare namespace ConnectionResponseContentShopify { const Strategy: { readonly Shopify: "shopify"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=soundcloud */ export interface ConnectionResponseContentSoundcloud extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentSoundcloud.Strategy; options?: Management.ConnectionOptionsSoundcloud | undefined; } export declare namespace ConnectionResponseContentSoundcloud { const Strategy: { readonly Soundcloud: "soundcloud"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=thirtysevensignals */ export interface ConnectionResponseContentThirtySevenSignals extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentThirtySevenSignals.Strategy; options?: Management.ConnectionOptionsThirtySevenSignals | undefined; } export declare namespace ConnectionResponseContentThirtySevenSignals { const Strategy: { readonly Thirtysevensignals: "thirtysevensignals"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=twitter */ export interface ConnectionResponseContentTwitter extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentTwitter.Strategy; options?: Management.ConnectionOptionsTwitter | undefined; } export declare namespace ConnectionResponseContentTwitter { const Strategy: { readonly Twitter: "twitter"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=untappd */ export interface ConnectionResponseContentUntappd extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentUntappd.Strategy; options?: Management.ConnectionOptionsUntappd | undefined; } export declare namespace ConnectionResponseContentUntappd { const Strategy: { readonly Untappd: "untappd"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=vkontakte */ export interface ConnectionResponseContentVkontakte extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentVkontakte.Strategy; options?: Management.ConnectionOptionsVkontakte | undefined; } export declare namespace ConnectionResponseContentVkontakte { const Strategy: { readonly Vkontakte: "vkontakte"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=weibo */ export interface ConnectionResponseContentWeibo extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentWeibo.Strategy; options?: Management.ConnectionOptionsWeibo | undefined; } export declare namespace ConnectionResponseContentWeibo { const Strategy: { readonly Weibo: "weibo"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=windowslive */ export interface ConnectionResponseContentWindowsLive extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentWindowsLive.Strategy; options?: Management.ConnectionOptionsWindowsLive | undefined; } export declare namespace ConnectionResponseContentWindowsLive { const Strategy: { readonly Windowslive: "windowslive"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=wordpress */ export interface ConnectionResponseContentWordpress extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentWordpress.Strategy; options?: Management.ConnectionOptionsWordpress | undefined; } export declare namespace ConnectionResponseContentWordpress { const Strategy: { readonly Wordpress: "wordpress"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=yahoo */ export interface ConnectionResponseContentYahoo extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentYahoo.Strategy; options?: Management.ConnectionOptionsYahoo | undefined; } export declare namespace ConnectionResponseContentYahoo { const Strategy: { readonly Yahoo: "yahoo"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Response for connections with strategy=yandex */ export interface ConnectionResponseContentYandex extends Management.ConnectionPurposes, Management.ConnectionResponseCommon { strategy: ConnectionResponseContentYandex.Strategy; options?: Management.ConnectionOptionsYandex | undefined; } export declare namespace ConnectionResponseContentYandex { const Strategy: { readonly Yandex: "yandex"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * A list of the OAuth 2.0 response_mode values that this OP supports. If omitted, the default for Dynamic OpenID Providers is ["query", "fragment"] */ export type ConnectionResponseModesSupported = string[]; /** * A list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID Providers MUST support the code, id_token, and the token id_token Response Type values */ export type ConnectionResponseTypesSupported = string[]; /** * OAuth 2.0 scopes that will be requested from Amazon during authorization. This is automatically populated based on the profile and postal_code settings, plus any freeform_scopes. */ export type ConnectionScopeAmazon = Management.ConnectionScopeArray; /** * Array of custom OAuth 2.0 scopes to request during authentication. */ export type ConnectionScopeArray = Management.ConnectionScopeItem[]; /** * Array of custom OAuth 2.0 scopes to request during authentication. */ export type ConnectionScopeArrayFacebook = Management.ConnectionScopeItem[]; /** * Array of custom OAuth 2.0 scopes to request during authentication. */ export type ConnectionScopeArrayWindowsLive = Management.ConnectionScopeArray; /** * OAuth 2.0 scopes to request from Azure AD during authentication. Each scope represents a permission (e.g., 'User.Read', 'Group.Read.All'). Only applies with Microsoft Identity Platform v2.0. See Microsoft Graph permissions reference for available scopes. */ export type ConnectionScopeAzureAd = string[]; /** * Computed comma-separated OAuth scope string sent to Facebook. */ export type ConnectionScopeFacebook = string; /** * Additional OAuth scopes requested beyond the default `email profile` scopes; ignored unless `allow_setting_login_scopes` is true. */ export type ConnectionScopeGoogleApps = Management.ConnectionScopeItemGoogleApps[]; /** * Array of OAuth 2.0 scopes requested during Google authentication. */ export type ConnectionScopeGoogleOAuth2 = Management.ConnectionScopeArray; /** * A single OAuth 2.0 scope string */ export type ConnectionScopeItem = string; /** * An OAuth scope string. */ export type ConnectionScopeItemGoogleApps = string; /** * Scopes to request from LinkedIn during OAuth. Use standard scopes such as r_liteprofile and r_emailaddress; legacy or partner scopes (e.g., r_basicprofile, r_fullprofile, rw_company_admin) may require LinkedIn approval and may not be available to new apps. */ export type ConnectionScopeLinkedin = Management.ConnectionScopeArray; /** * OAuth 2.0 scopes requested from the identity provider during authorization. Determines what user information and permissions Auth0 can access. Can be specified as a space-delimited string (e.g., 'openid profile email') or array of scope values. The 'useOauthSpecScope' setting controls delimiter behavior when using connection_scope parameter. */ export type ConnectionScopeOAuth2 = string | string[]; /** * Space-separated list of OAuth 2.0 scopes requested during authorization. Must include 'openid' (required by OIDC spec). Common values: 'openid profile email'. Additional scopes depend on the identity provider. */ export type ConnectionScopeOidc = string; /** * OAuth 2.0 scopes requested from PayPal during authorization. Built automatically from the enabled attribute flags (profile, email, address, phone) plus any freeform_scopes. Always includes 'openid' as the base scope. */ export type ConnectionScopePaypal = Management.ConnectionScopeArray; /** * OAuth scopes to request from Salesforce. This is computed from enabled permission options and any additional freeform scopes. */ export type ConnectionScopeSalesforce = Management.ConnectionScopeArray; /** * A list of the OAuth 2.0 [RFC6749] scope values that this server supports. The server MUST support the openid scope value. Servers MAY choose not to advertise some supported scope values even when this parameter is used, although those defined in [OpenID.Core] SHOULD be listed, if supported. RECOMMENDED but not REQUIRED */ export type ConnectionScopesSupported = (string[] | null) | undefined; /** * Custom scripts to transform user profile data or modify OAuth1 flow behavior */ export interface ConnectionScriptsOAuth1 { /** Custom JavaScript function to retrieve and transform user profile data from the identity provider. Called with the access token and token exchange response. Must return a user profile object. Executed in a sandboxed environment. If not provided, an empty profile object is used. */ fetchUserProfile?: string | undefined; } /** * Custom scripts to transform user profile data or modify OAuth2 flow behavior */ export interface ConnectionScriptsOAuth2 { /** Custom JavaScript function to retrieve and transform user profile data from the identity provider. Called with the access token and token exchange response. Must return a user profile object. Executed in a sandboxed environment. If not provided, an empty profile object is used. */ fetchUserProfile?: string | undefined; /** Custom JavaScript function to dynamically construct the logout URL for the identity provider. Called with the request query parameters and must invoke a callback with the logout URL. Only used if 'logoutUrl' is not configured. Executed in a sandboxed environment. */ getLogoutUrl?: string | undefined; } /** * 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. */ export type ConnectionSendBackChannelNonce = boolean; export type ConnectionServiceDocumentation = Management.ConnectionHttpsUrlWithHttpFallback255; /** When using an external IdP, this flag determines whether 'name', 'given_name', 'family_name', 'nickname', and 'picture' attributes are updated. In addition, it also determines whether the user is created when user doesnt exist previously. Possible values are 'on_each_login' (default value, it configures the connection to automatically create the user if necessary and update the root attributes from the external IdP with each user login. When this setting is used, root attributes cannot be independently updated), 'on_first_login' (configures the connection to create the user and set the root attributes on first login only, allowing them to be independently updated thereafter), and 'never_on_login' (configures the connection not to create the user and not to set the root attributes from the external IdP, allowing them to be independently updated). */ export declare const ConnectionSetUserRootAttributesEnum: { readonly OnEachLogin: "on_each_login"; readonly OnFirstLogin: "on_first_login"; readonly NeverOnLogin: "never_on_login"; }; export type ConnectionSetUserRootAttributesEnum = (typeof ConnectionSetUserRootAttributesEnum)[keyof typeof ConnectionSetUserRootAttributesEnum]; /** * SHA-1 thumbprint of the certificate */ export type ConnectionSha1Thumbprint = string; /** Choose how Auth0 sets the email_verified field in the user profile. */ export declare const ConnectionShouldTrustEmailVerifiedConnectionEnum: { readonly NeverSetEmailsAsVerified: "never_set_emails_as_verified"; readonly AlwaysSetEmailsAsVerified: "always_set_emails_as_verified"; }; export type ConnectionShouldTrustEmailVerifiedConnectionEnum = (typeof ConnectionShouldTrustEmailVerifiedConnectionEnum)[keyof typeof ConnectionShouldTrustEmailVerifiedConnectionEnum]; /** * Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. Defaults to `false`. */ export type ConnectionShowAsButton = boolean; /** * The sign-in endpoint type for the AD-LDAP connector agent (managed by the AD Connector agent). */ export type ConnectionSignInEndpointAd = Management.ConnectionHttpsUrlWithHttpFallback255; /** * Passive Requestor (WS-Fed) sign-in endpoint discovered from metadata or provided explicitly. */ export type ConnectionSignInEndpointAdfs = Management.ConnectionHttpsUrlWithHttpFallback2048; /** * Identity provider's SAML SingleSignOnService endpoint URL where Auth0 sends SAML authentication requests. This is the primary login URL for the SAML connection. Required unless using metadataUrl or metadataXml. */ export type ConnectionSignInEndpointSaml = Management.ConnectionHttpsUrlWithHttpFallback2048; /** * Identity provider's SAML SingleLogoutService endpoint URL where Auth0 sends logout requests for federated sign-out. When not provided, defaults to signInEndpoint. Only used if disableSignout is false. */ export type ConnectionSignOutEndpointSaml = Management.ConnectionHttpsUrlWithHttpFallback2048; /** * When true, Auth0 signs SAML authentication requests using the connection's signing key. The signature includes the request's digest and is validated by the identity provider. Defaults to false (unsigned requests). */ export type ConnectionSignSamlRequestSaml = boolean; /** Valid SAML signature algorithms */ export declare const ConnectionSignatureAlgorithmEnumSaml: { readonly RsaSha1: "rsa-sha1"; readonly RsaSha256: "rsa-sha256"; }; export type ConnectionSignatureAlgorithmEnumSaml = (typeof ConnectionSignatureAlgorithmEnumSaml)[keyof typeof ConnectionSignatureAlgorithmEnumSaml]; /** * Algorithm used to sign SAML authentication requests and logout requests using the connection's signing key. Common values: 'rsa-sha256' (RSA signature with SHA-256 digest) or 'rsa-sha1'. Defaults to 'rsa-sha256'. */ export type ConnectionSignatureAlgorithmSaml = Management.ConnectionSignatureAlgorithmEnumSaml; /** OAuth 1.0a signature algorithm used when signing request-token and access-token calls for this connection (RSA-SHA1 only). */ export declare const ConnectionSignatureMethodOAuth1: { readonly RsaSha1: "RSA-SHA1"; }; export type ConnectionSignatureMethodOAuth1 = (typeof ConnectionSignatureMethodOAuth1)[keyof typeof ConnectionSignatureMethodOAuth1]; /** * Base64-encoded X.509 certificate from the identity provider used to validate signatures in SAML responses and assertions. The certificate is decoded and used for cryptographic signature verification. */ export type ConnectionSigningCertSaml = Management.ConnectionSigningCertificatePemSaml; /** * X.509 signing certificate from the identity provider in .der format. Used to validate signatures in SAML Responses and Assertions. This is an alternative to signingCert and is kept for backward compatibility. Prefer using signingCert instead. */ export type ConnectionSigningCertificateDerSaml = string; /** * Base64-encoded X.509 certificate from the identity provider used to validate signatures in SAML responses and assertions. The certificate is decoded and used for cryptographic signature verification. */ export type ConnectionSigningCertificatePemPingFederate = string; /** * Base64-encoded X.509 certificate from the identity provider used to validate signatures in SAML responses and assertions. The certificate is decoded and used for cryptographic signature verification. */ export type ConnectionSigningCertificatePemSaml = string; /** * Key pair with 'key' and 'cert' properties for signing SAML messages */ export interface ConnectionSigningKeySaml { /** Base64-encoded X.509 certificate in PEM format used by Auth0 to sign SAML requests and logout messages. */ cert?: string | undefined; /** Private key in PEM format used by Auth0 to sign SAML requests and logout messages. */ key?: string | undefined; } /** Specifies the signup behavior for password authentication */ export declare const ConnectionSignupBehaviorEnum: { readonly Allow: "allow"; readonly Block: "block"; }; export type ConnectionSignupBehaviorEnum = (typeof ConnectionSignupBehaviorEnum)[keyof typeof ConnectionSignupBehaviorEnum]; export declare const ConnectionStrategyEnum: { readonly Ad: "ad"; readonly Adfs: "adfs"; readonly Amazon: "amazon"; readonly Apple: "apple"; readonly Dropbox: "dropbox"; readonly Bitbucket: "bitbucket"; readonly Auth0Oidc: "auth0-oidc"; readonly Auth0: "auth0"; readonly Baidu: "baidu"; readonly Bitly: "bitly"; readonly Box: "box"; readonly Custom: "custom"; readonly Daccount: "daccount"; readonly Dwolla: "dwolla"; readonly Email: "email"; readonly EvernoteSandbox: "evernote-sandbox"; readonly Evernote: "evernote"; readonly Exact: "exact"; readonly Facebook: "facebook"; readonly Fitbit: "fitbit"; readonly Github: "github"; readonly GoogleApps: "google-apps"; readonly GoogleOauth2: "google-oauth2"; readonly Instagram: "instagram"; readonly Ip: "ip"; readonly Line: "line"; readonly Linkedin: "linkedin"; readonly Oauth1: "oauth1"; readonly Oauth2: "oauth2"; readonly Office365: "office365"; readonly Oidc: "oidc"; readonly Okta: "okta"; readonly Paypal: "paypal"; readonly PaypalSandbox: "paypal-sandbox"; readonly Pingfederate: "pingfederate"; readonly Planningcenter: "planningcenter"; readonly SalesforceCommunity: "salesforce-community"; readonly SalesforceSandbox: "salesforce-sandbox"; readonly Salesforce: "salesforce"; readonly Samlp: "samlp"; readonly Sharepoint: "sharepoint"; readonly Shopify: "shopify"; readonly Shop: "shop"; readonly Sms: "sms"; readonly Soundcloud: "soundcloud"; readonly Thirtysevensignals: "thirtysevensignals"; readonly Twitter: "twitter"; readonly Untappd: "untappd"; readonly Vkontakte: "vkontakte"; readonly Waad: "waad"; readonly Weibo: "weibo"; readonly Windowslive: "windowslive"; readonly Wordpress: "wordpress"; readonly Yahoo: "yahoo"; readonly Yandex: "yandex"; readonly Auth0Adldap: "auth0-adldap"; }; export type ConnectionStrategyEnum = (typeof ConnectionStrategyEnum)[keyof typeof ConnectionStrategyEnum]; export type ConnectionStrategyVersionEnumLinkedin = number; /** * Version number of the windowslive strategy implementation. */ export type ConnectionStrategyVersionEnumWindowsLive = number; /** * A list of the Subject Identifier types that this OP supports. Valid types include pairwise and public */ export type ConnectionSubjectTypesSupported = string[]; /** * SMS message template. Use `@@password@@` as a placeholder for the verification code. */ export type ConnectionTemplateSms = string; /** SMS template syntax type. Set to 'md_with_macros' to enable macro processing in templates. */ export declare const ConnectionTemplateSyntaxEnumSms: { readonly Liquid: "liquid"; readonly MdWithMacros: "md_with_macros"; }; export type ConnectionTemplateSyntaxEnumSms = (typeof ConnectionTemplateSyntaxEnumSms)[keyof typeof ConnectionTemplateSyntaxEnumSms]; /** * Tenant domain */ export type ConnectionTenantDomain = string; /** * Primary AD domain hint used for HRD and discovery. */ export type ConnectionTenantDomainAd = string; export type ConnectionTenantDomainAzureAdOne = string; /** * The Google Workspace primary domain used to identify the organization during authentication. */ export type ConnectionTenantDomainGoogleApps = Management.ConnectionTenantDomain; export type ConnectionTenantDomainSaml = Management.ConnectionTenantDomain; /** * The Azure AD tenant ID as a UUID. The unique identifier for your Azure AD organization. Must be a valid 36-character UUID. */ export type ConnectionTenantIdAzureAd = string; /** * Array of certificate thumbprints (SHA-128/SHA-256/SHA-512 hex hashes) for validating SAML signatures. Used with WS-Federation protocol. Maximum 20 thumbprints. Each thumbprint must be a hexadecimal string. */ export type ConnectionThumbprints = string[]; /** * Array of certificate SHA-1 thumbprints for validating signatures. Managed by Auth0 when using the AD Connector agent. */ export type ConnectionThumbprintsAd = Management.ConnectionSha1Thumbprint[]; /** * SHA-1 thumbprints (fingerprints) of the identity provider's signing certificates. Automatically computed from signingCert during connection creation. Each thumbprint must be a 40-character hexadecimal string. */ export type ConnectionThumbprintsSaml = Management.ConnectionSha1Thumbprint[]; export type ConnectionTokenEndpoint = Management.ConnectionHttpsUrlWithHttpFallback255; /** Authentication method used at the identity provider's token endpoint. 'client_secret_post' sends credentials in the request body; 'private_key_jwt' uses a signed JWT assertion for enhanced security. */ export declare const ConnectionTokenEndpointAuthMethodEnum: { readonly ClientSecretPost: "client_secret_post"; readonly PrivateKeyJwt: "private_key_jwt"; }; export type ConnectionTokenEndpointAuthMethodEnum = (typeof ConnectionTokenEndpointAuthMethodEnum)[keyof typeof ConnectionTokenEndpointAuthMethodEnum]; /** * JSON array containing a list of Client Authentication methods supported by this Token Endpoint. The options are client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt, as described in Section 9 of OpenID Connect Core 1.0 [OpenID.Core]. Other authentication methods MAY be defined by extensions. If omitted, the default is client_secret_basic -- the HTTP Basic Authentication Scheme specified in Section 2.3.1 of OAuth 2.0 [RFC6749]. */ export type ConnectionTokenEndpointAuthMethodsSupported = string[]; /** Algorithm used to sign client_assertions. */ export declare const ConnectionTokenEndpointAuthSigningAlgEnum: { readonly Es256: "ES256"; readonly Es384: "ES384"; readonly Ps256: "PS256"; readonly Ps384: "PS384"; readonly Rs256: "RS256"; readonly Rs384: "RS384"; readonly Rs512: "RS512"; }; export type ConnectionTokenEndpointAuthSigningAlgEnum = (typeof ConnectionTokenEndpointAuthSigningAlgEnum)[keyof typeof ConnectionTokenEndpointAuthSigningAlgEnum]; /** * JSON array containing a list of the JWS signing algorithms (alg values) supported by the Token Endpoint for the signature on the JWT [JWT] used to authenticate the Client at the Token Endpoint for the private_key_jwt and client_secret_jwt authentication methods. Servers SHOULD support RS256. The value none MUST NOT be used. */ export type ConnectionTokenEndpointAuthSigningAlgValuesSupported = string[]; export interface ConnectionTotpEmail { length?: Management.ConnectionTotpLengthEmail | undefined; time_step?: Management.ConnectionTotpTimeStepEmail | undefined; } /** * Length of the TOTP code */ export type ConnectionTotpLengthEmail = Management.ConnectionTotpLengthPasswordless; /** * Length of the TOTP code */ export type ConnectionTotpLengthPasswordless = number; /** * Number of digits in the verification code */ export type ConnectionTotpLengthSms = Management.ConnectionTotpLengthPasswordless; /** * Time-based One-Time Password (TOTP) options */ export interface ConnectionTotpSms { length?: Management.ConnectionTotpLengthSms | undefined; time_step?: Management.ConnectionTotpTimeStepSms | undefined; } /** * Time step for TOTP in seconds */ export type ConnectionTotpTimeStepEmail = Management.ConnectionTotpTimeStepPasswordless; /** * Time step for TOTP in seconds */ export type ConnectionTotpTimeStepPasswordless = number; /** * Code validity duration in seconds */ export type ConnectionTotpTimeStepSms = Management.ConnectionTotpTimeStepPasswordless; /** * Twilio Account SID */ export type ConnectionTwilioSidSms = string; /** * Twilio Auth Token */ export type ConnectionTwilioTokenSms = string; /** OIDC communication channel type. 'back_channel' (confidential client) exchanges tokens server-side for stronger security; 'front_channel' handles responses in the browser. */ export declare const ConnectionTypeEnumOidc: { readonly BackChannel: "back_channel"; readonly FrontChannel: "front_channel"; }; export type ConnectionTypeEnumOidc = (typeof ConnectionTypeEnumOidc)[keyof typeof ConnectionTypeEnumOidc]; /** Connection type */ export declare const ConnectionTypeEnumOkta: { readonly BackChannel: "back_channel"; }; export type ConnectionTypeEnumOkta = (typeof ConnectionTypeEnumOkta)[keyof typeof ConnectionTypeEnumOkta]; /** * Languages and scripts supported for the user interface, represented as a JSON array of BCP47 [RFC5646] language tag values. */ export type ConnectionUiLocalesSupported = string[]; export type ConnectionUpstreamAdditionalProperties = Management.ConnectionUpstreamAlias | Management.ConnectionUpstreamValue; export interface ConnectionUpstreamAlias { alias?: Management.ConnectionUpstreamAliasEnum | undefined; } export declare const ConnectionUpstreamAliasEnum: { readonly AcrValues: "acr_values"; readonly Audience: "audience"; readonly ClientId: "client_id"; readonly Display: "display"; readonly IdTokenHint: "id_token_hint"; readonly LoginHint: "login_hint"; readonly MaxAge: "max_age"; readonly Prompt: "prompt"; readonly Resource: "resource"; readonly ResponseMode: "response_mode"; readonly ResponseType: "response_type"; readonly UiLocales: "ui_locales"; }; export type ConnectionUpstreamAliasEnum = (typeof ConnectionUpstreamAliasEnum)[keyof typeof ConnectionUpstreamAliasEnum]; /** * Options for adding parameters in the request to the upstream IdP */ export type ConnectionUpstreamParams = (Record | null) | undefined; /** * Options for adding parameters in the request to the upstream IdP. See https://auth0.com/docs/authenticate/identity-providers/pass-parameters-to-idps */ export type ConnectionUpstreamParamsFacebook = Record; export interface ConnectionUpstreamValue { value?: string | undefined; } /** * When enabled (true), uses the Azure AD common endpoint for multi-tenant authentication. Allows users from any Azure AD organization to sign in. Requires userid_attribute set to 'sub' (not 'oid'). Cannot be used with SCIM provisioning. Defaults to false. */ export type ConnectionUseCommonEndpointAzureAd = boolean; /** * The URL of the OAuth 1.0a user-authorization endpoint. This endpoint is used to redirect users to the provider's site to authorize the temporary request token obtained from the request-token endpoint during the OAuth 1.0a authentication flow. */ export type ConnectionUserAuthorizationUrloAuth1 = Management.ConnectionHttpsUrlWithHttpFallback255; /** * Custom SAML assertion attribute to use as the unique user identifier. When provided, this attribute is prepended to the default user_id mapping list with highest priority. Accepts a string (single SAML attribute name). */ export type ConnectionUserIdAttributeSaml = string; /** * The Azure AD claim to use as the unique user identifier. 'oid' (Object ID) is recommended for single-tenant connections and required for SCIM. 'sub' (Subject) is required for multi-tenant/common endpoint. Only applies with OpenID Connect protocol. */ export type ConnectionUseridAttributeAzureAd = Management.ConnectionUseridAttributeEnumAzureAd; /** User ID attribute to use. Only applies when waad_protocol=openid-connect */ export declare const ConnectionUseridAttributeEnumAzureAd: { readonly Oid: "oid"; readonly Sub: "sub"; }; export type ConnectionUseridAttributeEnumAzureAd = (typeof ConnectionUseridAttributeEnumAzureAd)[keyof typeof ConnectionUseridAttributeEnumAzureAd]; /** * JSON array containing a list of the JWE [JWE] encryption algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT]. */ export type ConnectionUserinfoEncryptionAlgValuesSupported = string[]; /** * JSON array containing a list of the JWE encryption algorithms (enc values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT]. */ export type ConnectionUserinfoEncryptionEncValuesSupported = string[]; export type ConnectionUserinfoEndpoint = Management.ConnectionHttpsUrlWithHttpFallback255; /** * JSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT]. The value none MAY be included. */ export type ConnectionUserinfoSigningAlgValuesSupported = string[]; export interface ConnectionUsernameValidationOptions { min: number; max: number; } /** * Options for validation */ export interface ConnectionValidationOptions { username?: (Management.ConnectionUsernameValidationOptions | null) | undefined; } /** * The authentication protocol for Azure AD v1 endpoints. 'openid-connect' (default, recommended) uses modern OAuth 2.0/OIDC. 'ws-federation' is a legacy SAML-based protocol for older integrations. Only available with Azure AD v1 API. */ export type ConnectionWaadProtocol = Management.ConnectionWaadProtocolEnumAzureAd; /** Available WAAD protocols */ export declare const ConnectionWaadProtocolEnumAzureAd: { readonly WsFederation: "ws-federation"; readonly OpenidConnect: "openid-connect"; }; export type ConnectionWaadProtocolEnumAzureAd = (typeof ConnectionWaadProtocolEnumAzureAd)[keyof typeof ConnectionWaadProtocolEnumAzureAd]; /** * Metadata associated with the connection in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. */ export type ConnectionsMetadata = Record; export interface CreateActionModuleResponseContent { /** The unique ID of the module. */ id?: string | undefined; /** The name of the module. */ name?: string | undefined; /** The source code from the module's draft version. */ code?: string | undefined; /** The npm dependencies from the module's draft version. */ dependencies?: Management.ActionModuleDependency[] | undefined; /** The secrets from the module's draft version (names and timestamps only, values never returned). */ secrets?: Management.ActionModuleSecret[] | undefined; /** The number of deployed actions using this module. */ actions_using_module_total?: number | undefined; /** Whether all draft changes have been published as a version. */ all_changes_published?: boolean | undefined; /** The version number of the latest published version. Omitted if no versions have been published. */ latest_version_number?: number | undefined; /** Timestamp when the module was created. */ created_at?: string | undefined; /** Timestamp when the module was last updated. */ updated_at?: string | undefined; latest_version?: Management.ActionModuleVersionReference | undefined; } export interface CreateActionModuleVersionResponseContent { /** The unique ID for this version. */ id?: string | undefined; /** The ID of the parent module. */ module_id?: string | undefined; /** The sequential version number. */ version_number?: number | undefined; /** The exact source code that was published with this version. */ code?: string | undefined; /** Secrets available to this version (name and updated_at only, values never returned). */ secrets?: Management.ActionModuleSecret[] | undefined; /** Dependencies locked to this version. */ dependencies?: Management.ActionModuleDependency[] | undefined; /** The timestamp when this version was created. */ created_at?: string | undefined; } export interface CreateActionResponseContent { /** The unique ID of the action. */ id?: string | undefined; /** The name of an action. */ name?: string | undefined; /** The list of triggers that this action supports. At this time, an action can only target a single trigger at a time. */ supported_triggers?: Management.ActionTrigger[] | undefined; /** True if all of an Action's contents have been deployed. */ all_changes_deployed?: boolean | undefined; /** The time when this action was created. */ created_at?: string | undefined; /** The time when this action was updated. */ updated_at?: string | undefined; /** The source code of the action. */ code?: string | undefined; /** The list of third party npm modules, and their versions, that this action depends on. */ dependencies?: Management.ActionVersionDependency[] | undefined; /** The Node runtime. For example: `node22`, defaults to `node22` */ runtime?: string | undefined; /** The list of secrets that are included in an action or a version of an action. */ secrets?: Management.ActionSecretResponse[] | undefined; deployed_version?: Management.ActionDeployedVersion | undefined; /** installed_integration_id is the fk reference to the InstalledIntegration entity. */ installed_integration_id?: string | undefined; integration?: Management.Integration | undefined; status?: Management.ActionBuildStatusEnum | undefined; /** The time when this action was built successfully. */ built_at?: string | undefined; /** True if the action should be deployed after creation. */ deploy?: boolean | undefined; /** The list of action modules and their versions used by this action. */ modules?: Management.ActionModuleReference[] | undefined; } /** * Phone provider configuration schema */ export interface CreateBrandingPhoneProviderResponseContent { id?: string | undefined; /** The name of the tenant */ tenant?: string | undefined; name: Management.PhoneProviderNameEnum; channel?: Management.PhoneProviderChannelEnum | undefined; /** Whether the provider is enabled (false) or disabled (true). */ disabled?: boolean | undefined; configuration?: Management.PhoneProviderConfiguration | undefined; /** The provider's creation date and time in ISO 8601 format */ created_at?: string | undefined; /** The date and time of the last update to the provider in ISO 8601 format */ updated_at?: string | undefined; } export interface CreateBrandingThemeResponseContent { borders: Management.BrandingThemeBorders; colors: Management.BrandingThemeColors; /** Display Name */ displayName: string; fonts: Management.BrandingThemeFonts; page_background: Management.BrandingThemePageBackground; /** Theme Id */ themeId: string; widget: Management.BrandingThemeWidget; } /** * Defines `self_signed_tls_client_auth` client authentication method. If the property is defined, the client is configured to use mTLS authentication method utilizing self-signed certificate. */ export interface CreateClientAuthenticationMethodSelfSignedTlsClientAuth { credentials: Management.CreateClientAuthenticationMethodSelfSignedTlsClientAuthCredentials; } /** * Fully defined credentials that will be enabled on the client for mTLS authentication utilizing self-signed certificate. */ export type CreateClientAuthenticationMethodSelfSignedTlsClientAuthCredentials = Management.X509CertificateCredential[]; export interface CreateClientGrantResponseContent { /** ID of the client grant. */ id?: string | undefined; /** ID of the client. */ client_id?: string | undefined; /** The audience (API identifier) of this client grant. */ audience?: string | undefined; /** Scopes allowed for this client grant. */ scope?: string[] | undefined; organization_usage?: Management.ClientGrantOrganizationUsageEnum | undefined; /** If enabled, any organization can be used with this grant. If disabled (default), the grant must be explicitly assigned to the desired organizations. */ allow_any_organization?: boolean | undefined; /** Applies this client grant as the default for all clients in the specified group. The only accepted value is `third_party_clients`, which applies the grant to all third-party clients. Per-client grants for the same audience take precedence. Mutually exclusive with `client_id`. */ default_for?: Management.ClientGrantDefaultForEnum | undefined; /** If enabled, this grant is a special grant created by Auth0. It cannot be modified or deleted directly. */ is_system?: boolean | undefined; subject_type?: Management.ClientGrantSubjectTypeEnum | undefined; /** Types of authorization_details allowed for this client grant. */ authorization_details_types?: string[] | undefined; /** If enabled, all scopes configured on the resource server are allowed for this grant. */ allow_all_scopes?: boolean | undefined; } export interface CreateClientResponseContent { /** ID of this client. */ client_id?: string | undefined; /** Name of the tenant this client belongs to. */ tenant?: string | undefined; /** Name of this client (min length: 1 character, does not allow `<` or `>`). */ name?: string | undefined; /** Free text description of this client (max length: 140 characters). */ description?: string | undefined; /** Whether this is your global 'All Applications' client representing legacy tenant settings (true) or a regular client (false). */ global?: boolean | undefined; /** Client secret (which you must not make public). */ client_secret?: string | undefined; app_type?: Management.ClientAppTypeEnum | undefined; /** URL of the logo to display for this client. Recommended size is 150x150 pixels. */ logo_uri?: string | undefined; /** Whether this client a first party client (true) or not (false). */ is_first_party?: boolean | undefined; /** Whether this client conforms to strict OIDC specifications (true) or uses legacy features (false). */ oidc_conformant?: boolean | undefined; /** Comma-separated list of URLs whitelisted for Auth0 to use as a callback to the client after authentication. */ callbacks?: string[] | undefined; /** Comma-separated list of URLs allowed to make requests from JavaScript to Auth0 API (typically used with CORS). By default, all your callback URLs will be allowed. This field allows you to enter other origins if necessary. You can also use wildcards at the subdomain level (e.g., https://*.contoso.com). Query strings and hash information are not taken into account when validating these URLs. */ allowed_origins?: string[] | undefined; /** Comma-separated list of allowed origins for use with Cross-Origin Authentication, Device Flow, and web message response mode. */ web_origins?: string[] | undefined; /** List of audiences/realms for SAML protocol. Used by the wsfed addon. */ client_aliases?: string[] | undefined; /** List of allow clients and API ids that are allowed to make delegation requests. Empty means all all your clients are allowed. */ allowed_clients?: string[] | undefined; /** Comma-separated list of URLs that are valid to redirect to after logout from Auth0. Wildcards are allowed for subdomains. */ allowed_logout_urls?: string[] | undefined; session_transfer?: (Management.ClientSessionTransferConfiguration | null) | undefined; oidc_logout?: Management.ClientOidcBackchannelLogoutSettings | undefined; /** List of grant types supported for this application. Can include `authorization_code`, `implicit`, `refresh_token`, `client_credentials`, `password`, `http://auth0.com/oauth/grant-type/password-realm`, `http://auth0.com/oauth/grant-type/mfa-oob`, `http://auth0.com/oauth/grant-type/mfa-otp`, `http://auth0.com/oauth/grant-type/mfa-recovery-code`, `urn:openid:params:grant-type:ciba`, `urn:ietf:params:oauth:grant-type:device_code`, and `urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token`. */ grant_types?: string[] | undefined; jwt_configuration?: Management.ClientJwtConfiguration | undefined; signing_keys?: ((Management.ClientSigningKeys | undefined) | null) | undefined; encryption_key?: (Management.ClientEncryptionKey | null) | undefined; /** Applies only to SSO clients and determines whether Auth0 will handle Single Sign On (true) or whether the Identity Provider will (false). */ sso?: boolean | undefined; /** Whether Single Sign On is disabled (true) or enabled (true). Defaults to true. */ sso_disabled?: boolean | undefined; /** Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false). */ cross_origin_authentication?: boolean | undefined; /** URL of the location in your site where the cross origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page. */ cross_origin_loc?: string | undefined; /** Whether a custom login page is to be used (true) or the default provided login page (false). */ custom_login_page_on?: boolean | undefined; /** The content (HTML, CSS, JS) of the custom login page. */ custom_login_page?: string | undefined; /** The content (HTML, CSS, JS) of the custom login page. (Used on Previews) */ custom_login_page_preview?: string | undefined; /** HTML form template to be used for WS-Federation. */ form_template?: string | undefined; addons?: Management.ClientAddons | undefined; token_endpoint_auth_method?: Management.ClientTokenEndpointAuthMethodEnum | undefined; /** If true, trust that the IP specified in the `auth0-forwarded-for` header is the end-user's IP for brute-force-protection on token endpoint. */ is_token_endpoint_ip_header_trusted?: boolean | undefined; client_metadata?: Management.ClientMetadata | undefined; mobile?: Management.ClientMobile | undefined; /** Initiate login uri, must be https */ initiate_login_uri?: string | undefined; refresh_token?: (Management.ClientRefreshTokenConfiguration | null) | undefined; default_organization?: (Management.ClientDefaultOrganization | null) | undefined; organization_usage?: Management.ClientOrganizationUsageEnum | undefined; organization_require_behavior?: Management.ClientOrganizationRequireBehaviorEnum | undefined; /** Defines the available methods for organization discovery during the `pre_login_prompt`. Users can discover their organization either by `email`, `organization_name` or both. */ organization_discovery_methods?: Management.ClientOrganizationDiscoveryEnum[] | undefined; client_authentication_methods?: (Management.ClientAuthenticationMethod | null) | undefined; /** Makes the use of Pushed Authorization Requests mandatory for this client */ require_pushed_authorization_requests?: boolean | undefined; /** Makes the use of Proof-of-Possession mandatory for this client */ require_proof_of_possession?: boolean | undefined; signed_request_object?: Management.ClientSignedRequestObjectWithCredentialId | undefined; compliance_level?: (Management.ClientComplianceLevelEnum | null) | undefined; /** * Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as `myapp://`, or `localhost`). * If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps. * See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information. */ skip_non_verifiable_callback_uri_confirmation_prompt?: boolean | undefined; token_exchange?: Management.ClientTokenExchangeConfiguration | undefined; /** Specifies how long, in seconds, a Pushed Authorization Request URI remains valid */ par_request_expiry?: (number | null) | undefined; token_quota?: Management.TokenQuota | undefined; express_configuration?: Management.ExpressConfiguration | undefined; my_organization_configuration?: Management.ClientMyOrganizationResponseConfiguration | undefined; third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum | undefined; redirection_policy?: Management.ClientRedirectionPolicyEnum | undefined; /** The identifier of the resource server that this client is linked to. */ resource_server_identifier?: string | undefined; async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPostConfiguration | undefined; external_metadata_type?: Management.ClientExternalMetadataTypeEnum | undefined; external_metadata_created_by?: Management.ClientExternalMetadataCreatedByEnum | undefined; /** An alternate client identifier to be used during authorization flows. Only supports CIMD-based client identifiers. */ external_client_id?: string | undefined; /** URL for the JSON Web Key Set (JWKS) containing the public keys used for private_key_jwt authentication. Only present for CIMD clients using private_key_jwt authentication. */ jwks_uri?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface CreateConnectionCommon { name: Management.ConnectionName; /** Use of this property is NOT RECOMMENDED. Use the PATCH /v2/connections/{id}/clients endpoint to enable the connection for a set of clients. */ enabled_clients?: string[] | undefined; display_name?: Management.ConnectionDisplayName | undefined; is_domain_connection?: Management.ConnectionIsDomainConnection | undefined; metadata?: Management.ConnectionsMetadata | undefined; } export interface CreateConnectionProfileResponseContent { id?: Management.ConnectionProfileId | undefined; name?: Management.ConnectionProfileName | undefined; organization?: Management.ConnectionProfileOrganization | undefined; connection_name_prefix_template?: Management.ConnectionNamePrefixTemplate | undefined; enabled_features?: Management.ConnectionProfileEnabledFeatures | undefined; connection_config?: Management.ConnectionProfileConfig | undefined; strategy_overrides?: Management.ConnectionProfileStrategyOverrides | undefined; } /** * Create a connection with strategy=ad */ export interface CreateConnectionRequestContentAd extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentAd.Strategy; options?: Management.ConnectionOptionsAd | undefined; } export declare namespace CreateConnectionRequestContentAd { const Strategy: { readonly Ad: "ad"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=adfs */ export interface CreateConnectionRequestContentAdfs extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentAdfs.Strategy; options?: Management.ConnectionOptionsAdfs | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace CreateConnectionRequestContentAdfs { const Strategy: { readonly Adfs: "adfs"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=amazon */ export interface CreateConnectionRequestContentAmazon extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentAmazon.Strategy; options?: Management.ConnectionOptionsAmazon | undefined; } export declare namespace CreateConnectionRequestContentAmazon { const Strategy: { readonly Amazon: "amazon"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=apple */ export interface CreateConnectionRequestContentApple extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentApple.Strategy; options?: Management.ConnectionOptionsApple | undefined; } export declare namespace CreateConnectionRequestContentApple { const Strategy: { readonly Apple: "apple"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=auth0 */ export interface CreateConnectionRequestContentAuth0 extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentAuth0.Strategy; options?: Management.ConnectionOptionsAuth0 | undefined; realms?: Management.ConnectionRealms | undefined; } export declare namespace CreateConnectionRequestContentAuth0 { const Strategy: { readonly Auth0: "auth0"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=auth0-oidc */ export interface CreateConnectionRequestContentAuth0Oidc extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentAuth0Oidc.Strategy; options?: Management.ConnectionOptionsAuth0Oidc | undefined; } export declare namespace CreateConnectionRequestContentAuth0Oidc { const Strategy: { readonly Auth0Oidc: "auth0-oidc"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=waad */ export interface CreateConnectionRequestContentAzureAd extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentAzureAd.Strategy; options?: Management.ConnectionOptionsAzureAd | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace CreateConnectionRequestContentAzureAd { const Strategy: { readonly Waad: "waad"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=baidu */ export interface CreateConnectionRequestContentBaidu extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentBaidu.Strategy; options?: Management.ConnectionOptionsBaidu | undefined; } export declare namespace CreateConnectionRequestContentBaidu { const Strategy: { readonly Baidu: "baidu"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=bitbucket */ export interface CreateConnectionRequestContentBitbucket extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentBitbucket.Strategy; options?: Management.ConnectionOptionsBitbucket | undefined; } export declare namespace CreateConnectionRequestContentBitbucket { const Strategy: { readonly Bitbucket: "bitbucket"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=bitly */ export interface CreateConnectionRequestContentBitly extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentBitly.Strategy; options?: Management.ConnectionOptionsBitly | undefined; } export declare namespace CreateConnectionRequestContentBitly { const Strategy: { readonly Bitly: "bitly"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=box */ export interface CreateConnectionRequestContentBox extends Management.ConnectionPurposes, Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentBox.Strategy; options?: Management.ConnectionOptionsBox | undefined; } export declare namespace CreateConnectionRequestContentBox { const Strategy: { readonly Box: "box"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=custom */ export interface CreateConnectionRequestContentCustom extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentCustom.Strategy; options?: Management.ConnectionOptionsCustom | undefined; } export declare namespace CreateConnectionRequestContentCustom { const Strategy: { readonly Custom: "custom"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=daccount */ export interface CreateConnectionRequestContentDaccount extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentDaccount.Strategy; options?: Management.ConnectionOptionsDaccount | undefined; } export declare namespace CreateConnectionRequestContentDaccount { const Strategy: { readonly Daccount: "daccount"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=dropbox */ export interface CreateConnectionRequestContentDropbox extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentDropbox.Strategy; options?: Management.ConnectionOptionsDropbox | undefined; } export declare namespace CreateConnectionRequestContentDropbox { const Strategy: { readonly Dropbox: "dropbox"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=dwolla */ export interface CreateConnectionRequestContentDwolla extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentDwolla.Strategy; options?: Management.ConnectionOptionsDwolla | undefined; } export declare namespace CreateConnectionRequestContentDwolla { const Strategy: { readonly Dwolla: "dwolla"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=email */ export interface CreateConnectionRequestContentEmail extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentEmail.Strategy; options?: Management.ConnectionOptionsEmail | undefined; } export declare namespace CreateConnectionRequestContentEmail { const Strategy: { readonly Email: "email"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=evernote */ export interface CreateConnectionRequestContentEvernote extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentEvernote.Strategy; options?: Management.ConnectionOptionsEvernote | undefined; } export declare namespace CreateConnectionRequestContentEvernote { const Strategy: { readonly Evernote: "evernote"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=evernote-sandbox */ export interface CreateConnectionRequestContentEvernoteSandbox extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentEvernoteSandbox.Strategy; options?: Management.ConnectionOptionsEvernote | undefined; } export declare namespace CreateConnectionRequestContentEvernoteSandbox { const Strategy: { readonly EvernoteSandbox: "evernote-sandbox"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=exact */ export interface CreateConnectionRequestContentExact extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentExact.Strategy; options?: Management.ConnectionOptionsExact | undefined; } export declare namespace CreateConnectionRequestContentExact { const Strategy: { readonly Exact: "exact"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=facebook */ export interface CreateConnectionRequestContentFacebook extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentFacebook.Strategy; options?: Management.ConnectionOptionsFacebook | undefined; } export declare namespace CreateConnectionRequestContentFacebook { const Strategy: { readonly Facebook: "facebook"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=fitbit */ export interface CreateConnectionRequestContentFitbit extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentFitbit.Strategy; options?: Management.ConnectionOptionsFitbit | undefined; } export declare namespace CreateConnectionRequestContentFitbit { const Strategy: { readonly Fitbit: "fitbit"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=github */ export interface CreateConnectionRequestContentGitHub extends Management.ConnectionPurposes, Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentGitHub.Strategy; options?: Management.ConnectionOptionsGitHub | undefined; } export declare namespace CreateConnectionRequestContentGitHub { const Strategy: { readonly Github: "github"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=google-apps */ export interface CreateConnectionRequestContentGoogleApps extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentGoogleApps.Strategy; options?: Management.ConnectionOptionsGoogleApps | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace CreateConnectionRequestContentGoogleApps { const Strategy: { readonly GoogleApps: "google-apps"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=google-oauth2 */ export interface CreateConnectionRequestContentGoogleOAuth2 extends Management.ConnectionPurposes, Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentGoogleOAuth2.Strategy; options?: Management.ConnectionOptionsGoogleOAuth2 | undefined; } export declare namespace CreateConnectionRequestContentGoogleOAuth2 { const Strategy: { readonly GoogleOauth2: "google-oauth2"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=ip */ export interface CreateConnectionRequestContentIp extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentIp.Strategy; options?: Management.ConnectionOptionsIp | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace CreateConnectionRequestContentIp { const Strategy: { readonly Ip: "ip"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=instagram */ export interface CreateConnectionRequestContentInstagram extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentInstagram.Strategy; options?: Management.ConnectionOptionsInstagram | undefined; } export declare namespace CreateConnectionRequestContentInstagram { const Strategy: { readonly Instagram: "instagram"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=line */ export interface CreateConnectionRequestContentLine extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentLine.Strategy; options?: Management.ConnectionOptionsLine | undefined; } export declare namespace CreateConnectionRequestContentLine { const Strategy: { readonly Line: "line"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=linkedin */ export interface CreateConnectionRequestContentLinkedin extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentLinkedin.Strategy; options?: Management.ConnectionOptionsLinkedin | undefined; } export declare namespace CreateConnectionRequestContentLinkedin { const Strategy: { readonly Linkedin: "linkedin"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=oauth1 */ export interface CreateConnectionRequestContentOAuth1 extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentOAuth1.Strategy; options?: Management.ConnectionOptionsOAuth1 | undefined; } export declare namespace CreateConnectionRequestContentOAuth1 { const Strategy: { readonly Oauth1: "oauth1"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=oauth2 */ export interface CreateConnectionRequestContentOAuth2 extends Management.ConnectionPurposes, Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentOAuth2.Strategy; options?: Management.ConnectionOptionsOAuth2 | undefined; } export declare namespace CreateConnectionRequestContentOAuth2 { const Strategy: { readonly Oauth2: "oauth2"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=oidc */ export interface CreateConnectionRequestContentOidc extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentOidc.Strategy; authentication?: Management.ConnectionAuthenticationPurpose | undefined; connected_accounts?: Management.ConnectionConnectedAccountsPurposeXaa | undefined; options?: Management.ConnectionOptionsOidc | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace CreateConnectionRequestContentOidc { const Strategy: { readonly Oidc: "oidc"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=office365 */ export interface CreateConnectionRequestContentOffice365 extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentOffice365.Strategy; options?: Management.ConnectionOptionsOffice365 | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace CreateConnectionRequestContentOffice365 { const Strategy: { readonly Office365: "office365"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=okta */ export interface CreateConnectionRequestContentOkta extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentOkta.Strategy; options?: Management.ConnectionOptionsOkta | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace CreateConnectionRequestContentOkta { const Strategy: { readonly Okta: "okta"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=paypal */ export interface CreateConnectionRequestContentPaypal extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentPaypal.Strategy; options?: Management.ConnectionOptionsPaypal | undefined; } export declare namespace CreateConnectionRequestContentPaypal { const Strategy: { readonly Paypal: "paypal"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=paypal-sandbox */ export interface CreateConnectionRequestContentPaypalSandbox extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentPaypalSandbox.Strategy; options?: Management.ConnectionOptionsPaypal | undefined; } export declare namespace CreateConnectionRequestContentPaypalSandbox { const Strategy: { readonly PaypalSandbox: "paypal-sandbox"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=pingfederate */ export interface CreateConnectionRequestContentPingFederate extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentPingFederate.Strategy; options?: Management.ConnectionOptionsPingFederate | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace CreateConnectionRequestContentPingFederate { const Strategy: { readonly Pingfederate: "pingfederate"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=planningcenter */ export interface CreateConnectionRequestContentPlanningCenter extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentPlanningCenter.Strategy; options?: Management.ConnectionOptionsPlanningCenter | undefined; } export declare namespace CreateConnectionRequestContentPlanningCenter { const Strategy: { readonly Planningcenter: "planningcenter"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=samlp */ export interface CreateConnectionRequestContentSaml extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentSaml.Strategy; options?: Management.ConnectionOptionsSaml | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace CreateConnectionRequestContentSaml { const Strategy: { readonly Samlp: "samlp"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=sms */ export interface CreateConnectionRequestContentSms extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentSms.Strategy; options?: Management.ConnectionOptionsSms | undefined; } export declare namespace CreateConnectionRequestContentSms { const Strategy: { readonly Sms: "sms"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=salesforce */ export interface CreateConnectionRequestContentSalesforce extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentSalesforce.Strategy; options?: Management.ConnectionOptionsSalesforce | undefined; } export declare namespace CreateConnectionRequestContentSalesforce { const Strategy: { readonly Salesforce: "salesforce"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=salesforce-community */ export interface CreateConnectionRequestContentSalesforceCommunity extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentSalesforceCommunity.Strategy; options?: Management.ConnectionOptionsSalesforceCommunity | undefined; } export declare namespace CreateConnectionRequestContentSalesforceCommunity { const Strategy: { readonly SalesforceCommunity: "salesforce-community"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=salesforce-sandbox */ export interface CreateConnectionRequestContentSalesforceSandbox extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentSalesforceSandbox.Strategy; options?: Management.ConnectionOptionsSalesforce | undefined; } export declare namespace CreateConnectionRequestContentSalesforceSandbox { const Strategy: { readonly SalesforceSandbox: "salesforce-sandbox"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=sharepoint */ export interface CreateConnectionRequestContentSharepoint extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentSharepoint.Strategy; options?: Management.ConnectionOptionsSharepoint | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } export declare namespace CreateConnectionRequestContentSharepoint { const Strategy: { readonly Sharepoint: "sharepoint"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=shop */ export interface CreateConnectionRequestContentShop extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentShop.Strategy; options?: Management.ConnectionOptionsShop | undefined; } export declare namespace CreateConnectionRequestContentShop { const Strategy: { readonly Shop: "shop"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=shopify */ export interface CreateConnectionRequestContentShopify extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentShopify.Strategy; options?: Management.ConnectionOptionsShopify | undefined; } export declare namespace CreateConnectionRequestContentShopify { const Strategy: { readonly Shopify: "shopify"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=soundcloud */ export interface CreateConnectionRequestContentSoundcloud extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentSoundcloud.Strategy; options?: Management.ConnectionOptionsSoundcloud | undefined; } export declare namespace CreateConnectionRequestContentSoundcloud { const Strategy: { readonly Soundcloud: "soundcloud"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=thirtysevensignals */ export interface CreateConnectionRequestContentThirtySevenSignals extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentThirtySevenSignals.Strategy; options?: Management.ConnectionOptionsThirtySevenSignals | undefined; } export declare namespace CreateConnectionRequestContentThirtySevenSignals { const Strategy: { readonly Thirtysevensignals: "thirtysevensignals"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=twitter */ export interface CreateConnectionRequestContentTwitter extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentTwitter.Strategy; options?: Management.ConnectionOptionsTwitter | undefined; } export declare namespace CreateConnectionRequestContentTwitter { const Strategy: { readonly Twitter: "twitter"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=untappd */ export interface CreateConnectionRequestContentUntappd extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentUntappd.Strategy; options?: Management.ConnectionOptionsUntappd | undefined; } export declare namespace CreateConnectionRequestContentUntappd { const Strategy: { readonly Untappd: "untappd"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=vkontakte */ export interface CreateConnectionRequestContentVkontakte extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentVkontakte.Strategy; options?: Management.ConnectionOptionsVkontakte | undefined; } export declare namespace CreateConnectionRequestContentVkontakte { const Strategy: { readonly Vkontakte: "vkontakte"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=weibo */ export interface CreateConnectionRequestContentWeibo extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentWeibo.Strategy; options?: Management.ConnectionOptionsWeibo | undefined; } export declare namespace CreateConnectionRequestContentWeibo { const Strategy: { readonly Weibo: "weibo"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=windowslive */ export interface CreateConnectionRequestContentWindowsLive extends Management.ConnectionPurposes, Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentWindowsLive.Strategy; options?: Management.ConnectionOptionsWindowsLive | undefined; } export declare namespace CreateConnectionRequestContentWindowsLive { const Strategy: { readonly Windowslive: "windowslive"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=wordpress */ export interface CreateConnectionRequestContentWordpress extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentWordpress.Strategy; options?: Management.ConnectionOptionsWordpress | undefined; } export declare namespace CreateConnectionRequestContentWordpress { const Strategy: { readonly Wordpress: "wordpress"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=yahoo */ export interface CreateConnectionRequestContentYahoo extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentYahoo.Strategy; options?: Management.ConnectionOptionsYahoo | undefined; } export declare namespace CreateConnectionRequestContentYahoo { const Strategy: { readonly Yahoo: "yahoo"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } /** * Create a connection with strategy=yandex */ export interface CreateConnectionRequestContentYandex extends Management.CreateConnectionCommon { strategy: CreateConnectionRequestContentYandex.Strategy; options?: Management.ConnectionOptionsYandex | undefined; } export declare namespace CreateConnectionRequestContentYandex { const Strategy: { readonly Yandex: "yandex"; }; type Strategy = (typeof Strategy)[keyof typeof Strategy]; } export interface CreateConnectionResponseContent { /** The name of the connection */ name?: string | undefined; /** Connection name used in login screen */ display_name?: string | undefined; options?: Management.ConnectionOptions | undefined; /** The connection's identifier */ id?: string | undefined; /** The type of the connection, related to the identity provider */ strategy?: string | undefined; /** Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm. */ realms?: string[] | undefined; /** DEPRECATED property. Use the GET /connections/:id/clients endpoint to get the ids of the clients for which the connection is enabled */ enabled_clients?: string[] | undefined; /** True if the connection is domain level */ is_domain_connection?: boolean | undefined; /** Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. */ show_as_button?: boolean | undefined; metadata?: Management.ConnectionsMetadata | undefined; authentication?: Management.ConnectionAuthenticationPurpose | undefined; connected_accounts?: Management.ConnectionConnectedAccountsPurpose | undefined; } export interface CreateCustomDomainResponseContent { /** ID of the custom domain. */ custom_domain_id: string; /** Domain name. */ domain: string; /** Whether this is a primary domain (true) or not (false). */ primary: boolean; /** Whether this is the default custom domain (true) or not (false). */ is_default?: boolean | undefined; status: Management.CustomDomainStatusFilterEnum; type: Management.CustomDomainTypeEnum; verification: Management.DomainVerification; /** The HTTP header to fetch the client's IP address */ custom_client_ip_header?: (string | null) | undefined; /** The TLS version policy */ tls_policy?: string | undefined; domain_metadata?: Management.DomainMetadata | undefined; certificate?: Management.DomainCertificate | undefined; /** Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not present, the full domain will be used. */ relying_party_identifier?: string | undefined; } export interface CreateDirectoryProvisioningRequestContent { /** The mapping between Auth0 and IDP user attributes */ mapping?: Management.DirectoryProvisioningMappingItem[] | undefined; /** Whether periodic automatic synchronization is enabled */ synchronize_automatically?: boolean | undefined; synchronize_groups?: Management.SynchronizeGroupsEnum | undefined; } export interface CreateDirectoryProvisioningResponseContent { /** The connection's identifier */ connection_id: string; /** The connection's name */ connection_name: string; /** The connection's strategy */ strategy: string; /** The mapping between Auth0 and IDP user attributes */ mapping: Management.DirectoryProvisioningMappingItem[]; /** Whether periodic automatic synchronization is enabled */ synchronize_automatically: boolean; synchronize_groups?: Management.SynchronizeGroupsEnum | undefined; /** The timestamp at which the directory provisioning configuration was created */ created_at: string; /** The timestamp at which the directory provisioning configuration was last updated */ updated_at: string; /** The timestamp at which the connection was last synchronized */ last_synchronization_at?: string | undefined; /** The status of the last synchronization */ last_synchronization_status?: string | undefined; /** The error message of the last synchronization, if any */ last_synchronization_error?: string | undefined; } export interface CreateDirectorySynchronizationResponseContent { /** The connection's identifier */ connection_id: string; /** The synchronization's identifier */ synchronization_id: string; /** The synchronization status */ status: string; } export interface CreateEmailProviderResponseContent { /** Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, `ms365`, or `custom`. */ name?: string | undefined; /** Whether the provider is enabled (true) or disabled (false). */ enabled?: boolean | undefined; /** Email address to use as "from" when no other address specified. */ default_from_address?: string | undefined; credentials?: Management.EmailProviderCredentials | undefined; settings?: Management.EmailProviderSettings | undefined; } export interface CreateEmailTemplateResponseContent { template: Management.EmailTemplateNameEnum; /** Body of the email template. */ body?: (string | null) | undefined; /** Senders `from` email address. */ from?: (string | null) | undefined; /** URL to redirect the user to after a successful action. */ resultUrl?: (string | null) | undefined; /** Subject line of the email. */ subject?: (string | null) | undefined; /** Syntax of the template body. */ syntax?: (string | null) | undefined; /** Lifetime in seconds that the link within the email will be valid for. */ urlLifetimeInSeconds?: (number | null) | undefined; /** Whether the `reset_email` and `verify_email` templates should include the user's email address as the `email` parameter in the returnUrl (true) or whether no email address should be included in the redirect (false). Defaults to true. */ includeEmailInRedirect?: boolean | undefined; /** Whether the template is enabled (true) or disabled (false). */ enabled?: (boolean | null) | undefined; } export interface CreateEncryptionKeyPublicWrappingResponseContent { /** Public wrapping key in PEM format */ public_key: string; algorithm: Management.EncryptionKeyPublicWrappingAlgorithm; /** Accepts any additional properties */ [key: string]: any; } /** * Encryption key */ export interface CreateEncryptionKeyResponseContent { /** Key ID */ kid: string; type: Management.EncryptionKeyType; state: Management.EncryptionKeyState; /** Key creation timestamp */ created_at: string; /** Key update timestamp */ updated_at: string; /** ID of parent wrapping key */ parent_kid?: (string | null) | undefined; /** Public key in PEM format */ public_key?: (string | null) | undefined; } /** Type of the encryption key to be created. */ export declare const CreateEncryptionKeyType: { readonly CustomerProvidedRootKey: "customer-provided-root-key"; readonly TenantEncryptionKey: "tenant-encryption-key"; }; export type CreateEncryptionKeyType = (typeof CreateEncryptionKeyType)[keyof typeof CreateEncryptionKeyType]; export interface CreateEventStreamActionRequestContent { /** Name of the event stream. */ name?: string | undefined; /** List of event types subscribed to in this stream. */ subscriptions?: Management.EventStreamSubscription[] | undefined; destination: Management.EventStreamActionDestination; status?: Management.EventStreamStatusEnum | undefined; } export interface CreateEventStreamEventBridgeRequestContent { /** Name of the event stream. */ name?: string | undefined; /** List of event types subscribed to in this stream. */ subscriptions?: Management.EventStreamSubscription[] | undefined; destination: Management.EventStreamEventBridgeDestination; status?: Management.EventStreamStatusEnum | undefined; } export interface CreateEventStreamRedeliveryResponseContent { /** An RFC-3339 date-time for redelivery start, inclusive. Does not allow sub-second precision. */ date_from?: string | undefined; /** An RFC-3339 date-time for redelivery end, exclusive. Does not allow sub-second precision. */ date_to?: string | undefined; /** Filter by status */ statuses?: Management.EventStreamDeliveryStatusEnum[] | undefined; /** Filter by event type */ event_types?: Management.EventStreamEventTypeEnum[] | undefined; } export type CreateEventStreamResponseContent = Management.EventStreamWebhookResponseContent | Management.EventStreamEventBridgeResponseContent | Management.EventStreamActionResponseContent; /** * Metadata about a specific attempt to deliver an event */ export interface CreateEventStreamTestEventResponseContent { /** Unique identifier for the delivery */ id: string; /** Unique identifier for the event stream. */ event_stream_id: string; status: Management.EventStreamDeliveryStatusEnum; event_type: Management.EventStreamDeliveryEventTypeEnum; /** Results of delivery attempts */ attempts: Management.EventStreamDeliveryAttempt[]; event?: Management.EventStreamCloudEvent | undefined; } export interface CreateEventStreamWebHookRequestContent { /** Name of the event stream. */ name?: string | undefined; /** List of event types subscribed to in this stream. */ subscriptions?: Management.EventStreamSubscription[] | undefined; destination: Management.EventStreamWebhookDestination; status?: Management.EventStreamStatusEnum | undefined; } export interface CreateExportUsersFields { /** Name of the field in the profile. */ name: string; /** Title of the column in the exported CSV. */ export_as?: string | undefined; } export interface CreateExportUsersResponseContent { /** Status of this job. */ status: string; /** Type of job this is. */ type: string; /** When this job was created. */ created_at?: string | undefined; /** ID of this job. */ id: string; /** connection_id of the connection from which users will be exported. */ connection_id?: string | undefined; format?: Management.JobFileFormatEnum | undefined; /** Limit the number of records. */ limit?: number | undefined; /** List of fields to be included in the CSV. Defaults to a predefined set of fields. */ fields?: Management.CreateExportUsersFields[] | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface CreateFlowResponseContent { id: string; name: string; actions?: Management.FlowAction[] | undefined; created_at: string; updated_at: string; executed_at?: string | undefined; } export type CreateFlowsVaultConnectionActivecampaign = Management.CreateFlowsVaultConnectionActivecampaignApiKey | Management.CreateFlowsVaultConnectionActivecampaignUninitialized; export interface CreateFlowsVaultConnectionActivecampaignApiKey { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdActivecampaignEnum; setup: Management.FlowsVaultConnectioSetupApiKeyWithBaseUrl; } export interface CreateFlowsVaultConnectionActivecampaignUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdActivecampaignEnum; } export type CreateFlowsVaultConnectionAirtable = Management.CreateFlowsVaultConnectionAirtableApiKey | Management.CreateFlowsVaultConnectionAirtableUninitialized; export interface CreateFlowsVaultConnectionAirtableApiKey { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdAirtableEnum; setup: Management.FlowsVaultConnectioSetupApiKey; } export interface CreateFlowsVaultConnectionAirtableUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdAirtableEnum; } export type CreateFlowsVaultConnectionAuth0 = Management.CreateFlowsVaultConnectionAuth0OauthApp | Management.CreateFlowsVaultConnectionAuth0Uninitialized; export interface CreateFlowsVaultConnectionAuth0OauthApp { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdAuth0Enum; setup: Management.FlowsVaultConnectioSetupOauthApp; } export interface CreateFlowsVaultConnectionAuth0Uninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdAuth0Enum; } export type CreateFlowsVaultConnectionBigquery = Management.CreateFlowsVaultConnectionBigqueryJwt | Management.CreateFlowsVaultConnectionBigqueryUninitialized; export interface CreateFlowsVaultConnectionBigqueryJwt { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdBigqueryEnum; setup: Management.FlowsVaultConnectioSetupBigqueryOauthJwt; } export interface CreateFlowsVaultConnectionBigqueryUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdBigqueryEnum; } export type CreateFlowsVaultConnectionClearbit = Management.CreateFlowsVaultConnectionClearbitApiKey | Management.CreateFlowsVaultConnectionClearbitUninitialized; export interface CreateFlowsVaultConnectionClearbitApiKey { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdClearbitEnum; setup: Management.FlowsVaultConnectioSetupSecretApiKey; } export interface CreateFlowsVaultConnectionClearbitUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdClearbitEnum; } export type CreateFlowsVaultConnectionDocusign = Management.CreateFlowsVaultConnectionDocusignOauthCode | Management.CreateFlowsVaultConnectionDocusignUninitialized; export interface CreateFlowsVaultConnectionDocusignOauthCode { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdDocusignEnum; setup: Management.FlowsVaultConnectioSetupOauthCode; } export interface CreateFlowsVaultConnectionDocusignUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdDocusignEnum; } export type CreateFlowsVaultConnectionGoogleSheets = Management.CreateFlowsVaultConnectionGoogleSheetsOauthCode | Management.CreateFlowsVaultConnectionGoogleSheetsUninitialized; export interface CreateFlowsVaultConnectionGoogleSheetsOauthCode { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdGoogleSheetsEnum; setup: Management.FlowsVaultConnectioSetupOauthCode; } export interface CreateFlowsVaultConnectionGoogleSheetsUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdGoogleSheetsEnum; } export type CreateFlowsVaultConnectionHttp = Management.CreateFlowsVaultConnectionHttpBearer | Management.CreateFlowsVaultConnectionHttpBasicAuth | Management.CreateFlowsVaultConnectionHttpApiKey | Management.CreateFlowsVaultConnectionHttpOauthClientCredentials | Management.CreateFlowsVaultConnectionHttpUninitialized; export interface CreateFlowsVaultConnectionHttpApiKey { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdHttpEnum; setup: Management.FlowsVaultConnectionHttpApiKeySetup; } export interface CreateFlowsVaultConnectionHttpBasicAuth { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdHttpEnum; setup: Management.FlowsVaultConnectionHttpBasicAuthSetup; } export interface CreateFlowsVaultConnectionHttpBearer { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdHttpEnum; setup: Management.FlowsVaultConnectioSetupHttpBearer; } export interface CreateFlowsVaultConnectionHttpOauthClientCredentials { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdHttpEnum; setup: Management.FlowsVaultConnectionHttpOauthClientCredentialsSetup; } export interface CreateFlowsVaultConnectionHttpUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdHttpEnum; } export type CreateFlowsVaultConnectionHubspot = Management.CreateFlowsVaultConnectionHubspotApiKey | Management.CreateFlowsVaultConnectionHubspotOauthCode | Management.CreateFlowsVaultConnectionHubspotUninitialized; export interface CreateFlowsVaultConnectionHubspotApiKey { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdHubspotEnum; setup: Management.FlowsVaultConnectioSetupApiKey; } export interface CreateFlowsVaultConnectionHubspotOauthCode { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdHubspotEnum; setup: Management.FlowsVaultConnectioSetupOauthCode; } export interface CreateFlowsVaultConnectionHubspotUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdHubspotEnum; } export type CreateFlowsVaultConnectionJwt = Management.CreateFlowsVaultConnectionJwtJwt | Management.CreateFlowsVaultConnectionJwtUninitialized; export interface CreateFlowsVaultConnectionJwtJwt { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdJwtEnum; setup: Management.FlowsVaultConnectioSetupJwt; } export interface CreateFlowsVaultConnectionJwtUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdJwtEnum; } export type CreateFlowsVaultConnectionMailchimp = Management.CreateFlowsVaultConnectionMailchimpApiKey | Management.CreateFlowsVaultConnectionMailchimpOauthCode | Management.CreateFlowsVaultConnectionMailchimpUninitialized; export interface CreateFlowsVaultConnectionMailchimpApiKey { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdMailchimpEnum; setup: Management.FlowsVaultConnectioSetupSecretApiKey; } export interface CreateFlowsVaultConnectionMailchimpOauthCode { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdMailchimpEnum; setup: Management.FlowsVaultConnectioSetupOauthCode; } export interface CreateFlowsVaultConnectionMailchimpUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdMailchimpEnum; } export type CreateFlowsVaultConnectionMailjet = Management.CreateFlowsVaultConnectionMailjetApiKey | Management.CreateFlowsVaultConnectionMailjetUninitialized; export interface CreateFlowsVaultConnectionMailjetApiKey { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdMailjetEnum; setup: Management.FlowsVaultConnectioSetupMailjetApiKey; } export interface CreateFlowsVaultConnectionMailjetUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdMailjetEnum; } export type CreateFlowsVaultConnectionPipedrive = Management.CreateFlowsVaultConnectionPipedriveToken | Management.CreateFlowsVaultConnectionPipedriveOauthCode | Management.CreateFlowsVaultConnectionPipedriveUninitialized; export interface CreateFlowsVaultConnectionPipedriveOauthCode { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdPipedriveEnum; setup: Management.FlowsVaultConnectioSetupOauthCode; } export interface CreateFlowsVaultConnectionPipedriveToken { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdPipedriveEnum; setup: Management.FlowsVaultConnectioSetupToken; } export interface CreateFlowsVaultConnectionPipedriveUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdPipedriveEnum; } export type CreateFlowsVaultConnectionRequestContent = Management.CreateFlowsVaultConnectionActivecampaign | Management.CreateFlowsVaultConnectionAirtable | Management.CreateFlowsVaultConnectionAuth0 | Management.CreateFlowsVaultConnectionBigquery | Management.CreateFlowsVaultConnectionClearbit | Management.CreateFlowsVaultConnectionDocusign | Management.CreateFlowsVaultConnectionGoogleSheets | Management.CreateFlowsVaultConnectionHttp | Management.CreateFlowsVaultConnectionHubspot | Management.CreateFlowsVaultConnectionJwt | Management.CreateFlowsVaultConnectionMailchimp | Management.CreateFlowsVaultConnectionMailjet | Management.CreateFlowsVaultConnectionPipedrive | Management.CreateFlowsVaultConnectionSalesforce | Management.CreateFlowsVaultConnectionSendgrid | Management.CreateFlowsVaultConnectionSlack | Management.CreateFlowsVaultConnectionStripe | Management.CreateFlowsVaultConnectionTelegram | Management.CreateFlowsVaultConnectionTwilio | Management.CreateFlowsVaultConnectionWhatsapp | Management.CreateFlowsVaultConnectionZapier; export interface CreateFlowsVaultConnectionResponseContent { /** Flows Vault Connection identifier. */ id: string; /** Flows Vault Connection app identifier. */ app_id: string; /** Flows Vault Connection environment. */ environment?: string | undefined; /** Flows Vault Connection name. */ name: string; /** Flows Vault Connection custom account name. */ account_name?: string | undefined; /** Whether the Flows Vault Connection is configured. */ ready: boolean; /** The ISO 8601 formatted date when this Flows Vault Connection was created. */ created_at: string; /** The ISO 8601 formatted date when this Flows Vault Connection was updated. */ updated_at: string; /** The ISO 8601 formatted date when this Flows Vault Connection was refreshed. */ refreshed_at?: string | undefined; fingerprint: string; } export type CreateFlowsVaultConnectionSalesforce = Management.CreateFlowsVaultConnectionSalesforceOauthCode | Management.CreateFlowsVaultConnectionSalesforceUninitialized; export interface CreateFlowsVaultConnectionSalesforceOauthCode { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdSalesforceEnum; setup: Management.FlowsVaultConnectioSetupOauthCode; } export interface CreateFlowsVaultConnectionSalesforceUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdSalesforceEnum; } export type CreateFlowsVaultConnectionSendgrid = Management.CreateFlowsVaultConnectionSendgridApiKey | Management.CreateFlowsVaultConnectionSendgridUninitialized; export interface CreateFlowsVaultConnectionSendgridApiKey { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdSendgridEnum; setup: Management.FlowsVaultConnectioSetupApiKey; } export interface CreateFlowsVaultConnectionSendgridUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdSendgridEnum; } export type CreateFlowsVaultConnectionSlack = Management.CreateFlowsVaultConnectionSlackWebhook | Management.CreateFlowsVaultConnectionSlackOauthCode | Management.CreateFlowsVaultConnectionSlackUninitialized; export interface CreateFlowsVaultConnectionSlackOauthCode { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdSlackEnum; setup: Management.FlowsVaultConnectioSetupOauthCode; } export interface CreateFlowsVaultConnectionSlackUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdSlackEnum; } export interface CreateFlowsVaultConnectionSlackWebhook { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdSlackEnum; setup: Management.FlowsVaultConnectioSetupWebhook; } export type CreateFlowsVaultConnectionStripe = Management.CreateFlowsVaultConnectionStripeKeyPair | Management.CreateFlowsVaultConnectionStripeOauthCode | Management.CreateFlowsVaultConnectionStripeUninitialized; export interface CreateFlowsVaultConnectionStripeKeyPair { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdStripeEnum; setup: Management.FlowsVaultConnectioSetupStripeKeyPair; } export interface CreateFlowsVaultConnectionStripeOauthCode { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdStripeEnum; setup: Management.FlowsVaultConnectioSetupOauthCode; } export interface CreateFlowsVaultConnectionStripeUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdStripeEnum; } export type CreateFlowsVaultConnectionTelegram = Management.CreateFlowsVaultConnectionTelegramToken | Management.CreateFlowsVaultConnectionTelegramUninitialized; export interface CreateFlowsVaultConnectionTelegramToken { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdTelegramEnum; setup: Management.FlowsVaultConnectioSetupToken; } export interface CreateFlowsVaultConnectionTelegramUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdTelegramEnum; } export type CreateFlowsVaultConnectionTwilio = Management.CreateFlowsVaultConnectionTwilioApiKey | Management.CreateFlowsVaultConnectionTwilioUninitialized; export interface CreateFlowsVaultConnectionTwilioApiKey { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdTwilioEnum; setup: Management.FlowsVaultConnectioSetupTwilioApiKey; } export interface CreateFlowsVaultConnectionTwilioUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdTwilioEnum; } export type CreateFlowsVaultConnectionWhatsapp = Management.CreateFlowsVaultConnectionWhatsappToken | Management.CreateFlowsVaultConnectionWhatsappUninitialized; export interface CreateFlowsVaultConnectionWhatsappToken { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdWhatsappEnum; setup: Management.FlowsVaultConnectioSetupToken; } export interface CreateFlowsVaultConnectionWhatsappUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdWhatsappEnum; } export type CreateFlowsVaultConnectionZapier = Management.CreateFlowsVaultConnectionZapierWebhook | Management.CreateFlowsVaultConnectionZapierUninitialized; export interface CreateFlowsVaultConnectionZapierUninitialized { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdZapierEnum; } export interface CreateFlowsVaultConnectionZapierWebhook { /** Flows Vault Connection name. */ name: string; app_id: Management.FlowsVaultConnectionAppIdZapierEnum; setup: Management.FlowsVaultConnectioSetupWebhook; } export interface CreateFormResponseContent { id: string; name: string; messages?: Management.FormMessages | undefined; languages?: Management.FormLanguages | undefined; translations?: Management.FormTranslations | undefined; nodes?: Management.FormNodeList | undefined; start?: Management.FormStartNode | undefined; ending?: Management.FormEndingNode | undefined; style?: Management.FormStyle | undefined; created_at: string; updated_at: string; embedded_at?: string | undefined; submitted_at?: string | undefined; } export interface CreateGuardianEnrollmentTicketResponseContent { /** The ticket_id used to identify the enrollment */ ticket_id?: string | undefined; /** The url you can use to start enrollment */ ticket_url?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface CreateHookResponseContent { /** Trigger ID */ triggerId?: string | undefined; /** ID of this hook. */ id?: string | undefined; /** Name of this hook. */ name?: string | undefined; /** Whether this hook will be executed (true) or ignored (false). */ enabled?: boolean | undefined; /** Code to be executed when this hook runs. */ script?: string | undefined; dependencies?: Management.HookDependencies | undefined; } /** * Hashmap of key-value pairs where the value must be a string. */ export type CreateHookSecretRequestContent = Record; export interface CreateImportUsersResponseContent { /** Status of this job. */ status: string; /** Type of job this is. */ type: string; /** When this job was created. */ created_at: string; /** ID of this job. */ id: string; /** connection_id of the connection to which users will be imported. */ connection_id: string; /** Customer-defined ID. */ external_id?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface CreateLogStreamDatadogRequestBody { /** log stream name */ name?: string | undefined; type: Management.LogStreamDatadogEnum; /** True for priority log streams, false for non-priority */ isPriority?: boolean | undefined; /** Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. */ filters?: Management.LogStreamFilter[] | undefined; pii_config?: Management.LogStreamPiiConfig | undefined; sink: Management.LogStreamDatadogSink; /** The optional datetime (ISO 8601) to start streaming logs from */ startFrom?: string | undefined; } export interface CreateLogStreamEventBridgeRequestBody { /** log stream name */ name?: string | undefined; type: Management.LogStreamEventBridgeEnum; /** True for priority log streams, false for non-priority */ isPriority?: boolean | undefined; /** Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. */ filters?: Management.LogStreamFilter[] | undefined; pii_config?: Management.LogStreamPiiConfig | undefined; sink: Management.LogStreamEventBridgeSink; /** The optional datetime (ISO 8601) to start streaming logs from */ startFrom?: string | undefined; } export interface CreateLogStreamEventGridRequestBody { /** log stream name */ name?: string | undefined; type: Management.LogStreamEventGridEnum; /** True for priority log streams, false for non-priority */ isPriority?: boolean | undefined; /** Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. */ filters?: Management.LogStreamFilter[] | undefined; pii_config?: Management.LogStreamPiiConfig | undefined; sink: Management.LogStreamEventGridSink; /** The optional datetime (ISO 8601) to start streaming logs from */ startFrom?: string | undefined; } export interface CreateLogStreamHttpRequestBody { /** log stream name */ name?: string | undefined; type: Management.LogStreamHttpEnum; /** True for priority log streams, false for non-priority */ isPriority?: boolean | undefined; /** Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. */ filters?: Management.LogStreamFilter[] | undefined; pii_config?: Management.LogStreamPiiConfig | undefined; sink: Management.LogStreamHttpSink; /** The optional datetime (ISO 8601) to start streaming logs from */ startFrom?: string | undefined; } export interface CreateLogStreamMixpanelRequestBody { /** log stream name */ name?: string | undefined; type: Management.LogStreamMixpanelEnum; /** True for priority log streams, false for non-priority */ isPriority?: boolean | undefined; /** Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. */ filters?: Management.LogStreamFilter[] | undefined; pii_config?: Management.LogStreamPiiConfig | undefined; sink: Management.LogStreamMixpanelSink; /** The optional datetime (ISO 8601) to start streaming logs from */ startFrom?: string | undefined; } export type CreateLogStreamRequestContent = Management.CreateLogStreamHttpRequestBody | Management.CreateLogStreamEventBridgeRequestBody | Management.CreateLogStreamEventGridRequestBody | Management.CreateLogStreamDatadogRequestBody | Management.CreateLogStreamSplunkRequestBody | Management.CreateLogStreamSumoRequestBody | Management.CreateLogStreamSegmentRequestBody | Management.CreateLogStreamMixpanelRequestBody; export type CreateLogStreamResponseContent = Management.LogStreamHttpResponseSchema | Management.LogStreamEventBridgeResponseSchema | Management.LogStreamEventGridResponseSchema | Management.LogStreamDatadogResponseSchema | Management.LogStreamSplunkResponseSchema | Management.LogStreamSumoResponseSchema | Management.LogStreamSegmentResponseSchema | Management.LogStreamMixpanelResponseSchema; export interface CreateLogStreamSegmentRequestBody { /** log stream name */ name?: string | undefined; type: Management.LogStreamSegmentEnum; /** True for priority log streams, false for non-priority */ isPriority?: boolean | undefined; /** Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. */ filters?: Management.LogStreamFilter[] | undefined; pii_config?: Management.LogStreamPiiConfig | undefined; sink: Management.LogStreamSegmentSinkWriteKey; /** The optional datetime (ISO 8601) to start streaming logs from */ startFrom?: string | undefined; } export interface CreateLogStreamSplunkRequestBody { /** log stream name */ name?: string | undefined; type: Management.LogStreamSplunkEnum; /** True for priority log streams, false for non-priority */ isPriority?: boolean | undefined; /** Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. */ filters?: Management.LogStreamFilter[] | undefined; pii_config?: Management.LogStreamPiiConfig | undefined; sink: Management.LogStreamSplunkSink; /** The optional datetime (ISO 8601) to start streaming logs from */ startFrom?: string | undefined; } export interface CreateLogStreamSumoRequestBody { /** log stream name */ name?: string | undefined; type: Management.LogStreamSumoEnum; /** True for priority log streams, false for non-priority */ isPriority?: boolean | undefined; /** Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. */ filters?: Management.LogStreamFilter[] | undefined; pii_config?: Management.LogStreamPiiConfig | undefined; sink: Management.LogStreamSumoSink; /** The optional datetime (ISO 8601) to start streaming logs from */ startFrom?: string | undefined; } export interface CreateOrganizationAllConnectionResponseContent { /** Name of the connection in the scope of this organization. */ organization_connection_name?: string | undefined; /** 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. */ assign_membership_on_login?: boolean | undefined; /** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */ show_as_button?: boolean | undefined; /** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */ is_signup_enabled?: boolean | undefined; organization_access_level?: Management.OrganizationAccessLevelEnum | undefined; /** Whether the connection is enabled for the organization. */ is_enabled?: boolean | undefined; /** Connection identifier. */ connection_id: string; connection?: Management.OrganizationConnectionInformation | undefined; } export interface CreateOrganizationDiscoveryDomainResponseContent { /** Organization discovery domain identifier. */ id: string; /** The domain name to associate with the organization e.g. acme.com. */ domain: string; status: Management.OrganizationDiscoveryDomainStatus; /** Indicates whether this domain should be used for organization discovery. */ use_for_organization_discovery?: boolean | undefined; /** A unique token generated for the discovery domain. This must be placed in a DNS TXT record at the location specified by the verification_host field to prove domain ownership. */ verification_txt: string; /** The full domain where the TXT record should be added. */ verification_host: string; } export interface CreateOrganizationInvitationResponseContent { /** The id of the user invitation. */ id?: string | undefined; /** Organization identifier. */ organization_id?: string | undefined; inviter?: Management.OrganizationInvitationInviter | undefined; invitee?: Management.OrganizationInvitationInvitee | undefined; /** The invitation url to be send to the invitee. */ invitation_url?: string | undefined; /** The ISO 8601 formatted timestamp representing the creation time of the invitation. */ created_at?: string | undefined; /** The ISO 8601 formatted timestamp representing the expiration time of the invitation. */ expires_at?: string | undefined; /** Auth0 client ID. Used to resolve the application's login initiation endpoint. */ client_id?: string | undefined; /** The id of the connection to force invitee to authenticate with. */ connection_id?: string | undefined; app_metadata?: Management.AppMetadata | undefined; user_metadata?: Management.UserMetadata | undefined; /** List of roles IDs to associated with the user. */ roles?: string[] | undefined; /** The id of the invitation ticket */ ticket_id?: string | undefined; } export interface CreateOrganizationResponseContent { /** Organization identifier. */ id?: string | undefined; /** The name of this organization. */ name?: string | undefined; /** Friendly name of this organization. */ display_name?: string | undefined; branding?: Management.OrganizationBranding | undefined; metadata?: Management.OrganizationMetadata | undefined; token_quota?: Management.TokenQuota | undefined; enabled_connections?: Management.OrganizationEnabledConnection[] | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface CreatePhoneProviderSendTestResponseContent { /** The status code of the operation. */ code?: number | undefined; /** The description of the operation status. */ message?: string | undefined; } export interface CreatePhoneTemplateResponseContent { id: string; channel?: string | undefined; customizable?: boolean | undefined; tenant?: string | undefined; content: Management.PhoneTemplateContent; type: Management.PhoneTemplateNotificationTypeEnum; /** Whether the template is enabled (false) or disabled (true). */ disabled: boolean; } export interface CreatePhoneTemplateTestNotificationResponseContent { message: string; /** Accepts any additional properties */ [key: string]: any; } export interface CreatePublicKeyDeviceCredentialResponseContent { /** The credential's identifier */ id: string; /** Accepts any additional properties */ [key: string]: any; } export interface CreateResourceServerResponseContent { /** ID of the API (resource server). */ id?: string | undefined; /** Friendly name for this resource server. Can not contain `<` or `>` characters. */ name?: string | undefined; /** Whether this is an Auth0 system API (true) or a custom API (false). */ is_system?: boolean | undefined; /** Unique identifier for the API used as the audience parameter on authorization calls. Can not be changed once set. */ identifier?: string | undefined; /** List of permissions (scopes) that this API uses. */ scopes?: Management.ResourceServerScope[] | undefined; signing_alg?: Management.SigningAlgorithmEnum | undefined; /** Secret used to sign tokens when using symmetric algorithms (HS256). */ signing_secret?: string | undefined; /** Whether refresh tokens can be issued for this API (true) or not (false). */ allow_offline_access?: boolean | undefined; /** Whether Online Refresh Tokens can be issued for this API (true) or not (false). */ allow_online_access?: boolean | undefined; /** Whether to skip user consent for applications flagged as first party (true) or not (false). */ skip_consent_for_verifiable_first_party_clients?: boolean | undefined; /** Expiration value (in seconds) for access tokens issued for this API from the token endpoint. */ token_lifetime?: number | undefined; /** Expiration value (in seconds) for access tokens issued for this API via Implicit or Hybrid Flows. Cannot be greater than the `token_lifetime` value. */ token_lifetime_for_web?: number | undefined; /** Whether authorization polices are enforced (true) or unenforced (false). */ enforce_policies?: boolean | undefined; token_dialect?: Management.ResourceServerTokenDialectResponseEnum | undefined; token_encryption?: (Management.ResourceServerTokenEncryption | null) | undefined; consent_policy?: (Management.ResourceServerConsentPolicyEnum | null) | undefined; authorization_details?: (unknown[] | null) | undefined; proof_of_possession?: (Management.ResourceServerProofOfPossession | null) | undefined; subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization | undefined; /** The client ID of the client that this resource server is linked to */ client_id?: string | undefined; } export interface CreateRoleResponseContent { /** ID for this role. */ id?: string | undefined; /** Name of this role. */ name?: string | undefined; /** Description of this role. */ description?: string | undefined; } export interface CreateRuleResponseContent { /** Name of this rule. */ name?: string | undefined; /** ID of this rule. */ id?: string | undefined; /** Whether the rule is enabled (true), or disabled (false). */ enabled?: boolean | undefined; /** Code to be executed when this rule runs. */ script?: string | undefined; /** Order that this rule should execute in relative to other rules. Lower-valued rules execute first. */ order?: number | undefined; /** Execution stage of this rule. Can be `login_success`, `login_failure`, or `pre_authorize`. */ stage?: string | undefined; } export interface CreateScimConfigurationRequestContent { /** User ID attribute for generating unique user ids */ user_id_attribute?: string | undefined; /** The mapping between auth0 and SCIM */ mapping?: Management.ScimMappingItem[] | undefined; } export interface CreateScimConfigurationResponseContent { /** The connection's identifier */ connection_id: string; /** The connection's name */ connection_name: string; /** The connection's strategy */ strategy: string; /** The tenant's name */ tenant_name: string; /** User ID attribute for generating unique user ids */ user_id_attribute: string; /** The mapping between auth0 and SCIM */ mapping: Management.ScimMappingItem[]; /** The ISO 8601 date and time the SCIM configuration was created at */ created_at: string; /** The ISO 8601 date and time the SCIM configuration was last updated on */ updated_on: string; } export interface CreateScimTokenResponseContent { /** The token's identifier */ token_id?: string | undefined; /** The scim client's token */ token?: string | undefined; /** The scopes of the scim token */ scopes?: string[] | undefined; /** The token's created at timestamp */ created_at?: string | undefined; /** The token's valid until at timestamp */ valid_until?: string | undefined; } export interface CreateSelfServiceProfileResponseContent { /** The unique ID of the self-service Profile. */ id?: string | undefined; /** The name of the self-service Profile. */ name?: string | undefined; /** The description of the self-service Profile. */ description?: string | undefined; /** List of attributes to be mapped that will be shown to the user during the SS-SSO flow. */ user_attributes?: Management.SelfServiceProfileUserAttribute[] | undefined; /** The time when this self-service Profile was created. */ created_at?: string | undefined; /** The time when this self-service Profile was updated. */ updated_at?: string | undefined; branding?: Management.SelfServiceProfileBrandingProperties | undefined; /** List of IdP strategies that will be shown to users during the Self-Service SSO flow. Possible values: [`oidc`, `samlp`, `waad`, `google-apps`, `adfs`, `okta`, `auth0-samlp`, `okta-samlp`, `keycloak-samlp`, `pingfederate`] */ allowed_strategies?: Management.SelfServiceProfileAllowedStrategyEnum[] | undefined; /** ID of the user-attribute-profile to associate with this self-service profile. */ user_attribute_profile_id?: string | undefined; } export interface CreateSelfServiceProfileSsoTicketResponseContent { /** The URL for the created ticket. */ ticket?: string | undefined; } export interface CreateTokenExchangeProfileResponseContent { /** The unique ID of the token exchange profile. */ id?: string | undefined; /** Friendly name of this profile. */ name?: string | undefined; /** Subject token type for this profile. When receiving a token exchange request on the Authentication API, the corresponding token exchange profile with a matching subject_token_type will be executed. This must be a URI. */ subject_token_type?: string | undefined; /** The ID of the Custom Token Exchange action to execute for this profile, in order to validate the subject_token. The action must use the custom-token-exchange trigger. */ action_id?: string | undefined; type?: Management.TokenExchangeProfileTypeEnum | undefined; /** The time when this profile was created. */ created_at?: string | undefined; /** The time when this profile was updated. */ updated_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface CreateTokenQuota { client_credentials: Management.TokenQuotaClientCredentials; } export interface CreateUserAttributeProfileResponseContent { id?: Management.UserAttributeProfileId | undefined; name?: Management.UserAttributeProfileName | undefined; user_id?: Management.UserAttributeProfileUserId | undefined; user_attributes?: Management.UserAttributeProfileUserAttributes | undefined; } /** * The successfully created authentication method. */ export interface CreateUserAuthenticationMethodResponseContent { /** The ID of the newly created authentication method (automatically generated by the application) */ id?: string | undefined; type: Management.CreatedUserAuthenticationMethodTypeEnum; /** A human-readable label to identify the authentication method. */ name?: string | undefined; /** Base32 encoded secret for TOTP generation */ totp_secret?: string | undefined; /** Applies to phone authentication methods only. The destination phone number used to send verification codes via text and voice. */ phone_number?: string | undefined; /** Applies to email authentication methods only. The email address used to send verification messages. */ email?: string | undefined; authentication_methods?: Management.UserAuthenticationMethodProperties[] | undefined; /** Preferred phone authentication method */ preferred_authentication_method?: Management.PreferredAuthenticationMethodEnum | undefined; /** Applies to webauthn authenticators only. The id of the credential. */ key_id?: string | undefined; /** Applies to webauthn authenticators only. The public key. */ public_key?: string | undefined; /** Applies to passkeys only. Authenticator Attestation Globally Unique Identifier. */ aaguid?: string | undefined; /** Applies to webauthn authenticators only. The relying party identifier. */ relying_party_identifier?: string | undefined; /** Authentication method creation date */ created_at?: string | undefined; } export interface CreateUserResponseContent { /** ID of the user which can be used when interacting with other APIs. */ user_id?: string | undefined; /** Email address of this user. */ email?: string | undefined; /** Whether this email address is verified (true) or unverified (false). */ email_verified?: boolean | undefined; /** Username of this user. */ username?: string | undefined; /** Phone number for this user. Follows the E.164 recommendation. */ phone_number?: string | undefined; /** Whether this phone number has been verified (true) or not (false). */ phone_verified?: boolean | undefined; created_at?: Management.UserDateSchema | undefined; updated_at?: Management.UserDateSchema | undefined; /** Array of user identity objects when accounts are linked. */ identities?: Management.UserIdentitySchema[] | undefined; app_metadata?: Management.UserAppMetadataSchema | undefined; user_metadata?: Management.UserMetadataSchema | undefined; /** URL to picture, photo, or avatar of this user. */ picture?: string | undefined; /** Name of this user. */ name?: string | undefined; /** Preferred nickname or alias of this user. */ nickname?: string | undefined; /** List of multi-factor authentication providers with which this user has enrolled. */ multifactor?: string[] | undefined; /** Last IP address from which this user logged in. */ last_ip?: string | undefined; last_login?: Management.UserDateSchema | undefined; /** Total number of logins this user has performed. */ logins_count?: number | undefined; /** Whether this user was blocked by an administrator (true) or is not (false). */ blocked?: boolean | undefined; /** Given name/first name/forename of this user. */ given_name?: string | undefined; /** Family name/last name/surname of this user. */ family_name?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface CreateVerifiableCredentialTemplateResponseContent { /** The id of the template. */ id?: string | undefined; /** The name of the template. */ name?: string | undefined; /** The type of the template. */ type?: string | undefined; /** The dialect of the template. */ dialect?: string | undefined; presentation?: Management.MdlPresentationRequest | undefined; /** The custom certificate authority. */ custom_certificate_authority?: (string | null) | undefined; /** The well-known trusted issuers, comma separated. */ well_known_trusted_issuers?: (string | null) | undefined; /** The date and time the template was created. */ created_at?: string | undefined; /** The date and time the template was created. */ updated_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface CreateVerificationEmailResponseContent { /** Status of this job. */ status: string; /** Type of job this is. */ type: string; /** When this job was created. */ created_at?: string | undefined; /** ID of this job. */ id: string; /** Accepts any additional properties */ [key: string]: any; } export declare const CreatedAuthenticationMethodTypeEnum: { readonly Phone: "phone"; readonly Email: "email"; readonly Totp: "totp"; readonly WebauthnRoaming: "webauthn-roaming"; }; export type CreatedAuthenticationMethodTypeEnum = (typeof CreatedAuthenticationMethodTypeEnum)[keyof typeof CreatedAuthenticationMethodTypeEnum]; export declare const CreatedUserAuthenticationMethodTypeEnum: { readonly Phone: "phone"; readonly Email: "email"; readonly Totp: "totp"; readonly WebauthnRoaming: "webauthn-roaming"; readonly Passkey: "passkey"; }; export type CreatedUserAuthenticationMethodTypeEnum = (typeof CreatedUserAuthenticationMethodTypeEnum)[keyof typeof CreatedUserAuthenticationMethodTypeEnum]; export interface CredentialId { /** Credential ID */ id: string; } export interface CustomDomain { /** ID of the custom domain. */ custom_domain_id: string; /** Domain name. */ domain: string; /** Whether this is a primary domain (true) or not (false). */ primary: boolean; /** Whether this is the default custom domain (true) or not (false). */ is_default?: boolean | undefined; status: Management.CustomDomainStatusFilterEnum; type: Management.CustomDomainTypeEnum; /** Intermediate address. */ origin_domain_name?: string | undefined; verification?: Management.DomainVerification | undefined; /** The HTTP header to fetch the client's IP address */ custom_client_ip_header?: (string | null) | undefined; /** The TLS version policy */ tls_policy?: string | undefined; domain_metadata?: Management.DomainMetadata | undefined; certificate?: Management.DomainCertificate | undefined; /** Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not present, the full domain will be used. */ relying_party_identifier?: string | undefined; } export type CustomDomainCustomClientIpHeader = (Management.CustomDomainCustomClientIpHeaderEnum | null) | undefined; /** The HTTP header to fetch the client's IP address */ export declare const CustomDomainCustomClientIpHeaderEnum: { readonly TrueClientIp: "true-client-ip"; readonly CfConnectingIp: "cf-connecting-ip"; readonly XForwardedFor: "x-forwarded-for"; readonly XAzureClientip: "x-azure-clientip"; readonly Empty: ""; }; export type CustomDomainCustomClientIpHeaderEnum = (typeof CustomDomainCustomClientIpHeaderEnum)[keyof typeof CustomDomainCustomClientIpHeaderEnum]; /** Custom domain provisioning type. Must be `auth0_managed_certs` or `self_managed_certs`. */ export declare const CustomDomainProvisioningTypeEnum: { readonly Auth0ManagedCerts: "auth0_managed_certs"; readonly SelfManagedCerts: "self_managed_certs"; }; export type CustomDomainProvisioningTypeEnum = (typeof CustomDomainProvisioningTypeEnum)[keyof typeof CustomDomainProvisioningTypeEnum]; /** Custom domain configuration status. Can be `failed`, `pending_verification`, or `ready`. */ export declare const CustomDomainStatusFilterEnum: { readonly PendingVerification: "pending_verification"; readonly Ready: "ready"; readonly Failed: "failed"; }; export type CustomDomainStatusFilterEnum = (typeof CustomDomainStatusFilterEnum)[keyof typeof CustomDomainStatusFilterEnum]; /** Custom domain TLS policy. Must be `recommended`, includes TLS 1.2. */ export declare const CustomDomainTlsPolicyEnum: { readonly Recommended: "recommended"; }; export type CustomDomainTlsPolicyEnum = (typeof CustomDomainTlsPolicyEnum)[keyof typeof CustomDomainTlsPolicyEnum]; /** Custom domain provisioning type. Can be `auth0_managed_certs` or `self_managed_certs`. */ export declare const CustomDomainTypeEnum: { readonly Auth0ManagedCerts: "auth0_managed_certs"; readonly SelfManagedCerts: "self_managed_certs"; }; export type CustomDomainTypeEnum = (typeof CustomDomainTypeEnum)[keyof typeof CustomDomainTypeEnum]; /** Custom domain verification method. Must be `txt`. */ export declare const CustomDomainVerificationMethodEnum: { readonly Txt: "txt"; }; export type CustomDomainVerificationMethodEnum = (typeof CustomDomainVerificationMethodEnum)[keyof typeof CustomDomainVerificationMethodEnum]; export interface CustomProviderConfiguration { delivery_methods: Management.CustomProviderDeliveryMethodEnum[]; } export interface CustomProviderCredentials { } export declare const CustomProviderDeliveryMethodEnum: { readonly Text: "text"; readonly Voice: "voice"; }; export type CustomProviderDeliveryMethodEnum = (typeof CustomProviderDeliveryMethodEnum)[keyof typeof CustomProviderDeliveryMethodEnum]; /** Key algorithm */ export declare const CustomSigningKeyAlgorithmEnum: { readonly Rs256: "RS256"; readonly Rs384: "RS384"; readonly Rs512: "RS512"; readonly Es256: "ES256"; readonly Es384: "ES384"; readonly Es512: "ES512"; readonly Ps256: "PS256"; readonly Ps384: "PS384"; readonly Ps512: "PS512"; }; export type CustomSigningKeyAlgorithmEnum = (typeof CustomSigningKeyAlgorithmEnum)[keyof typeof CustomSigningKeyAlgorithmEnum]; /** Curve */ export declare const CustomSigningKeyCurveEnum: { readonly P256: "P-256"; readonly P384: "P-384"; readonly P521: "P-521"; }; export type CustomSigningKeyCurveEnum = (typeof CustomSigningKeyCurveEnum)[keyof typeof CustomSigningKeyCurveEnum]; /** * JWK representing a custom public signing key. */ export interface CustomSigningKeyJwk { kty: Management.CustomSigningKeyTypeEnum; /** Key identifier */ kid?: string | undefined; use?: Management.CustomSigningKeyUseEnum | undefined; /** Key operations */ key_ops?: Management.CustomSigningKeyOperationEnum[] | undefined; alg?: Management.CustomSigningKeyAlgorithmEnum | undefined; /** Key modulus */ n?: string | undefined; /** Key exponent */ e?: string | undefined; crv?: Management.CustomSigningKeyCurveEnum | undefined; /** X coordinate */ x?: string | undefined; /** Y coordinate */ y?: string | undefined; /** X.509 URL */ x5u?: string | undefined; /** X.509 certificate chain */ x5c?: string[] | undefined; /** X.509 certificate SHA-1 thumbprint */ x5t?: string | undefined; /** X.509 certificate SHA-256 thumbprint */ "x5t#S256"?: string | undefined; } export declare const CustomSigningKeyOperationEnum: { readonly Verify: "verify"; }; export type CustomSigningKeyOperationEnum = (typeof CustomSigningKeyOperationEnum)[keyof typeof CustomSigningKeyOperationEnum]; /** Key type */ export declare const CustomSigningKeyTypeEnum: { readonly Ec: "EC"; readonly Rsa: "RSA"; }; export type CustomSigningKeyTypeEnum = (typeof CustomSigningKeyTypeEnum)[keyof typeof CustomSigningKeyTypeEnum]; /** Key use */ export declare const CustomSigningKeyUseEnum: { readonly Sig: "sig"; }; export type CustomSigningKeyUseEnum = (typeof CustomSigningKeyUseEnum)[keyof typeof CustomSigningKeyUseEnum]; export interface DailyStats { /** Date these events occurred in ISO 8601 format. */ date?: string | undefined; /** Number of logins on this date. */ logins?: number | undefined; /** Number of signups on this date. */ signups?: number | undefined; /** Number of breached-password detections on this date (subscription required). */ leaked_passwords?: number | undefined; /** Date and time this stats entry was last updated in ISO 8601 format. */ updated_at?: string | undefined; /** Approximate date and time the first event occurred in ISO 8601 format. */ created_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** Default authentication method for email identifier */ export declare const DefaultMethodEmailIdentifierEnum: { readonly Password: "password"; readonly EmailOtp: "email_otp"; }; export type DefaultMethodEmailIdentifierEnum = (typeof DefaultMethodEmailIdentifierEnum)[keyof typeof DefaultMethodEmailIdentifierEnum]; /** * Token Quota configuration, to configure quotas for token issuance for clients and organizations. Applied to all clients and organizations unless overridden in individual client or organization settings. */ export interface DefaultTokenQuota { clients?: Management.TokenQuotaConfiguration | undefined; organizations?: Management.TokenQuotaConfiguration | undefined; } /** * Array of secret names to delete. */ export type DeleteHookSecretRequestContent = string[]; export interface DeleteUserIdentityResponseContentItem { /** The name of the connection for the identity. */ connection: string; /** The unique identifier for the user for the identity. */ user_id: string; /** The type of identity provider. */ provider: string; /** true if the identity provider is a social provider, falses otherwise */ isSocial?: boolean | undefined; /** IDP access token returned only if scope read:user_idp_tokens is defined */ access_token?: string | undefined; /** IDP access token secret returned only if scope read:user_idp_tokens is defined. */ access_token_secret?: string | undefined; /** IDP refresh token returned only if scope read:user_idp_tokens is defined. */ refresh_token?: string | undefined; profileData?: Management.UserProfileData | undefined; } /** * An array of objects with information about the user's identities. */ export type DeleteUserIdentityResponseContent = Management.DeleteUserIdentityResponseContentItem[]; export interface DeployActionResponseContent { /** The unique id of an action version. */ id?: string | undefined; /** The id of the action to which this version belongs. */ action_id?: string | undefined; /** The source code of this specific version of the action. */ code?: string | undefined; /** The list of third party npm modules, and their versions, that this specific version depends on. */ dependencies?: Management.ActionVersionDependency[] | undefined; /** Indicates if this specific version is the currently one deployed. */ deployed?: boolean | undefined; /** The Node runtime. For example: `node22` */ runtime?: string | undefined; /** The list of secrets that are included in an action or a version of an action. */ secrets?: Management.ActionSecretResponse[] | undefined; status?: Management.ActionVersionBuildStatusEnum | undefined; /** The index of this version in list of versions for the action. */ number?: number | undefined; /** Any errors that occurred while the version was being built. */ errors?: Management.ActionError[] | undefined; action?: Management.ActionBase | undefined; /** The time when this version was built successfully. */ built_at?: string | undefined; /** The time when this version was created. */ created_at?: string | undefined; /** The time when a version was updated. Versions are never updated externally. Only Auth0 will update an action version as it is being built. */ updated_at?: string | undefined; /** The list of triggers that this version supports. At this time, a version can only target a single trigger at a time. */ supported_triggers?: Management.ActionTrigger[] | undefined; /** The list of action modules and their versions used by this action version. */ modules?: Management.ActionModuleReference[] | undefined; } export interface DeployActionVersionRequestContent { /** True if the draft of the action should be updated with the reverted version. */ update_draft?: boolean | undefined; } export interface DeployActionVersionResponseContent { /** The unique id of an action version. */ id?: string | undefined; /** The id of the action to which this version belongs. */ action_id?: string | undefined; /** The source code of this specific version of the action. */ code?: string | undefined; /** The list of third party npm modules, and their versions, that this specific version depends on. */ dependencies?: Management.ActionVersionDependency[] | undefined; /** Indicates if this specific version is the currently one deployed. */ deployed?: boolean | undefined; /** The Node runtime. For example: `node22` */ runtime?: string | undefined; /** The list of secrets that are included in an action or a version of an action. */ secrets?: Management.ActionSecretResponse[] | undefined; status?: Management.ActionVersionBuildStatusEnum | undefined; /** The index of this version in list of versions for the action. */ number?: number | undefined; /** Any errors that occurred while the version was being built. */ errors?: Management.ActionError[] | undefined; action?: Management.ActionBase | undefined; /** The time when this version was built successfully. */ built_at?: string | undefined; /** The time when this version was created. */ created_at?: string | undefined; /** The time when a version was updated. Versions are never updated externally. Only Auth0 will update an action version as it is being built. */ updated_at?: string | undefined; /** The list of triggers that this version supports. At this time, a version can only target a single trigger at a time. */ supported_triggers?: Management.ActionTrigger[] | undefined; /** The list of action modules and their versions used by this action version. */ modules?: Management.ActionModuleReference[] | undefined; } export interface DeviceCredential { /** ID of this device. */ id?: string | undefined; /** User agent for this device */ device_name?: string | undefined; /** Unique identifier for the device. NOTE: This field is generally not populated for refresh_tokens and rotating_refresh_tokens */ device_id?: string | undefined; /** Type of credential. Can be `public_key`, `refresh_token`, or `rotating_refresh_token`. */ type?: Management.DeviceCredentialTypeEnum | undefined; /** user_id this credential is associated with. */ user_id?: string | undefined; /** client_id of the client (application) this credential is for. */ client_id?: string | undefined; } /** Type of credential. Must be `public_key`. */ export declare const DeviceCredentialPublicKeyTypeEnum: { readonly PublicKey: "public_key"; }; export type DeviceCredentialPublicKeyTypeEnum = (typeof DeviceCredentialPublicKeyTypeEnum)[keyof typeof DeviceCredentialPublicKeyTypeEnum]; /** Type of credentials to retrieve. Must be `public_key`, `refresh_token` or `rotating_refresh_token`. The property will default to `refresh_token` when paging is requested */ export declare const DeviceCredentialTypeEnum: { readonly PublicKey: "public_key"; readonly RefreshToken: "refresh_token"; readonly RotatingRefreshToken: "rotating_refresh_token"; }; export type DeviceCredentialTypeEnum = (typeof DeviceCredentialTypeEnum)[keyof typeof DeviceCredentialTypeEnum]; export interface DirectoryProvisioning { /** The connection's identifier */ connection_id: string; /** The connection's name */ connection_name: string; /** The connection's strategy */ strategy: string; /** The mapping between Auth0 and IDP user attributes */ mapping: Management.DirectoryProvisioningMappingItem[]; /** Whether periodic automatic synchronization is enabled */ synchronize_automatically: boolean; synchronize_groups?: Management.SynchronizeGroupsEnum | undefined; /** The timestamp at which the directory provisioning configuration was created */ created_at: string; /** The timestamp at which the directory provisioning configuration was last updated */ updated_at: string; /** The timestamp at which the connection was last synchronized */ last_synchronization_at?: string | undefined; /** The status of the last synchronization */ last_synchronization_status?: string | undefined; /** The error message of the last synchronization, if any */ last_synchronization_error?: string | undefined; } export interface DirectoryProvisioningMappingItem { /** The field location in the Auth0 schema */ auth0: string; /** The field location in the IDP schema */ idp: string; } /** * Certificate information. This object is relevant only for Custom Domains with Auth0-Managed Certificates. */ export interface DomainCertificate { status?: Management.DomainCertificateStatusEnum | undefined; /** A user-friendly error message will be presented if the certificate status is provisioning_failed or renewing_failed. */ error_msg?: string | undefined; certificate_authority?: Management.DomainCertificateAuthorityEnum | undefined; /** The certificate will be renewed prior to this date. */ renews_before?: string | undefined; } /** The Certificate Authority issued the certificate. */ export declare const DomainCertificateAuthorityEnum: { readonly Letsencrypt: "letsencrypt"; readonly Googletrust: "googletrust"; }; export type DomainCertificateAuthorityEnum = (typeof DomainCertificateAuthorityEnum)[keyof typeof DomainCertificateAuthorityEnum]; /** The provisioning status of the certificate. */ export declare const DomainCertificateStatusEnum: { readonly Provisioning: "provisioning"; readonly ProvisioningFailed: "provisioning_failed"; readonly Provisioned: "provisioned"; readonly RenewingFailed: "renewing_failed"; }; export type DomainCertificateStatusEnum = (typeof DomainCertificateStatusEnum)[keyof typeof DomainCertificateStatusEnum]; /** * Domain metadata associated with the custom domain, in the form of an object with string values (max 255 chars). Maximum of 10 domain metadata properties allowed. */ export type DomainMetadata = Record; /** * Domain verification settings. */ export interface DomainVerification { /** Domain verification methods. */ methods?: Management.DomainVerificationMethod[] | undefined; status?: Management.DomainVerificationStatusEnum | undefined; /** The user0-friendly error message in case of failed verification. This field is relevant only for Custom Domains with Auth0-Managed Certificates. */ error_msg?: string | undefined; /** The date and time when the custom domain was last verified. This field is relevant only for Custom Domains with Auth0-Managed Certificates. */ last_verified_at?: string | undefined; } export interface DomainVerificationMethod { name: Management.DomainVerificationMethodNameEnum; /** Value used to verify the domain. */ record: string; /** The name of the txt record for verification */ domain?: string | undefined; } /** Domain verification method. */ export declare const DomainVerificationMethodNameEnum: { readonly Cname: "cname"; readonly Txt: "txt"; }; export type DomainVerificationMethodNameEnum = (typeof DomainVerificationMethodNameEnum)[keyof typeof DomainVerificationMethodNameEnum]; /** The DNS record verification status. This field is relevant only for Custom Domains with Auth0-Managed Certificates. */ export declare const DomainVerificationStatusEnum: { readonly Verified: "verified"; readonly Pending: "pending"; readonly Failed: "failed"; }; export type DomainVerificationStatusEnum = (typeof DomainVerificationStatusEnum)[keyof typeof DomainVerificationStatusEnum]; /** * Configuration for the email attribute for users. */ export interface EmailAttribute { identifier?: Management.ConnectionAttributeIdentifier | undefined; /** Determines if the attribute is unique in a given connection */ unique?: boolean | undefined; /** Determines if property should be required for users */ profile_required?: boolean | undefined; verification_method?: Management.VerificationMethodEnum | undefined; signup?: Management.SignupVerified | undefined; } /** Set to eu if your domain is provisioned to use Mailgun's EU region. Otherwise, set to null. */ export declare const EmailMailgunRegionEnum: { readonly Eu: "eu"; }; export type EmailMailgunRegionEnum = (typeof EmailMailgunRegionEnum)[keyof typeof EmailMailgunRegionEnum]; /** * Credentials required to use the provider. */ export interface EmailProviderCredentials { /** API User. */ api_user?: string | undefined; /** AWS or SparkPost region. */ region?: string | undefined; /** SMTP host. */ smtp_host?: string | undefined; /** SMTP port. */ smtp_port?: number | undefined; /** SMTP username. */ smtp_user?: string | undefined; } /** * Credentials required to use the provider. */ export type EmailProviderCredentialsSchema = { api_key: string; } | { accessKeyId?: string | undefined; secretAccessKey?: string | undefined; region?: string | undefined; } | { smtp_host?: Management.EmailSmtpHost | undefined; smtp_port?: number | undefined; smtp_user?: string | undefined; smtp_pass?: string | undefined; } | { api_key?: string | undefined; region?: Management.EmailSparkPostRegionEnum | undefined; } | { api_key?: string | undefined; domain?: string | undefined; region?: Management.EmailMailgunRegionEnum | undefined; } | { connectionString?: string | undefined; } | { tenantId?: string | undefined; clientId?: string | undefined; clientSecret?: string | undefined; } | Management.ExtensibilityEmailProviderCredentials; /** Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, `ms365`, or `custom`. */ export declare const EmailProviderNameEnum: { readonly Mailgun: "mailgun"; readonly Mandrill: "mandrill"; readonly Sendgrid: "sendgrid"; readonly Ses: "ses"; readonly Sparkpost: "sparkpost"; readonly Smtp: "smtp"; readonly AzureCs: "azure_cs"; readonly Ms365: "ms365"; readonly Custom: "custom"; }; export type EmailProviderNameEnum = (typeof EmailProviderNameEnum)[keyof typeof EmailProviderNameEnum]; /** * Specific provider setting */ export type EmailProviderSettings = Record; /** * SMTP host. */ export type EmailSmtpHost = string; /** Set to eu to use SparkPost service hosted in Western Europe. To use SparkPost hosted in North America, set it to null. */ export declare const EmailSparkPostRegionEnum: { readonly Eu: "eu"; }; export type EmailSparkPostRegionEnum = (typeof EmailSparkPostRegionEnum)[keyof typeof EmailSparkPostRegionEnum]; /** * Specific provider setting */ export type EmailSpecificProviderSettingsWithAdditionalProperties = (Record | null) | undefined; /** Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy). */ export declare const EmailTemplateNameEnum: { readonly VerifyEmail: "verify_email"; readonly VerifyEmailByCode: "verify_email_by_code"; readonly ResetEmail: "reset_email"; readonly ResetEmailByCode: "reset_email_by_code"; readonly WelcomeEmail: "welcome_email"; readonly BlockedAccount: "blocked_account"; readonly StolenCredentials: "stolen_credentials"; readonly EnrollmentEmail: "enrollment_email"; readonly MfaOobCode: "mfa_oob_code"; readonly UserInvitation: "user_invitation"; readonly ChangePassword: "change_password"; readonly PasswordReset: "password_reset"; readonly AsyncApproval: "async_approval"; }; export type EmailTemplateNameEnum = (typeof EmailTemplateNameEnum)[keyof typeof EmailTemplateNameEnum]; /** Enum for enabled features. */ export declare const EnabledFeaturesEnum: { readonly Scim: "scim"; readonly UniversalLogout: "universal_logout"; }; export type EnabledFeaturesEnum = (typeof EnabledFeaturesEnum)[keyof typeof EnabledFeaturesEnum]; /** * Encryption key */ export interface EncryptionKey { /** Key ID */ kid: string; type: Management.EncryptionKeyType; state: Management.EncryptionKeyState; /** Key creation timestamp */ created_at: string; /** Key update timestamp */ updated_at: string; /** ID of parent wrapping key */ parent_kid?: (string | null) | undefined; /** Public key in PEM format */ public_key?: (string | null) | undefined; } /** Encryption algorithm that shall be used to wrap your key material */ export declare const EncryptionKeyPublicWrappingAlgorithm: { readonly CkmRsaAesKeyWrap: "CKM_RSA_AES_KEY_WRAP"; }; export type EncryptionKeyPublicWrappingAlgorithm = (typeof EncryptionKeyPublicWrappingAlgorithm)[keyof typeof EncryptionKeyPublicWrappingAlgorithm]; /** Key state */ export declare const EncryptionKeyState: { readonly PreActivation: "pre-activation"; readonly Active: "active"; readonly Deactivated: "deactivated"; readonly Destroyed: "destroyed"; }; export type EncryptionKeyState = (typeof EncryptionKeyState)[keyof typeof EncryptionKeyState]; /** Key type */ export declare const EncryptionKeyType: { readonly CustomerProvidedRootKey: "customer-provided-root-key"; readonly EnvironmentRootKey: "environment-root-key"; readonly TenantMasterKey: "tenant-master-key"; readonly TenantEncryptionKey: "tenant-encryption-key"; }; export type EncryptionKeyType = (typeof EncryptionKeyType)[keyof typeof EncryptionKeyType]; /** * Configuration specific to an action destination. */ export interface EventStreamActionConfiguration { /** Action ID for the action destination. */ action_id: string; } export interface EventStreamActionDestination { type: Management.EventStreamActionDestinationTypeEnum; configuration: Management.EventStreamActionConfiguration; } export declare const EventStreamActionDestinationTypeEnum: { readonly Action: "action"; }; export type EventStreamActionDestinationTypeEnum = (typeof EventStreamActionDestinationTypeEnum)[keyof typeof EventStreamActionDestinationTypeEnum]; export interface EventStreamActionResponseContent { /** Unique identifier for the event stream. */ id?: string | undefined; /** Name of the event stream. */ name?: string | undefined; /** List of event types subscribed to in this stream. */ subscriptions?: Management.EventStreamSubscription[] | undefined; destination?: Management.EventStreamActionDestination | undefined; status?: Management.EventStreamStatusEnum | undefined; /** Timestamp when the event stream was created. */ created_at?: string | undefined; /** Timestamp when the event stream was last updated. */ updated_at?: string | undefined; } /** * Event content. This will only be set if delivery failed. */ export interface EventStreamCloudEvent { /** Unique identifier for the event */ id?: string | undefined; /** Where the event originated */ source?: string | undefined; /** Version of CloudEvents spec */ specversion?: string | undefined; /** Type of the event (e.g., user.created) */ type?: string | undefined; /** Timestamp at which the event was generated */ time?: string | undefined; /** Event contents encoded as a string. */ data?: string | undefined; } /** * Metadata about a specific attempt to deliver an event */ export interface EventStreamDelivery { /** Unique identifier for the delivery */ id: string; /** Unique identifier for the event stream. */ event_stream_id: string; status: Management.EventStreamDeliveryStatusEnum; event_type: Management.EventStreamDeliveryEventTypeEnum; /** Results of delivery attempts */ attempts: Management.EventStreamDeliveryAttempt[]; event?: Management.EventStreamCloudEvent | undefined; } export interface EventStreamDeliveryAttempt { status: Management.EventStreamDeliveryStatusEnum; /** Timestamp of delivery attempt */ timestamp: string; /** Delivery error message, if applicable */ error_message?: string | undefined; } /** Type of event */ export declare const EventStreamDeliveryEventTypeEnum: { readonly GroupCreated: "group.created"; readonly GroupDeleted: "group.deleted"; readonly GroupMemberAdded: "group.member.added"; readonly GroupMemberDeleted: "group.member.deleted"; readonly GroupRoleAssigned: "group.role.assigned"; readonly GroupRoleDeleted: "group.role.deleted"; readonly GroupUpdated: "group.updated"; readonly OrganizationConnectionAdded: "organization.connection.added"; readonly OrganizationConnectionRemoved: "organization.connection.removed"; readonly OrganizationConnectionUpdated: "organization.connection.updated"; readonly OrganizationCreated: "organization.created"; readonly OrganizationDeleted: "organization.deleted"; readonly OrganizationGroupRoleAssigned: "organization.group.role.assigned"; readonly OrganizationGroupRoleDeleted: "organization.group.role.deleted"; readonly OrganizationMemberAdded: "organization.member.added"; readonly OrganizationMemberDeleted: "organization.member.deleted"; readonly OrganizationMemberRoleAssigned: "organization.member.role.assigned"; readonly OrganizationMemberRoleDeleted: "organization.member.role.deleted"; readonly OrganizationUpdated: "organization.updated"; readonly UserCreated: "user.created"; readonly UserDeleted: "user.deleted"; readonly UserUpdated: "user.updated"; }; export type EventStreamDeliveryEventTypeEnum = (typeof EventStreamDeliveryEventTypeEnum)[keyof typeof EventStreamDeliveryEventTypeEnum]; /** Delivery status */ export declare const EventStreamDeliveryStatusEnum: { readonly Failed: "failed"; }; export type EventStreamDeliveryStatusEnum = (typeof EventStreamDeliveryStatusEnum)[keyof typeof EventStreamDeliveryStatusEnum]; export type EventStreamDestinationPatch = Management.EventStreamWebhookDestination | Management.EventStreamActionDestination; /** AWS Region for EventBridge destination. */ export declare const EventStreamEventBridgeAwsRegionEnum: { readonly AfSouth1: "af-south-1"; readonly ApEast1: "ap-east-1"; readonly ApEast2: "ap-east-2"; readonly ApNortheast1: "ap-northeast-1"; readonly ApNortheast2: "ap-northeast-2"; readonly ApNortheast3: "ap-northeast-3"; readonly ApSouth1: "ap-south-1"; readonly ApSouth2: "ap-south-2"; readonly ApSoutheast1: "ap-southeast-1"; readonly ApSoutheast2: "ap-southeast-2"; readonly ApSoutheast3: "ap-southeast-3"; readonly ApSoutheast4: "ap-southeast-4"; readonly ApSoutheast5: "ap-southeast-5"; readonly ApSoutheast6: "ap-southeast-6"; readonly ApSoutheast7: "ap-southeast-7"; readonly CaCentral1: "ca-central-1"; readonly CaWest1: "ca-west-1"; readonly EuCentral1: "eu-central-1"; readonly EuCentral2: "eu-central-2"; readonly EuNorth1: "eu-north-1"; readonly EuSouth1: "eu-south-1"; readonly EuSouth2: "eu-south-2"; readonly EuWest1: "eu-west-1"; readonly EuWest2: "eu-west-2"; readonly EuWest3: "eu-west-3"; readonly IlCentral1: "il-central-1"; readonly MeCentral1: "me-central-1"; readonly MeSouth1: "me-south-1"; readonly MxCentral1: "mx-central-1"; readonly SaEast1: "sa-east-1"; readonly UsGovEast1: "us-gov-east-1"; readonly UsGovWest1: "us-gov-west-1"; readonly UsEast1: "us-east-1"; readonly UsEast2: "us-east-2"; readonly UsWest1: "us-west-1"; readonly UsWest2: "us-west-2"; }; export type EventStreamEventBridgeAwsRegionEnum = (typeof EventStreamEventBridgeAwsRegionEnum)[keyof typeof EventStreamEventBridgeAwsRegionEnum]; /** * Configuration specific to an eventbridge destination. */ export interface EventStreamEventBridgeConfiguration { /** AWS Account ID for EventBridge destination. */ aws_account_id: string; aws_region: Management.EventStreamEventBridgeAwsRegionEnum; /** AWS Partner Event Source for EventBridge destination. */ aws_partner_event_source?: string | undefined; } export interface EventStreamEventBridgeDestination { type: Management.EventStreamEventBridgeDestinationTypeEnum; configuration: Management.EventStreamEventBridgeConfiguration; } export declare const EventStreamEventBridgeDestinationTypeEnum: { readonly Eventbridge: "eventbridge"; }; export type EventStreamEventBridgeDestinationTypeEnum = (typeof EventStreamEventBridgeDestinationTypeEnum)[keyof typeof EventStreamEventBridgeDestinationTypeEnum]; export interface EventStreamEventBridgeResponseContent { /** Unique identifier for the event stream. */ id?: string | undefined; /** Name of the event stream. */ name?: string | undefined; /** List of event types subscribed to in this stream. */ subscriptions?: Management.EventStreamSubscription[] | undefined; destination?: Management.EventStreamEventBridgeDestination | undefined; status?: Management.EventStreamStatusEnum | undefined; /** Timestamp when the event stream was created. */ created_at?: string | undefined; /** Timestamp when the event stream was last updated. */ updated_at?: string | undefined; } export declare const EventStreamEventTypeEnum: { readonly GroupCreated: "group.created"; readonly GroupDeleted: "group.deleted"; readonly GroupMemberAdded: "group.member.added"; readonly GroupMemberDeleted: "group.member.deleted"; readonly GroupRoleAssigned: "group.role.assigned"; readonly GroupRoleDeleted: "group.role.deleted"; readonly GroupUpdated: "group.updated"; readonly OrganizationConnectionAdded: "organization.connection.added"; readonly OrganizationConnectionRemoved: "organization.connection.removed"; readonly OrganizationConnectionUpdated: "organization.connection.updated"; readonly OrganizationCreated: "organization.created"; readonly OrganizationDeleted: "organization.deleted"; readonly OrganizationGroupRoleAssigned: "organization.group.role.assigned"; readonly OrganizationGroupRoleDeleted: "organization.group.role.deleted"; readonly OrganizationMemberAdded: "organization.member.added"; readonly OrganizationMemberDeleted: "organization.member.deleted"; readonly OrganizationMemberRoleAssigned: "organization.member.role.assigned"; readonly OrganizationMemberRoleDeleted: "organization.member.role.deleted"; readonly OrganizationUpdated: "organization.updated"; readonly UserCreated: "user.created"; readonly UserDeleted: "user.deleted"; readonly UserUpdated: "user.updated"; }; export type EventStreamEventTypeEnum = (typeof EventStreamEventTypeEnum)[keyof typeof EventStreamEventTypeEnum]; export type EventStreamResponseContent = Management.EventStreamWebhookResponseContent | Management.EventStreamEventBridgeResponseContent | Management.EventStreamActionResponseContent; /** Indicates whether the event stream is actively forwarding events. */ export declare const EventStreamStatusEnum: { readonly Enabled: "enabled"; readonly Disabled: "disabled"; }; export type EventStreamStatusEnum = (typeof EventStreamStatusEnum)[keyof typeof EventStreamStatusEnum]; /** * Event types */ export interface EventStreamSubscription { event_type?: string | undefined; } /** The type of event this test event represents. */ export declare const EventStreamTestEventTypeEnum: { readonly GroupCreated: "group.created"; readonly GroupDeleted: "group.deleted"; readonly GroupMemberAdded: "group.member.added"; readonly GroupMemberDeleted: "group.member.deleted"; readonly GroupRoleAssigned: "group.role.assigned"; readonly GroupRoleDeleted: "group.role.deleted"; readonly GroupUpdated: "group.updated"; readonly OrganizationConnectionAdded: "organization.connection.added"; readonly OrganizationConnectionRemoved: "organization.connection.removed"; readonly OrganizationConnectionUpdated: "organization.connection.updated"; readonly OrganizationCreated: "organization.created"; readonly OrganizationDeleted: "organization.deleted"; readonly OrganizationGroupRoleAssigned: "organization.group.role.assigned"; readonly OrganizationGroupRoleDeleted: "organization.group.role.deleted"; readonly OrganizationMemberAdded: "organization.member.added"; readonly OrganizationMemberDeleted: "organization.member.deleted"; readonly OrganizationMemberRoleAssigned: "organization.member.role.assigned"; readonly OrganizationMemberRoleDeleted: "organization.member.role.deleted"; readonly OrganizationUpdated: "organization.updated"; readonly UserCreated: "user.created"; readonly UserDeleted: "user.deleted"; readonly UserUpdated: "user.updated"; }; export type EventStreamTestEventTypeEnum = (typeof EventStreamTestEventTypeEnum)[keyof typeof EventStreamTestEventTypeEnum]; export type EventStreamWebhookAuthorizationResponse = Management.EventStreamWebhookBasicAuth | Management.EventStreamWebhookBearerAuth | Management.EventStreamWebhookCustomHeaderAuth; /** * Basic Authorization for HTTP requests (e.g., 'Basic credentials'). */ export interface EventStreamWebhookBasicAuth { method: Management.EventStreamWebhookBasicAuthMethodEnum; /** Username */ username: string; } /** Type of authorization. */ export declare const EventStreamWebhookBasicAuthMethodEnum: { readonly Basic: "basic"; }; export type EventStreamWebhookBasicAuthMethodEnum = (typeof EventStreamWebhookBasicAuthMethodEnum)[keyof typeof EventStreamWebhookBasicAuthMethodEnum]; /** * Bearer Authorization for HTTP requests (e.g., 'Bearer token'). */ export interface EventStreamWebhookBearerAuth { method: Management.EventStreamWebhookBearerAuthMethodEnum; } /** Type of authorization. */ export declare const EventStreamWebhookBearerAuthMethodEnum: { readonly Bearer: "bearer"; }; export type EventStreamWebhookBearerAuthMethodEnum = (typeof EventStreamWebhookBearerAuthMethodEnum)[keyof typeof EventStreamWebhookBearerAuthMethodEnum]; /** * Configuration specific to a webhook destination. */ export interface EventStreamWebhookConfiguration { /** Target HTTP endpoint URL. */ webhook_endpoint: string; webhook_authorization: Management.EventStreamWebhookAuthorizationResponse; } /** * Custom header authorization for HTTP requests. */ export interface EventStreamWebhookCustomHeaderAuth { method: Management.EventStreamWebhookCustomHeaderAuthMethodEnum; /** HTTP header name. */ header_key: string; } /** Type of authorization. */ export declare const EventStreamWebhookCustomHeaderAuthMethodEnum: { readonly CustomHeader: "custom_header"; }; export type EventStreamWebhookCustomHeaderAuthMethodEnum = (typeof EventStreamWebhookCustomHeaderAuthMethodEnum)[keyof typeof EventStreamWebhookCustomHeaderAuthMethodEnum]; export interface EventStreamWebhookDestination { type: Management.EventStreamWebhookDestinationTypeEnum; configuration: Management.EventStreamWebhookConfiguration; } export declare const EventStreamWebhookDestinationTypeEnum: { readonly Webhook: "webhook"; }; export type EventStreamWebhookDestinationTypeEnum = (typeof EventStreamWebhookDestinationTypeEnum)[keyof typeof EventStreamWebhookDestinationTypeEnum]; export interface EventStreamWebhookResponseContent { /** Unique identifier for the event stream. */ id?: string | undefined; /** Name of the event stream. */ name?: string | undefined; /** List of event types subscribed to in this stream. */ subscriptions?: Management.EventStreamSubscription[] | undefined; destination?: Management.EventStreamWebhookDestination | undefined; status?: Management.EventStreamStatusEnum | undefined; /** Timestamp when the event stream was created. */ created_at?: string | undefined; /** Timestamp when the event stream was last updated. */ updated_at?: string | undefined; } /** * Application specific configuration for use with the OIN Express Configuration feature. */ export interface ExpressConfiguration { /** The URI users should bookmark to log in to this application. Variable substitution is permitted for the following properties: organization_name, organization_id, and connection_name. */ initiate_login_uri_template: string; /** The ID of the user attribute profile to use for this application. */ user_attribute_profile_id: string; /** The ID of the connection profile to use for this application. */ connection_profile_id: string; /** When true, all connections made via express configuration will be enabled for this application. */ enable_client: boolean; /** When true, all connections made via express configuration will have the associated organization enabled. */ enable_organization: boolean; /** List of client IDs that are linked to this express configuration (e.g. web or mobile clients). */ linked_clients?: Management.LinkedClientConfiguration[] | undefined; /** This is the unique identifier for the Okta OIN Express Configuration Client, which Okta will use for this application. */ okta_oin_client_id: string; /** This is the domain that admins are expected to log in via for authenticating for express configuration. It can be either the canonical domain or a registered custom domain. */ admin_login_domain: string; /** The identifier of the published application in the OKTA OIN. */ oin_submission_id?: string | undefined; } /** * Application specific configuration for use with the OIN Express Configuration feature. */ export interface ExpressConfigurationOrNull { /** The URI users should bookmark to log in to this application. Variable substitution is permitted for the following properties: organization_name, organization_id, and connection_name. */ initiate_login_uri_template: string; /** The ID of the user attribute profile to use for this application. */ user_attribute_profile_id: string; /** The ID of the connection profile to use for this application. */ connection_profile_id: string; /** When true, all connections made via express configuration will be enabled for this application. */ enable_client: boolean; /** When true, all connections made via express configuration will have the associated organization enabled. */ enable_organization: boolean; /** List of client IDs that are linked to this express configuration (e.g. web or mobile clients). */ linked_clients?: Management.LinkedClientConfiguration[] | undefined; /** This is the unique identifier for the Okta OIN Express Configuration Client, which Okta will use for this application. */ okta_oin_client_id: string; /** This is the domain that admins are expected to log in via for authenticating for express configuration. It can be either the canonical domain or a registered custom domain. */ admin_login_domain: string; /** The identifier of the published application in the OKTA OIN. */ oin_submission_id?: string | undefined; } export interface ExtensibilityEmailProviderCredentials { } export interface FederatedConnectionTokenSet { id?: string | undefined; connection?: string | undefined; scope?: string | undefined; expires_at?: (string | null) | undefined; issued_at?: string | undefined; last_used_at?: (string | null) | undefined; /** Accepts any additional properties */ [key: string]: any; } export type FlowAction = Management.FlowActionActivecampaign | Management.FlowActionAirtable | Management.FlowActionAuth0 | Management.FlowActionBigquery | Management.FlowActionClearbit | Management.FlowActionEmail | Management.FlowActionFlow | Management.FlowActionGoogleSheets | Management.FlowActionHttp | Management.FlowActionHubspot | Management.FlowActionJson | Management.FlowActionJwt | Management.FlowActionMailchimp | Management.FlowActionMailjet | Management.FlowActionOtp | Management.FlowActionPipedrive | Management.FlowActionSalesforce | Management.FlowActionSendgrid | Management.FlowActionSlack | Management.FlowActionStripe | Management.FlowActionTelegram | Management.FlowActionTwilio | Management.FlowActionWhatsapp | Management.FlowActionXml | Management.FlowActionZapier; export type FlowActionActivecampaign = Management.FlowActionActivecampaignListContacts | Management.FlowActionActivecampaignUpsertContact; export interface FlowActionActivecampaignListContacts { id: string; alias?: string | undefined; type: FlowActionActivecampaignListContacts.Type; action: FlowActionActivecampaignListContacts.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionActivecampaignListContactsParams; } export declare namespace FlowActionActivecampaignListContacts { const Type: { readonly Activecampaign: "ACTIVECAMPAIGN"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly ListContacts: "LIST_CONTACTS"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionActivecampaignListContactsParams { connection_id: string; email: string; } export interface FlowActionActivecampaignUpsertContact { id: string; alias?: string | undefined; type: FlowActionActivecampaignUpsertContact.Type; action: FlowActionActivecampaignUpsertContact.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionActivecampaignUpsertContactParams; } export declare namespace FlowActionActivecampaignUpsertContact { const Type: { readonly Activecampaign: "ACTIVECAMPAIGN"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly UpsertContact: "UPSERT_CONTACT"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionActivecampaignUpsertContactParams { connection_id: string; email: string; first_name?: string | undefined; last_name?: string | undefined; phone?: string | undefined; custom_fields?: Management.FlowActionActivecampaignUpsertContactParamsCustomFields | undefined; } export type FlowActionActivecampaignUpsertContactParamsCustomFields = Record; export type FlowActionAirtable = Management.FlowActionAirtableCreateRecord | Management.FlowActionAirtableListRecords | Management.FlowActionAirtableUpdateRecord; export interface FlowActionAirtableCreateRecord { id: string; alias?: string | undefined; type: FlowActionAirtableCreateRecord.Type; action: FlowActionAirtableCreateRecord.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionAirtableCreateRecordParams; } export declare namespace FlowActionAirtableCreateRecord { const Type: { readonly Airtable: "AIRTABLE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly CreateRecord: "CREATE_RECORD"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionAirtableCreateRecordParams { connection_id: string; base_id: string; table_name: string; fields?: Management.FlowActionAirtableCreateRecordParamsFields | undefined; } export type FlowActionAirtableCreateRecordParamsFields = Record; export interface FlowActionAirtableListRecords { id: string; alias?: string | undefined; type: FlowActionAirtableListRecords.Type; action: FlowActionAirtableListRecords.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionAirtableListRecordsParams; } export declare namespace FlowActionAirtableListRecords { const Type: { readonly Airtable: "AIRTABLE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly ListRecords: "LIST_RECORDS"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionAirtableListRecordsParams { connection_id: string; base_id: string; table_name: string; query?: string | undefined; view?: string | undefined; } export interface FlowActionAirtableUpdateRecord { id: string; alias?: string | undefined; type: FlowActionAirtableUpdateRecord.Type; action: FlowActionAirtableUpdateRecord.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionAirtableUpdateRecordParams; } export declare namespace FlowActionAirtableUpdateRecord { const Type: { readonly Airtable: "AIRTABLE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly UpdateRecord: "UPDATE_RECORD"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionAirtableUpdateRecordParams { connection_id: string; base_id: string; table_name: string; record_id: string; fields?: Management.FlowActionAirtableUpdateRecordParamsFields | undefined; } export type FlowActionAirtableUpdateRecordParamsFields = Record; export type FlowActionAuth0 = Management.FlowActionAuth0CreateUser | Management.FlowActionAuth0GetUser | Management.FlowActionAuth0UpdateUser | Management.FlowActionAuth0SendRequest | Management.FlowActionAuth0SendEmail | Management.FlowActionAuth0SendSms | Management.FlowActionAuth0MakeCall; export interface FlowActionAuth0CreateUser { id: string; alias?: string | undefined; type: FlowActionAuth0CreateUser.Type; action: FlowActionAuth0CreateUser.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionAuth0CreateUserParams; } export declare namespace FlowActionAuth0CreateUser { const Type: { readonly Auth0: "AUTH0"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly CreateUser: "CREATE_USER"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionAuth0CreateUserParams { connection_id: string; payload: Management.FlowActionAuth0CreateUserParamsPayload; } export type FlowActionAuth0CreateUserParamsPayload = Record; export interface FlowActionAuth0GetUser { id: string; alias?: string | undefined; type: FlowActionAuth0GetUser.Type; action: FlowActionAuth0GetUser.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionAuth0GetUserParams; } export declare namespace FlowActionAuth0GetUser { const Type: { readonly Auth0: "AUTH0"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly GetUser: "GET_USER"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionAuth0GetUserParams { connection_id: string; user_id: string; } export interface FlowActionAuth0MakeCall { id: string; alias?: string | undefined; type: FlowActionAuth0MakeCall.Type; action: FlowActionAuth0MakeCall.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionAuth0MakeCallParams; } export declare namespace FlowActionAuth0MakeCall { const Type: { readonly Auth0: "AUTH0"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly MakeCall: "MAKE_CALL"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionAuth0MakeCallParams { from?: string | undefined; to: string; message: string; custom_vars?: Management.FlowActionAuth0MakeCallParamsCustomVars | undefined; } export type FlowActionAuth0MakeCallParamsCustomVars = Record; export interface FlowActionAuth0SendEmail { id: string; alias?: string | undefined; type: FlowActionAuth0SendEmail.Type; action: FlowActionAuth0SendEmail.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionAuth0SendEmailParams; } export declare namespace FlowActionAuth0SendEmail { const Type: { readonly Auth0: "AUTH0"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly SendEmail: "SEND_EMAIL"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionAuth0SendEmailParams { from?: Management.FlowActionAuth0SendEmailParamsFrom | undefined; to: Management.FlowActionAuth0SendEmailParamsTo; subject: string; body: string; custom_vars?: Management.FlowActionAuth0SendRequestParamsCustomVars | undefined; } export interface FlowActionAuth0SendEmailParamsFrom { name?: string | undefined; email: Management.FlowActionAuth0SendEmailParamsFromEmail; } export type FlowActionAuth0SendEmailParamsFromEmail = string; export type FlowActionAuth0SendEmailParamsTo = string; export interface FlowActionAuth0SendRequest { id: string; alias?: string | undefined; type: FlowActionAuth0SendRequest.Type; action: FlowActionAuth0SendRequest.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionAuth0SendRequestParams; } export declare namespace FlowActionAuth0SendRequest { const Type: { readonly Auth0: "AUTH0"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly SendRequest: "SEND_REQUEST"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionAuth0SendRequestParams { connection_id: string; pathname: string; method?: FlowActionAuth0SendRequestParams.Method | undefined; headers?: Management.FlowActionAuth0SendRequestParamsHeaders | undefined; params?: Management.FlowActionAuth0SendRequestParamsQueryParams | undefined; payload?: Management.FlowActionAuth0SendRequestParamsPayload | undefined; } export declare namespace FlowActionAuth0SendRequestParams { const Method: { readonly Get: "GET"; readonly Post: "POST"; readonly Put: "PUT"; readonly Patch: "PATCH"; readonly Delete: "DELETE"; }; type Method = (typeof Method)[keyof typeof Method]; } export type FlowActionAuth0SendRequestParamsCustomVars = Record; export type FlowActionAuth0SendRequestParamsHeaders = Record; export type FlowActionAuth0SendRequestParamsPayload = string | unknown[] | Management.FlowActionAuth0SendRequestParamsPayloadObject; export type FlowActionAuth0SendRequestParamsPayloadObject = Record; export type FlowActionAuth0SendRequestParamsQueryParams = Record; export declare namespace FlowActionAuth0SendRequestParamsQueryParams { type Value = number | string; } export interface FlowActionAuth0SendSms { id: string; alias?: string | undefined; type: FlowActionAuth0SendSms.Type; action: FlowActionAuth0SendSms.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionAuth0SendSmsParams; } export declare namespace FlowActionAuth0SendSms { const Type: { readonly Auth0: "AUTH0"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly SendSms: "SEND_SMS"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionAuth0SendSmsParams { from?: string | undefined; to: string; message: string; custom_vars?: Management.FlowActionAuth0SendSmsParamsCustomVars | undefined; } export type FlowActionAuth0SendSmsParamsCustomVars = Record; export interface FlowActionAuth0UpdateUser { id: string; alias?: string | undefined; type: FlowActionAuth0UpdateUser.Type; action: FlowActionAuth0UpdateUser.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionAuth0UpdateUserParams; } export declare namespace FlowActionAuth0UpdateUser { const Type: { readonly Auth0: "AUTH0"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly UpdateUser: "UPDATE_USER"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionAuth0UpdateUserParams { connection_id: string; user_id: string; changes: Management.FlowActionAuth0UpdateUserParamsChanges; } export type FlowActionAuth0UpdateUserParamsChanges = Record; export type FlowActionBigquery = Management.FlowActionBigqueryInsertRows; export interface FlowActionBigqueryInsertRows { id: string; alias?: string | undefined; type: FlowActionBigqueryInsertRows.Type; action: FlowActionBigqueryInsertRows.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionBigqueryInsertRowsParams; } export declare namespace FlowActionBigqueryInsertRows { const Type: { readonly Bigquery: "BIGQUERY"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly InsertRows: "INSERT_ROWS"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionBigqueryInsertRowsParams { connection_id: string; dataset_id: string; table_id: string; data?: Management.FlowActionBigqueryInsertRowsParamsData | undefined; } export type FlowActionBigqueryInsertRowsParamsData = Record; export type FlowActionClearbit = Management.FlowActionClearbitFindPerson | Management.FlowActionClearbitFindCompany; export interface FlowActionClearbitFindCompany { id: string; alias?: string | undefined; type: FlowActionClearbitFindCompany.Type; action: FlowActionClearbitFindCompany.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionClearbitFindCompanyParams; } export declare namespace FlowActionClearbitFindCompany { const Type: { readonly Clearbit: "CLEARBIT"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly FindCompany: "FIND_COMPANY"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionClearbitFindCompanyParams { connection_id: string; domain: string; } export interface FlowActionClearbitFindPerson { id: string; alias?: string | undefined; type: FlowActionClearbitFindPerson.Type; action: FlowActionClearbitFindPerson.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionClearbitFindPersonParams; } export declare namespace FlowActionClearbitFindPerson { const Type: { readonly Clearbit: "CLEARBIT"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly FindPerson: "FIND_PERSON"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionClearbitFindPersonParams { connection_id: string; email: string; } export type FlowActionEmail = Management.FlowActionEmailVerifyEmail; export interface FlowActionEmailVerifyEmail { id: string; alias?: string | undefined; type: FlowActionEmailVerifyEmail.Type; action: FlowActionEmailVerifyEmail.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionEmailVerifyEmailParams; } export declare namespace FlowActionEmailVerifyEmail { const Type: { readonly Email: "EMAIL"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly VerifyEmail: "VERIFY_EMAIL"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionEmailVerifyEmailParams { email: string; rules?: Management.FlowActionEmailVerifyEmailParamsRules | undefined; } export interface FlowActionEmailVerifyEmailParamsRules { require_mx_record?: boolean | undefined; block_aliases?: boolean | undefined; block_free_emails?: boolean | undefined; block_disposable_emails?: boolean | undefined; blocklist?: string[] | undefined; allowlist?: string[] | undefined; } export type FlowActionFlow = Management.FlowActionFlowBooleanCondition | Management.FlowActionFlowDelayFlow | Management.FlowActionFlowDoNothing | Management.FlowActionFlowErrorMessage | Management.FlowActionFlowMapValue | Management.FlowActionFlowReturnJson | Management.FlowActionFlowStoreVars; export interface FlowActionFlowBooleanCondition { id: string; alias?: string | undefined; type: FlowActionFlowBooleanCondition.Type; action: FlowActionFlowBooleanCondition.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionFlowBooleanConditionParams; } export declare namespace FlowActionFlowBooleanCondition { const Type: { readonly Flow: "FLOW"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly BooleanCondition: "BOOLEAN_CONDITION"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionFlowBooleanConditionParams { then?: Management.FlowAction[] | undefined; else?: Management.FlowAction[] | undefined; } export interface FlowActionFlowDelayFlow { id: string; alias?: string | undefined; type: FlowActionFlowDelayFlow.Type; action: FlowActionFlowDelayFlow.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionFlowDelayFlowParams; } export declare namespace FlowActionFlowDelayFlow { const Type: { readonly Flow: "FLOW"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly DelayFlow: "DELAY_FLOW"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionFlowDelayFlowParams { number: Management.FlowActionFlowDelayFlowParamsNumber; units?: FlowActionFlowDelayFlowParams.Units | undefined; } export declare namespace FlowActionFlowDelayFlowParams { const Units: { readonly Seconds: "SECONDS"; readonly Minutes: "MINUTES"; readonly Hours: "HOURS"; readonly Days: "DAYS"; }; type Units = (typeof Units)[keyof typeof Units]; } export type FlowActionFlowDelayFlowParamsNumber = number | string; export interface FlowActionFlowDoNothing { id: string; alias?: string | undefined; type: FlowActionFlowDoNothing.Type; action: FlowActionFlowDoNothing.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params?: Management.FlowActionFlowDoNothingParams | undefined; } export declare namespace FlowActionFlowDoNothing { const Type: { readonly Flow: "FLOW"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly DoNothing: "DO_NOTHING"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionFlowDoNothingParams { } export interface FlowActionFlowErrorMessage { id: string; alias?: string | undefined; type: FlowActionFlowErrorMessage.Type; action: FlowActionFlowErrorMessage.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionFlowErrorMessageParams; } export declare namespace FlowActionFlowErrorMessage { const Type: { readonly Flow: "FLOW"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly ErrorMessage: "ERROR_MESSAGE"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionFlowErrorMessageParams { message: string; } export interface FlowActionFlowMapValue { id: string; alias?: string | undefined; type: FlowActionFlowMapValue.Type; action: FlowActionFlowMapValue.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionFlowMapValueParams; } export declare namespace FlowActionFlowMapValue { const Type: { readonly Flow: "FLOW"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly MapValue: "MAP_VALUE"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionFlowMapValueParams { input: Management.FlowActionFlowMapValueParamsInput; cases?: Management.FlowActionFlowMapValueParamsCases | undefined; fallback?: Management.FlowActionFlowMapValueParamsFallback | undefined; } export type FlowActionFlowMapValueParamsCases = Record; export type FlowActionFlowMapValueParamsFallback = string | number | Management.FlowActionFlowMapValueParamsFallbackObject | unknown[]; export type FlowActionFlowMapValueParamsFallbackObject = Record; export type FlowActionFlowMapValueParamsInput = string | number; export interface FlowActionFlowReturnJson { id: string; alias?: string | undefined; type: FlowActionFlowReturnJson.Type; action: FlowActionFlowReturnJson.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionFlowReturnJsonParams; } export declare namespace FlowActionFlowReturnJson { const Type: { readonly Flow: "FLOW"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly ReturnJson: "RETURN_JSON"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionFlowReturnJsonParams { payload: Management.FlowActionFlowReturnJsonParamsPayload; } export type FlowActionFlowReturnJsonParamsPayload = Management.FlowActionFlowReturnJsonParamsPayloadObject | string; export type FlowActionFlowReturnJsonParamsPayloadObject = Record; export interface FlowActionFlowStoreVars { id: string; alias?: string | undefined; type: FlowActionFlowStoreVars.Type; action: FlowActionFlowStoreVars.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionFlowStoreVarsParams; } export declare namespace FlowActionFlowStoreVars { const Type: { readonly Flow: "FLOW"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly StoreVars: "STORE_VARS"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionFlowStoreVarsParams { vars: Management.FlowActionFlowStoreVarsParamsVars; } export type FlowActionFlowStoreVarsParamsVars = Record; export type FlowActionGoogleSheets = Management.FlowActionGoogleSheetsAddRow; export interface FlowActionGoogleSheetsAddRow { id: string; alias?: string | undefined; type: FlowActionGoogleSheetsAddRow.Type; action: FlowActionGoogleSheetsAddRow.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionGoogleSheetsAddRowParams; } export declare namespace FlowActionGoogleSheetsAddRow { const Type: { readonly GoogleSheets: "GOOGLE_SHEETS"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly AddRow: "ADD_ROW"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionGoogleSheetsAddRowParams { connection_id: string; spreadsheet_id: string; sheet_id?: Management.FlowActionGoogleSheetsAddRowParamsSheetId | undefined; values?: Management.FlowActionGoogleSheetsAddRowParamsValues | undefined; } export type FlowActionGoogleSheetsAddRowParamsSheetId = number | string; export type FlowActionGoogleSheetsAddRowParamsValues = ((string | null) | undefined)[]; export type FlowActionHttp = Management.FlowActionHttpSendRequest; export interface FlowActionHttpSendRequest { id: string; alias?: string | undefined; type: FlowActionHttpSendRequest.Type; action: FlowActionHttpSendRequest.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionHttpSendRequestParams; } export declare namespace FlowActionHttpSendRequest { const Type: { readonly Http: "HTTP"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly SendRequest: "SEND_REQUEST"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionHttpSendRequestParams { connection_id?: string | undefined; url: string; method?: FlowActionHttpSendRequestParams.Method | undefined; headers?: Management.FlowActionHttpSendRequestParamsHeaders | undefined; basic?: Management.FlowActionHttpSendRequestParamsBasicAuth | undefined; params?: Management.FlowActionHttpSendRequestParamsQueryParams | undefined; payload?: Management.FlowActionHttpSendRequestParamsPayload | undefined; content_type?: FlowActionHttpSendRequestParams.ContentType | undefined; } export declare namespace FlowActionHttpSendRequestParams { const Method: { readonly Get: "GET"; readonly Post: "POST"; readonly Put: "PUT"; readonly Patch: "PATCH"; readonly Delete: "DELETE"; }; type Method = (typeof Method)[keyof typeof Method]; const ContentType: { readonly Json: "JSON"; readonly Form: "FORM"; readonly Xml: "XML"; }; type ContentType = (typeof ContentType)[keyof typeof ContentType]; } export interface FlowActionHttpSendRequestParamsBasicAuth { username?: string | undefined; password?: string | undefined; } export type FlowActionHttpSendRequestParamsHeaders = Record; export type FlowActionHttpSendRequestParamsPayload = string | unknown[] | Management.FlowActionHttpSendRequestParamsPayloadObject; export type FlowActionHttpSendRequestParamsPayloadObject = Record; export type FlowActionHttpSendRequestParamsQueryParams = Record; export declare namespace FlowActionHttpSendRequestParamsQueryParams { type Value = number | string; } export type FlowActionHubspot = Management.FlowActionHubspotEnrollContact | Management.FlowActionHubspotGetContact | Management.FlowActionHubspotUpsertContact; export interface FlowActionHubspotEnrollContact { id: string; alias?: string | undefined; type: FlowActionHubspotEnrollContact.Type; action: FlowActionHubspotEnrollContact.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionHubspotEnrollContactParams; } export declare namespace FlowActionHubspotEnrollContact { const Type: { readonly Hubspot: "HUBSPOT"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly EnrollContact: "ENROLL_CONTACT"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionHubspotEnrollContactParams { connection_id: string; email: string; workflow_id: Management.FlowActionHubspotEnrollContactParamsWorkflowId; } export type FlowActionHubspotEnrollContactParamsWorkflowId = string | number; export interface FlowActionHubspotGetContact { id: string; alias?: string | undefined; type: FlowActionHubspotGetContact.Type; action: FlowActionHubspotGetContact.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionHubspotGetContactParams; } export declare namespace FlowActionHubspotGetContact { const Type: { readonly Hubspot: "HUBSPOT"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly GetContact: "GET_CONTACT"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionHubspotGetContactParams { connection_id: string; email: string; } export interface FlowActionHubspotUpsertContact { id: string; alias?: string | undefined; type: FlowActionHubspotUpsertContact.Type; action: FlowActionHubspotUpsertContact.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionHubspotUpsertContactParams; } export declare namespace FlowActionHubspotUpsertContact { const Type: { readonly Hubspot: "HUBSPOT"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly UpsertContact: "UPSERT_CONTACT"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionHubspotUpsertContactParams { connection_id: string; email: string; properties?: Management.FlowActionHubspotUpsertContactParamsProperty[] | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface FlowActionHubspotUpsertContactParamsProperty { property: string; } export type FlowActionJson = Management.FlowActionJsonCreateJson | Management.FlowActionJsonParseJson | Management.FlowActionJsonSerializeJson; export interface FlowActionJsonCreateJson { id: string; alias?: string | undefined; type: FlowActionJsonCreateJson.Type; action: FlowActionJsonCreateJson.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionJsonCreateJsonParams; } export declare namespace FlowActionJsonCreateJson { const Type: { readonly Json: "JSON"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly CreateJson: "CREATE_JSON"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionJsonCreateJsonParams { object: Management.FlowActionJsonCreateJsonParamsObject; } export type FlowActionJsonCreateJsonParamsObject = Record; export interface FlowActionJsonParseJson { id: string; alias?: string | undefined; type: FlowActionJsonParseJson.Type; action: FlowActionJsonParseJson.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionJsonParseJsonParams; } export declare namespace FlowActionJsonParseJson { const Type: { readonly Json: "JSON"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly ParseJson: "PARSE_JSON"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionJsonParseJsonParams { json: string; } export interface FlowActionJsonSerializeJson { id: string; alias?: string | undefined; type: FlowActionJsonSerializeJson.Type; action: FlowActionJsonSerializeJson.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionJsonSerializeJsonParams; } export declare namespace FlowActionJsonSerializeJson { const Type: { readonly Json: "JSON"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly SerializeJson: "SERIALIZE_JSON"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionJsonSerializeJsonParams { object: Management.FlowActionJsonSerializeJsonParamsObject; } export type FlowActionJsonSerializeJsonParamsObject = string | Management.FlowActionJsonSerializeJsonParamsObjectObject; export type FlowActionJsonSerializeJsonParamsObjectObject = Record; export type FlowActionJwt = Management.FlowActionJwtDecodeJwt | Management.FlowActionJwtSignJwt | Management.FlowActionJwtVerifyJwt; export interface FlowActionJwtDecodeJwt { id: string; alias?: string | undefined; type: FlowActionJwtDecodeJwt.Type; action: FlowActionJwtDecodeJwt.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionJwtDecodeJwtParams; } export declare namespace FlowActionJwtDecodeJwt { const Type: { readonly Jwt: "JWT"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly DecodeJwt: "DECODE_JWT"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionJwtDecodeJwtParams { token: string; } export interface FlowActionJwtSignJwt { id: string; alias?: string | undefined; type: FlowActionJwtSignJwt.Type; action: FlowActionJwtSignJwt.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionJwtSignJwtParams; } export declare namespace FlowActionJwtSignJwt { const Type: { readonly Jwt: "JWT"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly SignJwt: "SIGN_JWT"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionJwtSignJwtParams { connection_id: string; payload?: Management.FlowActionJwtSignJwtParamsPayload | undefined; subject?: string | undefined; issuer?: string | undefined; audience?: string | undefined; expires_in?: string | undefined; } export type FlowActionJwtSignJwtParamsPayload = Record; export interface FlowActionJwtVerifyJwt { id: string; alias?: string | undefined; type: FlowActionJwtVerifyJwt.Type; action: FlowActionJwtVerifyJwt.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionJwtVerifyJwtParams; } export declare namespace FlowActionJwtVerifyJwt { const Type: { readonly Jwt: "JWT"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly VerifyJwt: "VERIFY_JWT"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionJwtVerifyJwtParams { connection_id: string; token: string; audience?: string | undefined; issuer?: string | undefined; } export type FlowActionMailchimp = Management.FlowActionMailchimpUpsertMember; export interface FlowActionMailchimpUpsertMember { id: string; alias?: string | undefined; type: FlowActionMailchimpUpsertMember.Type; action: FlowActionMailchimpUpsertMember.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionMailchimpUpsertMemberParams; } export declare namespace FlowActionMailchimpUpsertMember { const Type: { readonly Mailchimp: "MAILCHIMP"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly UpsertMember: "UPSERT_MEMBER"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionMailchimpUpsertMemberParams { connection_id: string; list_id: string; member: Management.FlowActionMailchimpUpsertMemberParamsMember; } export interface FlowActionMailchimpUpsertMemberParamsMember { email_address: string; status_if_new: string; merge_fields?: Management.FlowActionMailchimpUpsertMemberParamsMemberMergeFields | undefined; } export type FlowActionMailchimpUpsertMemberParamsMemberMergeFields = Record; export type FlowActionMailjet = Management.FlowActionMailjetSendEmail; export interface FlowActionMailjetSendEmail { id: string; alias?: string | undefined; type: FlowActionMailjetSendEmail.Type; action: FlowActionMailjetSendEmail.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionMailjetSendEmailParams; } export declare namespace FlowActionMailjetSendEmail { const Type: { readonly Mailjet: "MAILJET"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly SendEmail: "SEND_EMAIL"; }; type Action = (typeof Action)[keyof typeof Action]; } export type FlowActionMailjetSendEmailParams = { content: string; [key: string]: any; } | { template_id: number; variables?: Record | undefined; [key: string]: any; }; export type FlowActionOtp = Management.FlowActionOtpGenerateCode | Management.FlowActionOtpVerifyCode; export interface FlowActionOtpGenerateCode { id: string; alias?: string | undefined; type: FlowActionOtpGenerateCode.Type; action: FlowActionOtpGenerateCode.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionOtpGenerateCodeParams; } export declare namespace FlowActionOtpGenerateCode { const Type: { readonly Otp: "OTP"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly GenerateCode: "GENERATE_CODE"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionOtpGenerateCodeParams { reference: string; length: number; } export interface FlowActionOtpVerifyCode { id: string; alias?: string | undefined; type: FlowActionOtpVerifyCode.Type; action: FlowActionOtpVerifyCode.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionOtpVerifyCodeParams; } export declare namespace FlowActionOtpVerifyCode { const Type: { readonly Otp: "OTP"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly VerifyCode: "VERIFY_CODE"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionOtpVerifyCodeParams { reference: string; code: Management.FlowActionOtpVerifyCodeParamsCode; } export type FlowActionOtpVerifyCodeParamsCode = number | string; export type FlowActionPipedrive = Management.FlowActionPipedriveAddDeal | Management.FlowActionPipedriveAddOrganization | Management.FlowActionPipedriveAddPerson; export interface FlowActionPipedriveAddDeal { id: string; alias?: string | undefined; type: FlowActionPipedriveAddDeal.Type; action: FlowActionPipedriveAddDeal.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionPipedriveAddDealParams; } export declare namespace FlowActionPipedriveAddDeal { const Type: { readonly Pipedrive: "PIPEDRIVE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly AddDeal: "ADD_DEAL"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionPipedriveAddDealParams { connection_id: string; title: string; value?: string | undefined; user_id?: Management.FlowActionPipedriveAddDealParamsUserId | undefined; person_id?: Management.FlowActionPipedriveAddDealParamsPersonId | undefined; organization_id?: Management.FlowActionPipedriveAddDealParamsOrganizationId | undefined; stage_id?: Management.FlowActionPipedriveAddDealParamsStageId | undefined; fields?: Management.FlowActionPipedriveAddDealParamsFields | undefined; } export type FlowActionPipedriveAddDealParamsFields = Record; export type FlowActionPipedriveAddDealParamsOrganizationId = string | number; export type FlowActionPipedriveAddDealParamsPersonId = string | number; export type FlowActionPipedriveAddDealParamsStageId = string | number; export type FlowActionPipedriveAddDealParamsUserId = string | number; export interface FlowActionPipedriveAddOrganization { id: string; alias?: string | undefined; type: FlowActionPipedriveAddOrganization.Type; action: FlowActionPipedriveAddOrganization.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionPipedriveAddOrganizationParams; } export declare namespace FlowActionPipedriveAddOrganization { const Type: { readonly Pipedrive: "PIPEDRIVE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly AddOrganization: "ADD_ORGANIZATION"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionPipedriveAddOrganizationParams { connection_id: string; name: string; owner_id?: Management.FlowActionPipedriveAddOrganizationParamsOwnerId | undefined; fields?: Management.FlowActionPipedriveAddOrganizationParamsFields | undefined; } export type FlowActionPipedriveAddOrganizationParamsFields = Record; export type FlowActionPipedriveAddOrganizationParamsOwnerId = string | number; export interface FlowActionPipedriveAddPerson { id: string; alias?: string | undefined; type: FlowActionPipedriveAddPerson.Type; action: FlowActionPipedriveAddPerson.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionPipedriveAddPersonParams; } export declare namespace FlowActionPipedriveAddPerson { const Type: { readonly Pipedrive: "PIPEDRIVE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly AddPerson: "ADD_PERSON"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionPipedriveAddPersonParams { connection_id: string; name: string; email?: string | undefined; phone?: string | undefined; owner_id?: Management.FlowActionPipedriveAddPersonParamsOwnerId | undefined; organization_id?: Management.FlowActionPipedriveAddPersonParamsOrganizationId | undefined; fields?: Management.FlowActionPipedriveAddPersonParamsFields | undefined; } export type FlowActionPipedriveAddPersonParamsFields = Record; export type FlowActionPipedriveAddPersonParamsOrganizationId = string | number; export type FlowActionPipedriveAddPersonParamsOwnerId = string | number; export type FlowActionSalesforce = Management.FlowActionSalesforceCreateLead | Management.FlowActionSalesforceGetLead | Management.FlowActionSalesforceSearchLeads | Management.FlowActionSalesforceUpdateLead; export interface FlowActionSalesforceCreateLead { id: string; alias?: string | undefined; type: FlowActionSalesforceCreateLead.Type; action: FlowActionSalesforceCreateLead.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionSalesforceCreateLeadParams; } export declare namespace FlowActionSalesforceCreateLead { const Type: { readonly Salesforce: "SALESFORCE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly CreateLead: "CREATE_LEAD"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionSalesforceCreateLeadParams { connection_id: string; first_name?: string | undefined; last_name: string; company: string; email?: string | undefined; phone?: string | undefined; payload?: Management.FlowActionSalesforceCreateLeadParamsPayload | undefined; } export type FlowActionSalesforceCreateLeadParamsPayload = Record; export interface FlowActionSalesforceGetLead { id: string; alias?: string | undefined; type: FlowActionSalesforceGetLead.Type; action: FlowActionSalesforceGetLead.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionSalesforceGetLeadParams; } export declare namespace FlowActionSalesforceGetLead { const Type: { readonly Salesforce: "SALESFORCE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly GetLead: "GET_LEAD"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionSalesforceGetLeadParams { connection_id: string; lead_id: string; } export interface FlowActionSalesforceSearchLeads { id: string; alias?: string | undefined; type: FlowActionSalesforceSearchLeads.Type; action: FlowActionSalesforceSearchLeads.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionSalesforceSearchLeadsParams; } export declare namespace FlowActionSalesforceSearchLeads { const Type: { readonly Salesforce: "SALESFORCE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly SearchLeads: "SEARCH_LEADS"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionSalesforceSearchLeadsParams { connection_id: string; search_field: FlowActionSalesforceSearchLeadsParams.SearchField; search_value: string; lead_fields: string[]; } export declare namespace FlowActionSalesforceSearchLeadsParams { const SearchField: { readonly Email: "email"; readonly Name: "name"; readonly Phone: "phone"; readonly All: "all"; }; type SearchField = (typeof SearchField)[keyof typeof SearchField]; } export interface FlowActionSalesforceUpdateLead { id: string; alias?: string | undefined; type: FlowActionSalesforceUpdateLead.Type; action: FlowActionSalesforceUpdateLead.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionSalesforceUpdateLeadParams; } export declare namespace FlowActionSalesforceUpdateLead { const Type: { readonly Salesforce: "SALESFORCE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly UpdateLead: "UPDATE_LEAD"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionSalesforceUpdateLeadParams { connection_id: string; lead_id: string; payload?: Management.FlowActionSalesforceUpdateLeadParamsPayload | undefined; } export type FlowActionSalesforceUpdateLeadParamsPayload = Record; export type FlowActionSendgrid = Management.FlowActionSendgridSendEmail; export interface FlowActionSendgridSendEmail { id: string; alias?: string | undefined; type: FlowActionSendgridSendEmail.Type; action: FlowActionSendgridSendEmail.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionSendgridSendEmailParams; } export declare namespace FlowActionSendgridSendEmail { const Type: { readonly Sendgrid: "SENDGRID"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly SendEmail: "SEND_EMAIL"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionSendgridSendEmailParams { connection_id: string; from: Management.FlowActionSendgridSendEmailParamsPerson; personalizations: unknown[]; /** Accepts any additional properties */ [key: string]: any; } export interface FlowActionSendgridSendEmailParamsPerson { name?: string | undefined; email: string; } export type FlowActionSlack = Management.FlowActionSlackPostMessage; export interface FlowActionSlackPostMessage { id: string; alias?: string | undefined; type: FlowActionSlackPostMessage.Type; action: FlowActionSlackPostMessage.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionSlackPostMessageParams; } export declare namespace FlowActionSlackPostMessage { const Type: { readonly Slack: "SLACK"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly PostMessage: "POST_MESSAGE"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionSlackPostMessageParams { connection_id: string; text?: string | undefined; attachments?: Management.FlowActionSlackPostMessageParamsAttachment[] | undefined; } export interface FlowActionSlackPostMessageParamsAttachment { color?: FlowActionSlackPostMessageParamsAttachment.Color | undefined; pretext?: string | undefined; text?: string | undefined; fields?: Management.FlowActionSlackPostMessageParamsAttachmentField[] | undefined; } export declare namespace FlowActionSlackPostMessageParamsAttachment { const Color: { readonly Good: "GOOD"; readonly Warning: "WARNING"; readonly Danger: "DANGER"; }; type Color = (typeof Color)[keyof typeof Color]; } export interface FlowActionSlackPostMessageParamsAttachmentField { title: string; value?: string | undefined; short?: boolean | undefined; } export type FlowActionStripe = Management.FlowActionStripeAddTaxId | Management.FlowActionStripeCreateCustomer | Management.FlowActionStripeCreatePortalSession | Management.FlowActionStripeDeleteTaxId | Management.FlowActionStripeFindCustomers | Management.FlowActionStripeGetCustomer | Management.FlowActionStripeUpdateCustomer; export interface FlowActionStripeAddTaxId { id: string; alias?: string | undefined; type: FlowActionStripeAddTaxId.Type; action: FlowActionStripeAddTaxId.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionStripeAddTaxIdParams; } export declare namespace FlowActionStripeAddTaxId { const Type: { readonly Stripe: "STRIPE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly AddTaxId: "ADD_TAX_ID"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionStripeAddTaxIdParams { connection_id: string; customer_id: string; type: string; value: string; } export interface FlowActionStripeAddress { line1?: string | undefined; line2?: string | undefined; postalCode?: string | undefined; city?: string | undefined; state?: string | undefined; country?: string | undefined; } export interface FlowActionStripeCreateCustomer { id: string; alias?: string | undefined; type: FlowActionStripeCreateCustomer.Type; action: FlowActionStripeCreateCustomer.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionStripeCreateCustomerParams; } export declare namespace FlowActionStripeCreateCustomer { const Type: { readonly Stripe: "STRIPE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly CreateCustomer: "CREATE_CUSTOMER"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionStripeCreateCustomerParams { connection_id: string; tax_id?: Management.FlowActionStripeTaxId | undefined; name?: string | undefined; description?: string | undefined; email?: string | undefined; phone?: string | undefined; tax_exempt?: string | undefined; address?: Management.FlowActionStripeAddress | undefined; metadata?: Management.FlowActionStripeMetadata | undefined; } export interface FlowActionStripeCreatePortalSession { id: string; alias?: string | undefined; type: FlowActionStripeCreatePortalSession.Type; action: FlowActionStripeCreatePortalSession.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionStripeCreatePortalSessionParams; } export declare namespace FlowActionStripeCreatePortalSession { const Type: { readonly Stripe: "STRIPE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly CreatePortalSession: "CREATE_PORTAL_SESSION"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionStripeCreatePortalSessionParams { connection_id: string; customer_id: string; return_url?: string | undefined; } export interface FlowActionStripeDeleteTaxId { id: string; alias?: string | undefined; type: FlowActionStripeDeleteTaxId.Type; action: FlowActionStripeDeleteTaxId.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionStripeDeleteTaxIdParams; } export declare namespace FlowActionStripeDeleteTaxId { const Type: { readonly Stripe: "STRIPE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly DeleteTaxId: "DELETE_TAX_ID"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionStripeDeleteTaxIdParams { connection_id: string; customer_id: string; id: string; } export interface FlowActionStripeFindCustomers { id: string; alias?: string | undefined; type: FlowActionStripeFindCustomers.Type; action: FlowActionStripeFindCustomers.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionStripeFindCustomersParams; } export declare namespace FlowActionStripeFindCustomers { const Type: { readonly Stripe: "STRIPE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly FindCustomers: "FIND_CUSTOMERS"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionStripeFindCustomersParams { connection_id: string; email: string; } export interface FlowActionStripeGetCustomer { id: string; alias?: string | undefined; type: FlowActionStripeGetCustomer.Type; action: FlowActionStripeGetCustomer.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionStripeGetCustomerParams; } export declare namespace FlowActionStripeGetCustomer { const Type: { readonly Stripe: "STRIPE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly GetCustomer: "GET_CUSTOMER"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionStripeGetCustomerParams { connection_id: string; id: string; } export type FlowActionStripeMetadata = Record; export interface FlowActionStripeTaxId { type: string; value: string; } export interface FlowActionStripeUpdateCustomer { id: string; alias?: string | undefined; type: FlowActionStripeUpdateCustomer.Type; action: FlowActionStripeUpdateCustomer.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionStripeUpdateCustomerParams; } export declare namespace FlowActionStripeUpdateCustomer { const Type: { readonly Stripe: "STRIPE"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly UpdateCustomer: "UPDATE_CUSTOMER"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionStripeUpdateCustomerParams { connection_id: string; id: string; name?: string | undefined; description?: string | undefined; email?: string | undefined; phone?: string | undefined; tax_exempt?: string | undefined; address?: Management.FlowActionStripeAddress | undefined; metadata?: Management.FlowActionStripeMetadata | undefined; } export type FlowActionTelegram = Management.FlowActionTelegramSendMessage; export interface FlowActionTelegramSendMessage { id: string; alias?: string | undefined; type: FlowActionTelegramSendMessage.Type; action: FlowActionTelegramSendMessage.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionTelegramSendMessageParams; } export declare namespace FlowActionTelegramSendMessage { const Type: { readonly Telegram: "TELEGRAM"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly SendMessage: "SEND_MESSAGE"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionTelegramSendMessageParams { connection_id: string; chat_id: string; text: string; } export type FlowActionTwilio = Management.FlowActionTwilioMakeCall | Management.FlowActionTwilioSendSms; export interface FlowActionTwilioMakeCall { id: string; alias?: string | undefined; type: FlowActionTwilioMakeCall.Type; action: FlowActionTwilioMakeCall.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionTwilioMakeCallParams; } export declare namespace FlowActionTwilioMakeCall { const Type: { readonly Twilio: "TWILIO"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly MakeCall: "MAKE_CALL"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionTwilioMakeCallParams { connection_id: string; from: string; to: string; payload: string; } export interface FlowActionTwilioSendSms { id: string; alias?: string | undefined; type: FlowActionTwilioSendSms.Type; action: FlowActionTwilioSendSms.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionTwilioSendSmsParams; } export declare namespace FlowActionTwilioSendSms { const Type: { readonly Twilio: "TWILIO"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly SendSms: "SEND_SMS"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionTwilioSendSmsParams { connection_id: string; from: string; to: string; message: string; } export type FlowActionWhatsapp = Management.FlowActionWhatsappSendMessage; export interface FlowActionWhatsappSendMessage { id: string; alias?: string | undefined; type: FlowActionWhatsappSendMessage.Type; action: FlowActionWhatsappSendMessage.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionWhatsappSendMessageParams; } export declare namespace FlowActionWhatsappSendMessage { const Type: { readonly Whatsapp: "WHATSAPP"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly SendMessage: "SEND_MESSAGE"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionWhatsappSendMessageParams { connection_id: string; sender_id: string; recipient_number: string; type: FlowActionWhatsappSendMessageParams.Type; payload: Management.FlowActionWhatsappSendMessageParamsPayload; } export declare namespace FlowActionWhatsappSendMessageParams { const Type: { readonly Audio: "AUDIO"; readonly Contacts: "CONTACTS"; readonly Document: "DOCUMENT"; readonly Image: "IMAGE"; readonly Interactive: "INTERACTIVE"; readonly Location: "LOCATION"; readonly Sticker: "STICKER"; readonly Template: "TEMPLATE"; readonly Text: "TEXT"; }; type Type = (typeof Type)[keyof typeof Type]; } export type FlowActionWhatsappSendMessageParamsPayload = Management.FlowActionWhatsappSendMessageParamsPayloadObject | string; export type FlowActionWhatsappSendMessageParamsPayloadObject = Record; export type FlowActionXml = Management.FlowActionXmlParseXml | Management.FlowActionXmlSerializeXml; export interface FlowActionXmlParseXml { id: string; alias?: string | undefined; type: FlowActionXmlParseXml.Type; action: FlowActionXmlParseXml.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionXmlParseXmlParams; } export declare namespace FlowActionXmlParseXml { const Type: { readonly Xml: "XML"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly ParseXml: "PARSE_XML"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionXmlParseXmlParams { xml: string; } export interface FlowActionXmlSerializeXml { id: string; alias?: string | undefined; type: FlowActionXmlSerializeXml.Type; action: FlowActionXmlSerializeXml.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionXmlSerializeXmlParams; } export declare namespace FlowActionXmlSerializeXml { const Type: { readonly Xml: "XML"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly SerializeXml: "SERIALIZE_XML"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionXmlSerializeXmlParams { object: Management.FlowActionXmlSerializeXmlParamsObject; } export type FlowActionXmlSerializeXmlParamsObject = string | Management.FlowActionXmlSerializeXmlParamsObjectObject; export type FlowActionXmlSerializeXmlParamsObjectObject = Record; export type FlowActionZapier = Management.FlowActionZapierTriggerWebhook; export interface FlowActionZapierTriggerWebhook { id: string; alias?: string | undefined; type: FlowActionZapierTriggerWebhook.Type; action: FlowActionZapierTriggerWebhook.Action; allow_failure?: boolean | undefined; mask_output?: boolean | undefined; params: Management.FlowActionZapierTriggerWebhookParams; } export declare namespace FlowActionZapierTriggerWebhook { const Type: { readonly Zapier: "ZAPIER"; }; type Type = (typeof Type)[keyof typeof Type]; const Action: { readonly TriggerWebhook: "TRIGGER_WEBHOOK"; }; type Action = (typeof Action)[keyof typeof Action]; } export interface FlowActionZapierTriggerWebhookParams { connection_id: string; method?: FlowActionZapierTriggerWebhookParams.Method | undefined; /** Accepts any additional properties */ [key: string]: any; } export declare namespace FlowActionZapierTriggerWebhookParams { const Method: { readonly Get: "GET"; readonly Post: "POST"; readonly Put: "PUT"; }; type Method = (typeof Method)[keyof typeof Method]; } /** * Flow execution debug. */ export type FlowExecutionDebug = Record; export interface FlowExecutionSummary { /** Flow execution identifier */ id: string; /** Trace id */ trace_id: string; /** Journey id */ journey_id?: string | undefined; /** Execution status */ status: string; /** The ISO 8601 formatted date when this flow execution was created. */ created_at: string; /** The ISO 8601 formatted date when this flow execution was updated. */ updated_at: string; /** The ISO 8601 formatted date when this flow execution started. */ started_at?: string | undefined; /** The ISO 8601 formatted date when this flow execution ended. */ ended_at?: string | undefined; } export interface FlowSummary { id: string; name: string; created_at: string; updated_at: string; executed_at?: string | undefined; } export interface FlowsVaultConnectioSetupApiKey { type: Management.FlowsVaultConnectioSetupTypeApiKeyEnum; api_key: string; } export interface FlowsVaultConnectioSetupApiKeyWithBaseUrl { type: Management.FlowsVaultConnectioSetupTypeApiKeyEnum; api_key: string; base_url: string; } export interface FlowsVaultConnectioSetupBigqueryOauthJwt { type?: Management.FlowsVaultConnectioSetupTypeOauthJwtEnum | undefined; project_id?: string | undefined; private_key?: string | undefined; client_email?: string | undefined; } export interface FlowsVaultConnectioSetupHttpBearer { type: Management.FlowsVaultConnectioSetupTypeBearerEnum; token: string; } export interface FlowsVaultConnectioSetupJwt { type: Management.FlowsVaultConnectioSetupTypeJwtEnum; algorithm: Management.FlowsVaultConnectioSetupJwtAlgorithmEnum; /** Accepts any additional properties */ [key: string]: any; } export declare const FlowsVaultConnectioSetupJwtAlgorithmEnum: { readonly Hs256: "HS256"; readonly Hs384: "HS384"; readonly Hs512: "HS512"; readonly Rs256: "RS256"; readonly Rs384: "RS384"; readonly Rs512: "RS512"; readonly Es256: "ES256"; readonly Es384: "ES384"; readonly Es512: "ES512"; readonly Ps256: "PS256"; readonly Ps384: "PS384"; readonly Ps512: "PS512"; }; export type FlowsVaultConnectioSetupJwtAlgorithmEnum = (typeof FlowsVaultConnectioSetupJwtAlgorithmEnum)[keyof typeof FlowsVaultConnectioSetupJwtAlgorithmEnum]; export interface FlowsVaultConnectioSetupMailjetApiKey { type: Management.FlowsVaultConnectioSetupTypeApiKeyEnum; api_key: string; secret_key: string; } export interface FlowsVaultConnectioSetupOauthApp { type: Management.FlowsVaultConnectioSetupTypeOauthAppEnum; client_id: string; client_secret: string; domain: string; audience?: string | undefined; } export interface FlowsVaultConnectioSetupOauthCode { type?: Management.FlowsVaultConnectioSetupTypeOauthCodeEnum | undefined; code?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface FlowsVaultConnectioSetupSecretApiKey { type: Management.FlowsVaultConnectioSetupTypeApiKeyEnum; secret_key: string; } export interface FlowsVaultConnectioSetupStripeKeyPair { type: Management.FlowsVaultConnectioSetupTypeKeyPairEnum; private_key: string; public_key: string; } export interface FlowsVaultConnectioSetupToken { type: Management.FlowsVaultConnectioSetupTypeTokenEnum; token: string; } export interface FlowsVaultConnectioSetupTwilioApiKey { type: Management.FlowsVaultConnectioSetupTypeApiKeyEnum; account_id: string; api_key: string; } export declare const FlowsVaultConnectioSetupTypeApiKeyEnum: { readonly ApiKey: "API_KEY"; }; export type FlowsVaultConnectioSetupTypeApiKeyEnum = (typeof FlowsVaultConnectioSetupTypeApiKeyEnum)[keyof typeof FlowsVaultConnectioSetupTypeApiKeyEnum]; export declare const FlowsVaultConnectioSetupTypeBearerEnum: { readonly Bearer: "BEARER"; }; export type FlowsVaultConnectioSetupTypeBearerEnum = (typeof FlowsVaultConnectioSetupTypeBearerEnum)[keyof typeof FlowsVaultConnectioSetupTypeBearerEnum]; export declare const FlowsVaultConnectioSetupTypeJwtEnum: { readonly Jwt: "JWT"; }; export type FlowsVaultConnectioSetupTypeJwtEnum = (typeof FlowsVaultConnectioSetupTypeJwtEnum)[keyof typeof FlowsVaultConnectioSetupTypeJwtEnum]; export declare const FlowsVaultConnectioSetupTypeKeyPairEnum: { readonly KeyPair: "KEY_PAIR"; }; export type FlowsVaultConnectioSetupTypeKeyPairEnum = (typeof FlowsVaultConnectioSetupTypeKeyPairEnum)[keyof typeof FlowsVaultConnectioSetupTypeKeyPairEnum]; export declare const FlowsVaultConnectioSetupTypeOauthAppEnum: { readonly OauthApp: "OAUTH_APP"; }; export type FlowsVaultConnectioSetupTypeOauthAppEnum = (typeof FlowsVaultConnectioSetupTypeOauthAppEnum)[keyof typeof FlowsVaultConnectioSetupTypeOauthAppEnum]; export declare const FlowsVaultConnectioSetupTypeOauthCodeEnum: { readonly OauthCode: "OAUTH_CODE"; }; export type FlowsVaultConnectioSetupTypeOauthCodeEnum = (typeof FlowsVaultConnectioSetupTypeOauthCodeEnum)[keyof typeof FlowsVaultConnectioSetupTypeOauthCodeEnum]; export declare const FlowsVaultConnectioSetupTypeOauthJwtEnum: { readonly OauthJwt: "OAUTH_JWT"; }; export type FlowsVaultConnectioSetupTypeOauthJwtEnum = (typeof FlowsVaultConnectioSetupTypeOauthJwtEnum)[keyof typeof FlowsVaultConnectioSetupTypeOauthJwtEnum]; export declare const FlowsVaultConnectioSetupTypeTokenEnum: { readonly Token: "TOKEN"; }; export type FlowsVaultConnectioSetupTypeTokenEnum = (typeof FlowsVaultConnectioSetupTypeTokenEnum)[keyof typeof FlowsVaultConnectioSetupTypeTokenEnum]; export declare const FlowsVaultConnectioSetupTypeWebhookEnum: { readonly Webhook: "WEBHOOK"; }; export type FlowsVaultConnectioSetupTypeWebhookEnum = (typeof FlowsVaultConnectioSetupTypeWebhookEnum)[keyof typeof FlowsVaultConnectioSetupTypeWebhookEnum]; export interface FlowsVaultConnectioSetupWebhook { type: Management.FlowsVaultConnectioSetupTypeWebhookEnum; url: string; } /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdActivecampaignEnum: { readonly Activecampaign: "ACTIVECAMPAIGN"; }; export type FlowsVaultConnectionAppIdActivecampaignEnum = (typeof FlowsVaultConnectionAppIdActivecampaignEnum)[keyof typeof FlowsVaultConnectionAppIdActivecampaignEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdAirtableEnum: { readonly Airtable: "AIRTABLE"; }; export type FlowsVaultConnectionAppIdAirtableEnum = (typeof FlowsVaultConnectionAppIdAirtableEnum)[keyof typeof FlowsVaultConnectionAppIdAirtableEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdAuth0Enum: { readonly Auth0: "AUTH0"; }; export type FlowsVaultConnectionAppIdAuth0Enum = (typeof FlowsVaultConnectionAppIdAuth0Enum)[keyof typeof FlowsVaultConnectionAppIdAuth0Enum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdBigqueryEnum: { readonly Bigquery: "BIGQUERY"; }; export type FlowsVaultConnectionAppIdBigqueryEnum = (typeof FlowsVaultConnectionAppIdBigqueryEnum)[keyof typeof FlowsVaultConnectionAppIdBigqueryEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdClearbitEnum: { readonly Clearbit: "CLEARBIT"; }; export type FlowsVaultConnectionAppIdClearbitEnum = (typeof FlowsVaultConnectionAppIdClearbitEnum)[keyof typeof FlowsVaultConnectionAppIdClearbitEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdDocusignEnum: { readonly Docusign: "DOCUSIGN"; }; export type FlowsVaultConnectionAppIdDocusignEnum = (typeof FlowsVaultConnectionAppIdDocusignEnum)[keyof typeof FlowsVaultConnectionAppIdDocusignEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdGoogleSheetsEnum: { readonly GoogleSheets: "GOOGLE_SHEETS"; }; export type FlowsVaultConnectionAppIdGoogleSheetsEnum = (typeof FlowsVaultConnectionAppIdGoogleSheetsEnum)[keyof typeof FlowsVaultConnectionAppIdGoogleSheetsEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdHttpEnum: { readonly Http: "HTTP"; }; export type FlowsVaultConnectionAppIdHttpEnum = (typeof FlowsVaultConnectionAppIdHttpEnum)[keyof typeof FlowsVaultConnectionAppIdHttpEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdHubspotEnum: { readonly Hubspot: "HUBSPOT"; }; export type FlowsVaultConnectionAppIdHubspotEnum = (typeof FlowsVaultConnectionAppIdHubspotEnum)[keyof typeof FlowsVaultConnectionAppIdHubspotEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdJwtEnum: { readonly Jwt: "JWT"; }; export type FlowsVaultConnectionAppIdJwtEnum = (typeof FlowsVaultConnectionAppIdJwtEnum)[keyof typeof FlowsVaultConnectionAppIdJwtEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdMailchimpEnum: { readonly Mailchimp: "MAILCHIMP"; }; export type FlowsVaultConnectionAppIdMailchimpEnum = (typeof FlowsVaultConnectionAppIdMailchimpEnum)[keyof typeof FlowsVaultConnectionAppIdMailchimpEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdMailjetEnum: { readonly Mailjet: "MAILJET"; }; export type FlowsVaultConnectionAppIdMailjetEnum = (typeof FlowsVaultConnectionAppIdMailjetEnum)[keyof typeof FlowsVaultConnectionAppIdMailjetEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdPipedriveEnum: { readonly Pipedrive: "PIPEDRIVE"; }; export type FlowsVaultConnectionAppIdPipedriveEnum = (typeof FlowsVaultConnectionAppIdPipedriveEnum)[keyof typeof FlowsVaultConnectionAppIdPipedriveEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdSalesforceEnum: { readonly Salesforce: "SALESFORCE"; }; export type FlowsVaultConnectionAppIdSalesforceEnum = (typeof FlowsVaultConnectionAppIdSalesforceEnum)[keyof typeof FlowsVaultConnectionAppIdSalesforceEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdSendgridEnum: { readonly Sendgrid: "SENDGRID"; }; export type FlowsVaultConnectionAppIdSendgridEnum = (typeof FlowsVaultConnectionAppIdSendgridEnum)[keyof typeof FlowsVaultConnectionAppIdSendgridEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdSlackEnum: { readonly Slack: "SLACK"; }; export type FlowsVaultConnectionAppIdSlackEnum = (typeof FlowsVaultConnectionAppIdSlackEnum)[keyof typeof FlowsVaultConnectionAppIdSlackEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdStripeEnum: { readonly Stripe: "STRIPE"; }; export type FlowsVaultConnectionAppIdStripeEnum = (typeof FlowsVaultConnectionAppIdStripeEnum)[keyof typeof FlowsVaultConnectionAppIdStripeEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdTelegramEnum: { readonly Telegram: "TELEGRAM"; }; export type FlowsVaultConnectionAppIdTelegramEnum = (typeof FlowsVaultConnectionAppIdTelegramEnum)[keyof typeof FlowsVaultConnectionAppIdTelegramEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdTwilioEnum: { readonly Twilio: "TWILIO"; }; export type FlowsVaultConnectionAppIdTwilioEnum = (typeof FlowsVaultConnectionAppIdTwilioEnum)[keyof typeof FlowsVaultConnectionAppIdTwilioEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdWhatsappEnum: { readonly Whatsapp: "WHATSAPP"; }; export type FlowsVaultConnectionAppIdWhatsappEnum = (typeof FlowsVaultConnectionAppIdWhatsappEnum)[keyof typeof FlowsVaultConnectionAppIdWhatsappEnum]; /** Flows Vault Connection app identifier. */ export declare const FlowsVaultConnectionAppIdZapierEnum: { readonly Zapier: "ZAPIER"; }; export type FlowsVaultConnectionAppIdZapierEnum = (typeof FlowsVaultConnectionAppIdZapierEnum)[keyof typeof FlowsVaultConnectionAppIdZapierEnum]; export interface FlowsVaultConnectionHttpApiKeySetup { type: Management.FlowsVaultConnectionSetupTypeApiKeyEnum; name: string; value: string; in: Management.FlowsVaultConnectionHttpApiKeySetupInEnum; } export declare const FlowsVaultConnectionHttpApiKeySetupInEnum: { readonly Header: "HEADER"; readonly Query: "QUERY"; }; export type FlowsVaultConnectionHttpApiKeySetupInEnum = (typeof FlowsVaultConnectionHttpApiKeySetupInEnum)[keyof typeof FlowsVaultConnectionHttpApiKeySetupInEnum]; export interface FlowsVaultConnectionHttpBasicAuthSetup { type: Management.FlowsVaultConnectionSetupTypeBasicAuthEnum; username: string; password?: string | undefined; } export interface FlowsVaultConnectionHttpOauthClientCredentialsSetup { type: Management.FlowsVaultConnectionSetupTypeOauthClientCredentialsEnum; client_id: string; client_secret: string; token_endpoint: string; audience?: string | undefined; resource?: string | undefined; scope?: string | undefined; } export declare const FlowsVaultConnectionSetupTypeApiKeyEnum: { readonly ApiKey: "API_KEY"; }; export type FlowsVaultConnectionSetupTypeApiKeyEnum = (typeof FlowsVaultConnectionSetupTypeApiKeyEnum)[keyof typeof FlowsVaultConnectionSetupTypeApiKeyEnum]; export declare const FlowsVaultConnectionSetupTypeBasicAuthEnum: { readonly BasicAuth: "BASIC_AUTH"; }; export type FlowsVaultConnectionSetupTypeBasicAuthEnum = (typeof FlowsVaultConnectionSetupTypeBasicAuthEnum)[keyof typeof FlowsVaultConnectionSetupTypeBasicAuthEnum]; export declare const FlowsVaultConnectionSetupTypeOauthClientCredentialsEnum: { readonly OauthClientCredentials: "OAUTH_CLIENT_CREDENTIALS"; }; export type FlowsVaultConnectionSetupTypeOauthClientCredentialsEnum = (typeof FlowsVaultConnectionSetupTypeOauthClientCredentialsEnum)[keyof typeof FlowsVaultConnectionSetupTypeOauthClientCredentialsEnum]; export interface FlowsVaultConnectionSummary { /** Flows Vault Connection identifier. */ id: string; /** Flows Vault Connection app identifier. */ app_id: string; /** Flows Vault Connection name. */ name: string; /** Flows Vault Connection custom account name. */ account_name?: string | undefined; /** Whether the Flows Vault Connection is configured. */ ready: boolean; /** The ISO 8601 formatted date when this Flows Vault Connection was created. */ created_at: string; /** The ISO 8601 formatted date when this Flows Vault Connection was updated. */ updated_at: string; /** The ISO 8601 formatted date when this Flows Vault Connection was refreshed. */ refreshed_at?: string | undefined; fingerprint: string; } export type FormBlock = Management.FormBlockDivider | Management.FormBlockHtml | Management.FormBlockImage | Management.FormBlockJumpButton | Management.FormBlockResendButton | Management.FormBlockNextButton | Management.FormBlockPreviousButton | Management.FormBlockRichText; export interface FormBlockDivider { id: string; category: Management.FormComponentCategoryBlockConst; type: Management.FormBlockTypeDividerConst; config?: Management.FormBlockDividerConfig | undefined; } export interface FormBlockDividerConfig { text?: string | undefined; } export interface FormBlockHtml { id: string; category: Management.FormComponentCategoryBlockConst; type: Management.FormBlockTypeHtmlConst; config?: Management.FormBlockHtmlConfig | undefined; } export interface FormBlockHtmlConfig { content?: string | undefined; } export interface FormBlockImage { id: string; category: Management.FormComponentCategoryBlockConst; type: Management.FormBlockTypeImageConst; config?: Management.FormBlockImageConfig | undefined; } export interface FormBlockImageConfig { src: string; position?: Management.FormBlockImageConfigPositionEnum | undefined; height?: number | undefined; } export declare const FormBlockImageConfigPositionEnum: { readonly Left: "LEFT"; readonly Center: "CENTER"; readonly Right: "RIGHT"; }; export type FormBlockImageConfigPositionEnum = (typeof FormBlockImageConfigPositionEnum)[keyof typeof FormBlockImageConfigPositionEnum]; export interface FormBlockJumpButton { id: string; category: Management.FormComponentCategoryBlockConst; type: Management.FormBlockTypeJumpButtonConst; config: Management.FormBlockJumpButtonConfig; } export interface FormBlockJumpButtonConfig { text: string; next_node: Management.FormNodePointer; style?: Management.FormBlockJumpButtonConfigStyle | undefined; } export interface FormBlockJumpButtonConfigStyle { background_color?: string | undefined; } export interface FormBlockNextButton { id: string; category: Management.FormComponentCategoryBlockConst; type: Management.FormBlockTypeNextButtonConst; config: Management.FormBlockNextButtonConfig; } export interface FormBlockNextButtonConfig { text: string; } export interface FormBlockPreviousButton { id: string; category: Management.FormComponentCategoryBlockConst; type: Management.FormBlockTypePreviousButtonConst; config: Management.FormBlockPreviousButtonConfig; } export interface FormBlockPreviousButtonConfig { text: string; } export interface FormBlockResendButton { id: string; category: Management.FormComponentCategoryBlockConst; type: Management.FormBlockTypeResendButtonConst; config: Management.FormBlockResendButtonConfig; } export interface FormBlockResendButtonConfig { active_text: string; button_text: string; waiting_text: string; text_alignment?: Management.FormBlockResendButtonConfigTextAlignmentEnum | undefined; flow_id: string; max_attempts?: number | undefined; waiting_time?: number | undefined; } export declare const FormBlockResendButtonConfigTextAlignmentEnum: { readonly Left: "LEFT"; readonly Center: "CENTER"; readonly Right: "RIGHT"; }; export type FormBlockResendButtonConfigTextAlignmentEnum = (typeof FormBlockResendButtonConfigTextAlignmentEnum)[keyof typeof FormBlockResendButtonConfigTextAlignmentEnum]; export interface FormBlockRichText { id: string; category: Management.FormComponentCategoryBlockConst; type: Management.FormBlockTypeRichTextConst; config?: Management.FormBlockRichTextConfig | undefined; } export interface FormBlockRichTextConfig { content?: string | undefined; } export declare const FormBlockTypeDividerConst: { readonly Divider: "DIVIDER"; }; export type FormBlockTypeDividerConst = (typeof FormBlockTypeDividerConst)[keyof typeof FormBlockTypeDividerConst]; export declare const FormBlockTypeHtmlConst: { readonly Html: "HTML"; }; export type FormBlockTypeHtmlConst = (typeof FormBlockTypeHtmlConst)[keyof typeof FormBlockTypeHtmlConst]; export declare const FormBlockTypeImageConst: { readonly Image: "IMAGE"; }; export type FormBlockTypeImageConst = (typeof FormBlockTypeImageConst)[keyof typeof FormBlockTypeImageConst]; export declare const FormBlockTypeJumpButtonConst: { readonly JumpButton: "JUMP_BUTTON"; }; export type FormBlockTypeJumpButtonConst = (typeof FormBlockTypeJumpButtonConst)[keyof typeof FormBlockTypeJumpButtonConst]; export declare const FormBlockTypeNextButtonConst: { readonly NextButton: "NEXT_BUTTON"; }; export type FormBlockTypeNextButtonConst = (typeof FormBlockTypeNextButtonConst)[keyof typeof FormBlockTypeNextButtonConst]; export declare const FormBlockTypePreviousButtonConst: { readonly PreviousButton: "PREVIOUS_BUTTON"; }; export type FormBlockTypePreviousButtonConst = (typeof FormBlockTypePreviousButtonConst)[keyof typeof FormBlockTypePreviousButtonConst]; export declare const FormBlockTypeResendButtonConst: { readonly ResendButton: "RESEND_BUTTON"; }; export type FormBlockTypeResendButtonConst = (typeof FormBlockTypeResendButtonConst)[keyof typeof FormBlockTypeResendButtonConst]; export declare const FormBlockTypeRichTextConst: { readonly RichText: "RICH_TEXT"; }; export type FormBlockTypeRichTextConst = (typeof FormBlockTypeRichTextConst)[keyof typeof FormBlockTypeRichTextConst]; export type FormComponent = Management.FormBlock | Management.FormWidget | Management.FormField; export declare const FormComponentCategoryBlockConst: { readonly Block: "BLOCK"; }; export type FormComponentCategoryBlockConst = (typeof FormComponentCategoryBlockConst)[keyof typeof FormComponentCategoryBlockConst]; export declare const FormComponentCategoryFieldConst: { readonly Field: "FIELD"; }; export type FormComponentCategoryFieldConst = (typeof FormComponentCategoryFieldConst)[keyof typeof FormComponentCategoryFieldConst]; export declare const FormComponentCategoryWidgetConst: { readonly Widget: "WIDGET"; }; export type FormComponentCategoryWidgetConst = (typeof FormComponentCategoryWidgetConst)[keyof typeof FormComponentCategoryWidgetConst]; export interface FormEndingNode { redirection?: Management.FormEndingNodeRedirection | undefined; after_submit?: Management.FormEndingNodeAfterSubmit | undefined; coordinates?: Management.FormNodeCoordinates | undefined; resume_flow?: Management.FormEndingNodeResumeFlowTrueConst | undefined; } export interface FormEndingNodeAfterSubmit { flow_id?: string | undefined; } export declare const FormEndingNodeId: { readonly Ending: "$ending"; }; export type FormEndingNodeId = (typeof FormEndingNodeId)[keyof typeof FormEndingNodeId]; export type FormEndingNodeNullable = (Management.FormEndingNode | null) | undefined; export interface FormEndingNodeRedirection { delay?: number | undefined; target: string; } export type FormEndingNodeResumeFlowTrueConst = boolean; export type FormField = Management.FormFieldBoolean | Management.FormFieldCards | Management.FormFieldChoice | Management.FormFieldCustom | Management.FormFieldDate | Management.FormFieldDropdown | Management.FormFieldEmail | Management.FormFieldFile | Management.FormFieldLegal | Management.FormFieldNumber | Management.FormFieldPassword | Management.FormFieldPayment | Management.FormFieldSocial | Management.FormFieldTel | Management.FormFieldText | Management.FormFieldUrl; export interface FormFieldBoolean { id: string; category: Management.FormComponentCategoryFieldConst; type: Management.FormFieldTypeBooleanConst; config: Management.FormFieldBooleanConfig; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormFieldBooleanConfig { default_value?: boolean | undefined; options?: Management.FormFieldBooleanConfigOptions | undefined; } export interface FormFieldBooleanConfigOptions { true?: string | undefined; false?: string | undefined; } export interface FormFieldCards { id: string; category: Management.FormComponentCategoryFieldConst; type: Management.FormFieldTypeCardsConst; config?: Management.FormFieldCardsConfig | undefined; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormFieldCardsConfig { hide_labels?: boolean | undefined; multiple?: boolean | undefined; options?: Management.FormFieldCardsConfigOption[] | undefined; } export interface FormFieldCardsConfigOption { value: string; label: string; image_url: string; } export interface FormFieldChoice { id: string; category: Management.FormComponentCategoryFieldConst; type: Management.FormFieldTypeChoiceConst; config?: Management.FormFieldChoiceConfig | undefined; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormFieldChoiceConfig { multiple?: boolean | undefined; options?: Management.FormFieldChoiceConfigOption[] | undefined; allow_other?: Management.FormFieldChoiceConfigAllowOther | undefined; } export interface FormFieldChoiceConfigAllowOther { enabled?: Management.FormFieldChoiceConfigAllowOtherEnabledTrueEnum | undefined; label?: string | undefined; placeholder?: string | undefined; } export type FormFieldChoiceConfigAllowOtherEnabledTrueEnum = boolean; export interface FormFieldChoiceConfigOption { value: string; label: string; } export interface FormFieldCustom { id: string; category: Management.FormComponentCategoryFieldConst; type: Management.FormFieldTypeCustomConst; config: Management.FormFieldCustomConfig; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormFieldCustomConfig { schema: Management.FormFieldCustomConfigSchema; code: string; css?: string | undefined; params?: Management.FormFieldCustomConfigParams | undefined; } export type FormFieldCustomConfigParams = Record; export type FormFieldCustomConfigSchema = Record; export interface FormFieldDate { id: string; category: Management.FormComponentCategoryFieldConst; type: Management.FormFieldTypeDateConst; config: Management.FormFieldDateConfig; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormFieldDateConfig { format?: Management.FormFieldDateConfigFormatEnum | undefined; default_value?: string | undefined; } export declare const FormFieldDateConfigFormatEnum: { readonly Date: "DATE"; readonly Time: "TIME"; }; export type FormFieldDateConfigFormatEnum = (typeof FormFieldDateConfigFormatEnum)[keyof typeof FormFieldDateConfigFormatEnum]; export interface FormFieldDropdown { id: string; category: Management.FormComponentCategoryFieldConst; type: Management.FormFieldTypeDropdownConst; config?: Management.FormFieldDropdownConfig | undefined; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormFieldDropdownConfig { multiple?: boolean | undefined; options?: Management.FormFieldDropdownConfigOption[] | undefined; placeholder?: string | undefined; } export interface FormFieldDropdownConfigOption { value: string; label: string; } export interface FormFieldEmail { id: string; category: Management.FormComponentCategoryFieldConst; type: Management.FormFieldTypeEmailConst; config?: Management.FormFieldEmailConfig | undefined; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormFieldEmailConfig { default_value?: string | undefined; placeholder?: string | undefined; } export interface FormFieldFile { id: string; category: Management.FormComponentCategoryFieldConst; type: Management.FormFieldTypeFileConst; config?: Management.FormFieldFileConfig | undefined; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormFieldFileConfig { multiple?: boolean | undefined; storage?: Management.FormFieldFileConfigStorage | undefined; categories?: Management.FormFieldFileConfigCategoryEnum[] | undefined; extensions?: string[] | undefined; maxSize?: number | undefined; maxFiles?: number | undefined; } export declare const FormFieldFileConfigCategoryEnum: { readonly Audio: "AUDIO"; readonly Video: "VIDEO"; readonly Image: "IMAGE"; readonly Document: "DOCUMENT"; readonly Archive: "ARCHIVE"; }; export type FormFieldFileConfigCategoryEnum = (typeof FormFieldFileConfigCategoryEnum)[keyof typeof FormFieldFileConfigCategoryEnum]; export interface FormFieldFileConfigStorage { type: Management.FormFieldFileConfigStorageTypeEnum; /** Accepts any additional properties */ [key: string]: any; } export declare const FormFieldFileConfigStorageTypeEnum: { readonly Managed: "MANAGED"; readonly Custom: "CUSTOM"; }; export type FormFieldFileConfigStorageTypeEnum = (typeof FormFieldFileConfigStorageTypeEnum)[keyof typeof FormFieldFileConfigStorageTypeEnum]; export interface FormFieldLegal { id: string; category: Management.FormComponentCategoryFieldConst; type: Management.FormFieldTypeLegalConst; config?: Management.FormFieldLegalConfig | undefined; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormFieldLegalConfig { text?: string | undefined; } export interface FormFieldNumber { id: string; category: Management.FormComponentCategoryFieldConst; type: Management.FormFieldTypeNumberConst; config?: Management.FormFieldNumberConfig | undefined; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormFieldNumberConfig { default_value?: number | undefined; placeholder?: string | undefined; min_value?: number | undefined; max_value?: number | undefined; } export interface FormFieldPassword { id: string; category: Management.FormComponentCategoryFieldConst; type: Management.FormFieldTypePasswordConst; config: Management.FormFieldPasswordConfig; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormFieldPasswordConfig { hash?: Management.FormFieldPasswordConfigHashEnum | undefined; placeholder?: string | undefined; min_length?: number | undefined; max_length?: number | undefined; complexity?: boolean | undefined; nist?: boolean | undefined; strength_meter?: boolean | undefined; } export declare const FormFieldPasswordConfigHashEnum: { readonly None: "NONE"; readonly Md5: "MD5"; readonly Sha1: "SHA1"; readonly Sha256: "SHA256"; readonly Sha512: "SHA512"; }; export type FormFieldPasswordConfigHashEnum = (typeof FormFieldPasswordConfigHashEnum)[keyof typeof FormFieldPasswordConfigHashEnum]; export interface FormFieldPayment { id: string; category: Management.FormComponentCategoryFieldConst; type: Management.FormFieldTypePaymentConst; config: Management.FormFieldPaymentConfig; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormFieldPaymentConfig { provider?: Management.FormFieldPaymentConfigProviderEnum | undefined; charge: Management.FormFieldPaymentConfigCharge; credentials: Management.FormFieldPaymentConfigCredentials; customer?: Management.FormFieldPaymentConfigCustomer | undefined; fields?: Management.FormFieldPaymentConfigFields | undefined; } export type FormFieldPaymentConfigCharge = Management.FormFieldPaymentConfigChargeOneOff | { type: Management.FormFieldPaymentConfigChargeTypeSubscriptionConst; subscription: Management.FormFieldPaymentConfigSubscription; }; export interface FormFieldPaymentConfigChargeOneOff { type: Management.FormFieldPaymentConfigChargeTypeOneOffConst; one_off: Management.FormFieldPaymentConfigChargeOneOffOneOff; } export declare const FormFieldPaymentConfigChargeOneOffCurrencyEnum: { readonly Aud: "AUD"; readonly Cad: "CAD"; readonly Chf: "CHF"; readonly Eur: "EUR"; readonly Gbp: "GBP"; readonly Inr: "INR"; readonly Mxn: "MXN"; readonly Sek: "SEK"; readonly Usd: "USD"; }; export type FormFieldPaymentConfigChargeOneOffCurrencyEnum = (typeof FormFieldPaymentConfigChargeOneOffCurrencyEnum)[keyof typeof FormFieldPaymentConfigChargeOneOffCurrencyEnum]; export interface FormFieldPaymentConfigChargeOneOffOneOff { amount: Management.FormFieldPaymentConfigChargeOneOffOneOffAmount; currency: Management.FormFieldPaymentConfigChargeOneOffCurrencyEnum; /** Accepts any additional properties */ [key: string]: any; } export type FormFieldPaymentConfigChargeOneOffOneOffAmount = string | number; export declare const FormFieldPaymentConfigChargeTypeOneOffConst: { readonly OneOff: "ONE_OFF"; }; export type FormFieldPaymentConfigChargeTypeOneOffConst = (typeof FormFieldPaymentConfigChargeTypeOneOffConst)[keyof typeof FormFieldPaymentConfigChargeTypeOneOffConst]; export declare const FormFieldPaymentConfigChargeTypeSubscriptionConst: { readonly Subscription: "SUBSCRIPTION"; }; export type FormFieldPaymentConfigChargeTypeSubscriptionConst = (typeof FormFieldPaymentConfigChargeTypeSubscriptionConst)[keyof typeof FormFieldPaymentConfigChargeTypeSubscriptionConst]; export interface FormFieldPaymentConfigCredentials { public_key: string; private_key: string; } export type FormFieldPaymentConfigCustomer = Record; export interface FormFieldPaymentConfigFieldProperties { label?: string | undefined; placeholder?: string | undefined; } export interface FormFieldPaymentConfigFields { card_number?: Management.FormFieldPaymentConfigFieldProperties | undefined; expiration_date?: Management.FormFieldPaymentConfigFieldProperties | undefined; security_code?: Management.FormFieldPaymentConfigFieldProperties | undefined; trustmarks?: boolean | undefined; } export declare const FormFieldPaymentConfigProviderEnum: { readonly Stripe: "STRIPE"; }; export type FormFieldPaymentConfigProviderEnum = (typeof FormFieldPaymentConfigProviderEnum)[keyof typeof FormFieldPaymentConfigProviderEnum]; export type FormFieldPaymentConfigSubscription = Record; export interface FormFieldSocial { id: string; category: Management.FormComponentCategoryFieldConst; type: Management.FormFieldTypeSocialConst; config?: Management.FormFieldSocialConfig | undefined; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormFieldSocialConfig { } export interface FormFieldTel { id: string; category: Management.FormComponentCategoryFieldConst; type: Management.FormFieldTypeTelConst; config?: Management.FormFieldTelConfig | undefined; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormFieldTelConfig { default_value?: string | undefined; placeholder?: string | undefined; min_length?: number | undefined; max_length?: number | undefined; country_picker?: boolean | undefined; strings?: Management.FormFieldTelConfigStrings | undefined; } export interface FormFieldTelConfigStrings { filter_placeholder?: string | undefined; } export interface FormFieldText { id: string; category: Management.FormComponentCategoryFieldConst; type: Management.FormFieldTypeTextConst; config?: Management.FormFieldTextConfig | undefined; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormFieldTextConfig { multiline?: boolean | undefined; default_value?: string | undefined; placeholder?: string | undefined; min_length?: number | undefined; max_length?: number | undefined; } export declare const FormFieldTypeBooleanConst: { readonly Boolean: "BOOLEAN"; }; export type FormFieldTypeBooleanConst = (typeof FormFieldTypeBooleanConst)[keyof typeof FormFieldTypeBooleanConst]; export declare const FormFieldTypeCardsConst: { readonly Cards: "CARDS"; }; export type FormFieldTypeCardsConst = (typeof FormFieldTypeCardsConst)[keyof typeof FormFieldTypeCardsConst]; export declare const FormFieldTypeChoiceConst: { readonly Choice: "CHOICE"; }; export type FormFieldTypeChoiceConst = (typeof FormFieldTypeChoiceConst)[keyof typeof FormFieldTypeChoiceConst]; export declare const FormFieldTypeCustomConst: { readonly Custom: "CUSTOM"; }; export type FormFieldTypeCustomConst = (typeof FormFieldTypeCustomConst)[keyof typeof FormFieldTypeCustomConst]; export declare const FormFieldTypeDateConst: { readonly Date: "DATE"; }; export type FormFieldTypeDateConst = (typeof FormFieldTypeDateConst)[keyof typeof FormFieldTypeDateConst]; export declare const FormFieldTypeDropdownConst: { readonly Dropdown: "DROPDOWN"; }; export type FormFieldTypeDropdownConst = (typeof FormFieldTypeDropdownConst)[keyof typeof FormFieldTypeDropdownConst]; export declare const FormFieldTypeEmailConst: { readonly Email: "EMAIL"; }; export type FormFieldTypeEmailConst = (typeof FormFieldTypeEmailConst)[keyof typeof FormFieldTypeEmailConst]; export declare const FormFieldTypeFileConst: { readonly File: "FILE"; }; export type FormFieldTypeFileConst = (typeof FormFieldTypeFileConst)[keyof typeof FormFieldTypeFileConst]; export declare const FormFieldTypeLegalConst: { readonly Legal: "LEGAL"; }; export type FormFieldTypeLegalConst = (typeof FormFieldTypeLegalConst)[keyof typeof FormFieldTypeLegalConst]; export declare const FormFieldTypeNumberConst: { readonly Number: "NUMBER"; }; export type FormFieldTypeNumberConst = (typeof FormFieldTypeNumberConst)[keyof typeof FormFieldTypeNumberConst]; export declare const FormFieldTypePasswordConst: { readonly Password: "PASSWORD"; }; export type FormFieldTypePasswordConst = (typeof FormFieldTypePasswordConst)[keyof typeof FormFieldTypePasswordConst]; export declare const FormFieldTypePaymentConst: { readonly Payment: "PAYMENT"; }; export type FormFieldTypePaymentConst = (typeof FormFieldTypePaymentConst)[keyof typeof FormFieldTypePaymentConst]; export declare const FormFieldTypeSocialConst: { readonly Social: "SOCIAL"; }; export type FormFieldTypeSocialConst = (typeof FormFieldTypeSocialConst)[keyof typeof FormFieldTypeSocialConst]; export declare const FormFieldTypeTelConst: { readonly Tel: "TEL"; }; export type FormFieldTypeTelConst = (typeof FormFieldTypeTelConst)[keyof typeof FormFieldTypeTelConst]; export declare const FormFieldTypeTextConst: { readonly Text: "TEXT"; }; export type FormFieldTypeTextConst = (typeof FormFieldTypeTextConst)[keyof typeof FormFieldTypeTextConst]; export declare const FormFieldTypeUrlConst: { readonly Url: "URL"; }; export type FormFieldTypeUrlConst = (typeof FormFieldTypeUrlConst)[keyof typeof FormFieldTypeUrlConst]; export interface FormFieldUrl { id: string; category: Management.FormComponentCategoryFieldConst; type: Management.FormFieldTypeUrlConst; config?: Management.FormFieldUrlConfig | undefined; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormFieldUrlConfig { default_value?: string | undefined; placeholder?: string | undefined; } export interface FormFlow { id: string; type: Management.FormNodeTypeFlowConst; coordinates?: Management.FormNodeCoordinates | undefined; alias?: string | undefined; config: Management.FormFlowConfig; } export interface FormFlowConfig { flow_id: string; next_node?: Management.FormNodePointer | undefined; } export interface FormHiddenField { key: string; value?: string | undefined; } export interface FormLanguages { primary?: string | undefined; default?: string | undefined; } export type FormLanguagesNullable = (Management.FormLanguages | null) | undefined; export interface FormMessages { errors?: Management.FormMessagesError | undefined; custom?: Management.FormMessagesCustom | undefined; } export type FormMessagesCustom = Record; export type FormMessagesError = Record; export type FormMessagesNullable = (Management.FormMessages | null) | undefined; export type FormNode = Management.FormFlow | Management.FormRouter | Management.FormStep; export interface FormNodeCoordinates { x: number; y: number; } export type FormNodeList = Management.FormNode[]; export type FormNodeListNullable = (Management.FormNodeList | null) | undefined; export type FormNodePointer = string | Management.FormEndingNodeId; export declare const FormNodeTypeFlowConst: { readonly Flow: "FLOW"; }; export type FormNodeTypeFlowConst = (typeof FormNodeTypeFlowConst)[keyof typeof FormNodeTypeFlowConst]; export declare const FormNodeTypeRouterConst: { readonly Router: "ROUTER"; }; export type FormNodeTypeRouterConst = (typeof FormNodeTypeRouterConst)[keyof typeof FormNodeTypeRouterConst]; export declare const FormNodeTypeStepConst: { readonly Step: "STEP"; }; export type FormNodeTypeStepConst = (typeof FormNodeTypeStepConst)[keyof typeof FormNodeTypeStepConst]; export interface FormRouter { id: string; type: Management.FormNodeTypeRouterConst; coordinates?: Management.FormNodeCoordinates | undefined; alias?: string | undefined; config?: Management.FormRouterConfig | undefined; } export interface FormRouterConfig { rules?: Management.FormRouterRule[] | undefined; fallback?: Management.FormNodePointer | undefined; } export interface FormRouterRule { id: string; alias?: string | undefined; next_node?: Management.FormNodePointer | undefined; } export interface FormStartNode { hidden_fields?: Management.FormHiddenField[] | undefined; next_node?: Management.FormNodePointer | undefined; coordinates?: Management.FormNodeCoordinates | undefined; } export type FormStartNodeNullable = (Management.FormStartNode | null) | undefined; export interface FormStep { id: string; type: Management.FormNodeTypeStepConst; coordinates?: Management.FormNodeCoordinates | undefined; alias?: string | undefined; config?: Management.FormStepConfig | undefined; } export type FormStepComponentList = Management.FormComponent[]; export interface FormStepConfig { components?: Management.FormStepComponentList | undefined; next_node?: Management.FormNodePointer | undefined; } export interface FormStyle { css?: string | undefined; } export type FormStyleNullable = (Management.FormStyle | null) | undefined; export interface FormSummary { id: string; name: string; created_at: string; updated_at: string; embedded_at?: string | undefined; submitted_at?: string | undefined; } export type FormTranslations = Record>; export type FormTranslationsNullable = (Management.FormTranslations | null) | undefined; export type FormWidget = Management.FormWidgetAuth0VerifiableCredentials | Management.FormWidgetGMapsAddress | Management.FormWidgetRecaptcha; export interface FormWidgetAuth0VerifiableCredentials { id: string; category: Management.FormComponentCategoryWidgetConst; type: Management.FormWidgetTypeAuth0VerifiableCredentialsConst; config: Management.FormWidgetAuth0VerifiableCredentialsConfig; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormWidgetAuth0VerifiableCredentialsConfig { url: string; size?: number | undefined; alternate_text: string; access_token: string; verification_id: string; max_wait?: number | undefined; } export interface FormWidgetGMapsAddress { id: string; category: Management.FormComponentCategoryWidgetConst; type: Management.FormWidgetTypeGMapsAddressConst; config: Management.FormWidgetGMapsAddressConfig; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormWidgetGMapsAddressConfig { api_key: string; } export interface FormWidgetRecaptcha { id: string; category: Management.FormComponentCategoryWidgetConst; type: Management.FormWidgetTypeRecaptchaConst; config: Management.FormWidgetRecaptchaConfig; label?: string | undefined; hint?: string | undefined; required?: boolean | undefined; sensitive?: boolean | undefined; } export interface FormWidgetRecaptchaConfig { site_key: string; secret_key: string; } export declare const FormWidgetTypeAuth0VerifiableCredentialsConst: { readonly Auth0VerifiableCredentials: "AUTH0_VERIFIABLE_CREDENTIALS"; }; export type FormWidgetTypeAuth0VerifiableCredentialsConst = (typeof FormWidgetTypeAuth0VerifiableCredentialsConst)[keyof typeof FormWidgetTypeAuth0VerifiableCredentialsConst]; export declare const FormWidgetTypeGMapsAddressConst: { readonly GmapsAddress: "GMAPS_ADDRESS"; }; export type FormWidgetTypeGMapsAddressConst = (typeof FormWidgetTypeGMapsAddressConst)[keyof typeof FormWidgetTypeGMapsAddressConst]; export declare const FormWidgetTypeRecaptchaConst: { readonly Recaptcha: "RECAPTCHA"; }; export type FormWidgetTypeRecaptchaConst = (typeof FormWidgetTypeRecaptchaConst)[keyof typeof FormWidgetTypeRecaptchaConst]; export declare const FormsRequestParametersHydrateEnum: { readonly FlowCount: "flow_count"; readonly Links: "links"; }; export type FormsRequestParametersHydrateEnum = (typeof FormsRequestParametersHydrateEnum)[keyof typeof FormsRequestParametersHydrateEnum]; /** * The result of a specific execution of a trigger. */ export interface GetActionExecutionResponseContent { /** ID identifies this specific execution simulation. These IDs would resemble real executions in production. */ id?: string | undefined; trigger_id?: Management.ActionTriggerTypeEnum | undefined; status?: Management.ActionExecutionStatusEnum | undefined; results?: Management.ActionExecutionResult[] | undefined; /** The time that the execution was started. */ created_at?: string | undefined; /** The time that the exeution finished executing. */ updated_at?: string | undefined; } export interface GetActionModuleActionsResponseContent { /** A list of action references. */ actions?: Management.ActionModuleAction[] | undefined; /** The total number of actions using this module. */ total?: number | undefined; /** The page index of the returned results. */ page?: number | undefined; /** The number of results requested per page. */ per_page?: number | undefined; } export interface GetActionModuleResponseContent { /** The unique ID of the module. */ id?: string | undefined; /** The name of the module. */ name?: string | undefined; /** The source code from the module's draft version. */ code?: string | undefined; /** The npm dependencies from the module's draft version. */ dependencies?: Management.ActionModuleDependency[] | undefined; /** The secrets from the module's draft version (names and timestamps only, values never returned). */ secrets?: Management.ActionModuleSecret[] | undefined; /** The number of deployed actions using this module. */ actions_using_module_total?: number | undefined; /** Whether all draft changes have been published as a version. */ all_changes_published?: boolean | undefined; /** The version number of the latest published version. Omitted if no versions have been published. */ latest_version_number?: number | undefined; /** Timestamp when the module was created. */ created_at?: string | undefined; /** Timestamp when the module was last updated. */ updated_at?: string | undefined; latest_version?: Management.ActionModuleVersionReference | undefined; } export interface GetActionModuleVersionResponseContent { /** The unique ID for this version. */ id?: string | undefined; /** The ID of the parent module. */ module_id?: string | undefined; /** The sequential version number. */ version_number?: number | undefined; /** The exact source code that was published with this version. */ code?: string | undefined; /** Secrets available to this version (name and updated_at only, values never returned). */ secrets?: Management.ActionModuleSecret[] | undefined; /** Dependencies locked to this version. */ dependencies?: Management.ActionModuleDependency[] | undefined; /** The timestamp when this version was created. */ created_at?: string | undefined; } export interface GetActionModuleVersionsResponseContent { /** A list of ActionsModuleVersion objects. */ versions?: Management.ActionModuleVersion[] | undefined; /** The total number of versions for this module. */ total?: number | undefined; /** The page index of the returned results. */ page?: number | undefined; /** The number of results requested per page. */ per_page?: number | undefined; } export interface GetActionModulesResponseContent { /** A list of ActionsModule objects. */ modules?: Management.ActionModuleListItem[] | undefined; /** The total number of modules in the tenant. */ total?: number | undefined; /** The page index of the returned results. */ page?: number | undefined; /** The number of results requested per page. */ per_page?: number | undefined; } export interface GetActionResponseContent { /** The unique ID of the action. */ id?: string | undefined; /** The name of an action. */ name?: string | undefined; /** The list of triggers that this action supports. At this time, an action can only target a single trigger at a time. */ supported_triggers?: Management.ActionTrigger[] | undefined; /** True if all of an Action's contents have been deployed. */ all_changes_deployed?: boolean | undefined; /** The time when this action was created. */ created_at?: string | undefined; /** The time when this action was updated. */ updated_at?: string | undefined; /** The source code of the action. */ code?: string | undefined; /** The list of third party npm modules, and their versions, that this action depends on. */ dependencies?: Management.ActionVersionDependency[] | undefined; /** The Node runtime. For example: `node22`, defaults to `node22` */ runtime?: string | undefined; /** The list of secrets that are included in an action or a version of an action. */ secrets?: Management.ActionSecretResponse[] | undefined; deployed_version?: Management.ActionDeployedVersion | undefined; /** installed_integration_id is the fk reference to the InstalledIntegration entity. */ installed_integration_id?: string | undefined; integration?: Management.Integration | undefined; status?: Management.ActionBuildStatusEnum | undefined; /** The time when this action was built successfully. */ built_at?: string | undefined; /** True if the action should be deployed after creation. */ deploy?: boolean | undefined; /** The list of action modules and their versions used by this action. */ modules?: Management.ActionModuleReference[] | undefined; } export interface GetActionVersionResponseContent { /** The unique id of an action version. */ id?: string | undefined; /** The id of the action to which this version belongs. */ action_id?: string | undefined; /** The source code of this specific version of the action. */ code?: string | undefined; /** The list of third party npm modules, and their versions, that this specific version depends on. */ dependencies?: Management.ActionVersionDependency[] | undefined; /** Indicates if this specific version is the currently one deployed. */ deployed?: boolean | undefined; /** The Node runtime. For example: `node22` */ runtime?: string | undefined; /** The list of secrets that are included in an action or a version of an action. */ secrets?: Management.ActionSecretResponse[] | undefined; status?: Management.ActionVersionBuildStatusEnum | undefined; /** The index of this version in list of versions for the action. */ number?: number | undefined; /** Any errors that occurred while the version was being built. */ errors?: Management.ActionError[] | undefined; action?: Management.ActionBase | undefined; /** The time when this version was built successfully. */ built_at?: string | undefined; /** The time when this version was created. */ created_at?: string | undefined; /** The time when a version was updated. Versions are never updated externally. Only Auth0 will update an action version as it is being built. */ updated_at?: string | undefined; /** The list of triggers that this version supports. At this time, a version can only target a single trigger at a time. */ supported_triggers?: Management.ActionTrigger[] | undefined; /** The list of action modules and their versions used by this action version. */ modules?: Management.ActionModuleReference[] | undefined; } /** * Number of active users in the last 30 days. */ export type GetActiveUsersCountStatsResponseContent = number; export interface GetAculResponseContent { /** Tenant ID */ tenant?: string | undefined; /** Name of the prompt */ prompt?: string | undefined; /** Name of the screen */ screen?: string | undefined; /** Rendering mode */ rendering_mode?: Management.AculRenderingModeEnum | undefined; context_configuration?: ((Management.AculContextConfiguration | undefined) | null) | undefined; /** Override Universal Login default head tags */ default_head_tags_disabled?: (boolean | null) | undefined; /** Use page template with ACUL */ use_page_template?: (boolean | null) | undefined; /** An array of head tags */ head_tags?: (Management.AculHeadTag[] | null) | undefined; filters?: (Management.AculFilters | null) | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetAttackProtectionCaptchaResponseContent { active_provider_id?: string | undefined; arkose?: Management.AttackProtectionCaptchaArkoseResponseContent | undefined; auth_challenge?: Management.AttackProtectionCaptchaAuthChallengeResponseContent | undefined; hcaptcha?: Management.AttackProtectionCaptchaHcaptchaResponseContent | undefined; friendly_captcha?: Management.AttackProtectionCaptchaFriendlyCaptchaResponseContent | undefined; recaptcha_enterprise?: Management.AttackProtectionCaptchaRecaptchaEnterpriseResponseContent | undefined; recaptcha_v2?: Management.AttackProtectionCaptchaRecaptchaV2ResponseContent | undefined; simple_captcha?: Management.AttackProtectionCaptchaSimpleCaptchaResponseContent | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetBotDetectionSettingsResponseContent { bot_detection_level: Management.BotDetectionLevelEnum; challenge_password_policy: Management.BotDetectionChallengePolicyPasswordFlowEnum; challenge_passwordless_policy: Management.BotDetectionChallengePolicyPasswordlessFlowEnum; challenge_password_reset_policy: Management.BotDetectionChallengePolicyPasswordResetFlowEnum; allowlist: Management.BotDetectionAllowlist; monitoring_mode_enabled: Management.BotDetectionMonitoringModeEnabled; } export interface GetBrandingDefaultThemeResponseContent { borders: Management.BrandingThemeBorders; colors: Management.BrandingThemeColors; /** Display Name */ displayName: string; fonts: Management.BrandingThemeFonts; page_background: Management.BrandingThemePageBackground; /** Theme Id */ themeId: string; widget: Management.BrandingThemeWidget; } /** * Phone provider configuration schema */ export interface GetBrandingPhoneProviderResponseContent { id?: string | undefined; /** The name of the tenant */ tenant?: string | undefined; name: Management.PhoneProviderNameEnum; channel?: Management.PhoneProviderChannelEnum | undefined; /** Whether the provider is enabled (false) or disabled (true). */ disabled?: boolean | undefined; configuration?: Management.PhoneProviderConfiguration | undefined; /** The provider's creation date and time in ISO 8601 format */ created_at?: string | undefined; /** The date and time of the last update to the provider in ISO 8601 format */ updated_at?: string | undefined; } export interface GetBrandingResponseContent { colors?: Management.BrandingColors | undefined; /** URL for the favicon. Must use HTTPS. */ favicon_url?: string | undefined; /** URL for the logo. Must use HTTPS. */ logo_url?: string | undefined; font?: Management.BrandingFont | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetBrandingThemeResponseContent { borders: Management.BrandingThemeBorders; colors: Management.BrandingThemeColors; /** Display Name */ displayName: string; fonts: Management.BrandingThemeFonts; page_background: Management.BrandingThemePageBackground; /** Theme Id */ themeId: string; widget: Management.BrandingThemeWidget; } export interface GetBreachedPasswordDetectionSettingsResponseContent { /** Whether or not breached password detection is active. */ enabled?: boolean | undefined; /** * Action to take when a breached password is detected during a login. * Possible values: block, user_notification, admin_notification. */ shields?: Management.BreachedPasswordDetectionShieldsEnum[] | undefined; /** * When "admin_notification" is enabled, determines how often email notifications are sent. * Possible values: immediately, daily, weekly, monthly. */ admin_notification_frequency?: Management.BreachedPasswordDetectionAdminNotificationFrequencyEnum[] | undefined; method?: Management.BreachedPasswordDetectionMethodEnum | undefined; stage?: Management.BreachedPasswordDetectionStage | undefined; } export interface GetBruteForceSettingsResponseContent { /** Whether or not brute force attack protections are active. */ enabled?: boolean | undefined; /** * Action to take when a brute force protection threshold is violated. * Possible values: block, user_notification. */ shields?: Management.BruteForceProtectionShieldsEnum[] | undefined; /** List of trusted IP addresses that will not have attack protection enforced against them. */ allowlist?: string[] | undefined; mode?: Management.BruteForceProtectionModeEnum | undefined; /** Maximum number of unsuccessful attempts. */ max_attempts?: number | undefined; } export interface GetClientCredentialResponseContent { /** ID of the credential. Generated on creation. */ id?: string | undefined; /** The name given to the credential by the user. */ name?: string | undefined; /** The key identifier of the credential, generated on creation. */ kid?: string | undefined; alg?: Management.ClientCredentialAlgorithmEnum | undefined; credential_type?: Management.ClientCredentialTypeEnum | undefined; /** The X509 certificate's Subject Distinguished Name */ subject_dn?: string | undefined; /** The X509 certificate's SHA256 thumbprint */ thumbprint_sha256?: string | undefined; /** The ISO 8601 formatted date the credential was created. */ created_at?: string | undefined; /** The ISO 8601 formatted date the credential was updated. */ updated_at?: string | undefined; /** The ISO 8601 formatted date representing the expiration of the credential. */ expires_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetClientGrantResponseContent { /** ID of the client grant. */ id?: string | undefined; /** ID of the client. */ client_id?: string | undefined; /** The audience (API identifier) of this client grant. */ audience?: string | undefined; /** Scopes allowed for this client grant. */ scope?: string[] | undefined; organization_usage?: Management.ClientGrantOrganizationUsageEnum | undefined; /** If enabled, any organization can be used with this grant. If disabled (default), the grant must be explicitly assigned to the desired organizations. */ allow_any_organization?: boolean | undefined; /** Applies this client grant as the default for all clients in the specified group. The only accepted value is `third_party_clients`, which applies the grant to all third-party clients. Per-client grants for the same audience take precedence. Mutually exclusive with `client_id`. */ default_for?: Management.ClientGrantDefaultForEnum | undefined; /** If enabled, this grant is a special grant created by Auth0. It cannot be modified or deleted directly. */ is_system?: boolean | undefined; subject_type?: Management.ClientGrantSubjectTypeEnum | undefined; /** Types of authorization_details allowed for this client grant. */ authorization_details_types?: string[] | undefined; /** If enabled, all scopes configured on the resource server are allowed for this grant. */ allow_all_scopes?: boolean | undefined; } export interface GetClientResponseContent { /** ID of this client. */ client_id?: string | undefined; /** Name of the tenant this client belongs to. */ tenant?: string | undefined; /** Name of this client (min length: 1 character, does not allow `<` or `>`). */ name?: string | undefined; /** Free text description of this client (max length: 140 characters). */ description?: string | undefined; /** Whether this is your global 'All Applications' client representing legacy tenant settings (true) or a regular client (false). */ global?: boolean | undefined; /** Client secret (which you must not make public). */ client_secret?: string | undefined; app_type?: Management.ClientAppTypeEnum | undefined; /** URL of the logo to display for this client. Recommended size is 150x150 pixels. */ logo_uri?: string | undefined; /** Whether this client a first party client (true) or not (false). */ is_first_party?: boolean | undefined; /** Whether this client conforms to strict OIDC specifications (true) or uses legacy features (false). */ oidc_conformant?: boolean | undefined; /** Comma-separated list of URLs whitelisted for Auth0 to use as a callback to the client after authentication. */ callbacks?: string[] | undefined; /** Comma-separated list of URLs allowed to make requests from JavaScript to Auth0 API (typically used with CORS). By default, all your callback URLs will be allowed. This field allows you to enter other origins if necessary. You can also use wildcards at the subdomain level (e.g., https://*.contoso.com). Query strings and hash information are not taken into account when validating these URLs. */ allowed_origins?: string[] | undefined; /** Comma-separated list of allowed origins for use with Cross-Origin Authentication, Device Flow, and web message response mode. */ web_origins?: string[] | undefined; /** List of audiences/realms for SAML protocol. Used by the wsfed addon. */ client_aliases?: string[] | undefined; /** List of allow clients and API ids that are allowed to make delegation requests. Empty means all all your clients are allowed. */ allowed_clients?: string[] | undefined; /** Comma-separated list of URLs that are valid to redirect to after logout from Auth0. Wildcards are allowed for subdomains. */ allowed_logout_urls?: string[] | undefined; session_transfer?: (Management.ClientSessionTransferConfiguration | null) | undefined; oidc_logout?: Management.ClientOidcBackchannelLogoutSettings | undefined; /** List of grant types supported for this application. Can include `authorization_code`, `implicit`, `refresh_token`, `client_credentials`, `password`, `http://auth0.com/oauth/grant-type/password-realm`, `http://auth0.com/oauth/grant-type/mfa-oob`, `http://auth0.com/oauth/grant-type/mfa-otp`, `http://auth0.com/oauth/grant-type/mfa-recovery-code`, `urn:openid:params:grant-type:ciba`, `urn:ietf:params:oauth:grant-type:device_code`, and `urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token`. */ grant_types?: string[] | undefined; jwt_configuration?: Management.ClientJwtConfiguration | undefined; signing_keys?: ((Management.ClientSigningKeys | undefined) | null) | undefined; encryption_key?: (Management.ClientEncryptionKey | null) | undefined; /** Applies only to SSO clients and determines whether Auth0 will handle Single Sign On (true) or whether the Identity Provider will (false). */ sso?: boolean | undefined; /** Whether Single Sign On is disabled (true) or enabled (true). Defaults to true. */ sso_disabled?: boolean | undefined; /** Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false). */ cross_origin_authentication?: boolean | undefined; /** URL of the location in your site where the cross origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page. */ cross_origin_loc?: string | undefined; /** Whether a custom login page is to be used (true) or the default provided login page (false). */ custom_login_page_on?: boolean | undefined; /** The content (HTML, CSS, JS) of the custom login page. */ custom_login_page?: string | undefined; /** The content (HTML, CSS, JS) of the custom login page. (Used on Previews) */ custom_login_page_preview?: string | undefined; /** HTML form template to be used for WS-Federation. */ form_template?: string | undefined; addons?: Management.ClientAddons | undefined; token_endpoint_auth_method?: Management.ClientTokenEndpointAuthMethodEnum | undefined; /** If true, trust that the IP specified in the `auth0-forwarded-for` header is the end-user's IP for brute-force-protection on token endpoint. */ is_token_endpoint_ip_header_trusted?: boolean | undefined; client_metadata?: Management.ClientMetadata | undefined; mobile?: Management.ClientMobile | undefined; /** Initiate login uri, must be https */ initiate_login_uri?: string | undefined; refresh_token?: (Management.ClientRefreshTokenConfiguration | null) | undefined; default_organization?: (Management.ClientDefaultOrganization | null) | undefined; organization_usage?: Management.ClientOrganizationUsageEnum | undefined; organization_require_behavior?: Management.ClientOrganizationRequireBehaviorEnum | undefined; /** Defines the available methods for organization discovery during the `pre_login_prompt`. Users can discover their organization either by `email`, `organization_name` or both. */ organization_discovery_methods?: Management.ClientOrganizationDiscoveryEnum[] | undefined; client_authentication_methods?: (Management.ClientAuthenticationMethod | null) | undefined; /** Makes the use of Pushed Authorization Requests mandatory for this client */ require_pushed_authorization_requests?: boolean | undefined; /** Makes the use of Proof-of-Possession mandatory for this client */ require_proof_of_possession?: boolean | undefined; signed_request_object?: Management.ClientSignedRequestObjectWithCredentialId | undefined; compliance_level?: (Management.ClientComplianceLevelEnum | null) | undefined; /** * Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as `myapp://`, or `localhost`). * If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps. * See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information. */ skip_non_verifiable_callback_uri_confirmation_prompt?: boolean | undefined; token_exchange?: Management.ClientTokenExchangeConfiguration | undefined; /** Specifies how long, in seconds, a Pushed Authorization Request URI remains valid */ par_request_expiry?: (number | null) | undefined; token_quota?: Management.TokenQuota | undefined; express_configuration?: Management.ExpressConfiguration | undefined; my_organization_configuration?: Management.ClientMyOrganizationResponseConfiguration | undefined; third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum | undefined; redirection_policy?: Management.ClientRedirectionPolicyEnum | undefined; /** The identifier of the resource server that this client is linked to. */ resource_server_identifier?: string | undefined; async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPostConfiguration | undefined; external_metadata_type?: Management.ClientExternalMetadataTypeEnum | undefined; external_metadata_created_by?: Management.ClientExternalMetadataCreatedByEnum | undefined; /** An alternate client identifier to be used during authorization flows. Only supports CIMD-based client identifiers. */ external_client_id?: string | undefined; /** URL for the JSON Web Key Set (JWKS) containing the public keys used for private_key_jwt authentication. Only present for CIMD clients using private_key_jwt authentication. */ jwks_uri?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetConnectionEnabledClientsResponseContent { /** Clients for which the connection is enabled */ clients: Management.ConnectionEnabledClient[]; /** Encoded next token */ next?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetConnectionProfileResponseContent { id?: Management.ConnectionProfileId | undefined; name?: Management.ConnectionProfileName | undefined; organization?: Management.ConnectionProfileOrganization | undefined; connection_name_prefix_template?: Management.ConnectionNamePrefixTemplate | undefined; enabled_features?: Management.ConnectionProfileEnabledFeatures | undefined; connection_config?: Management.ConnectionProfileConfig | undefined; strategy_overrides?: Management.ConnectionProfileStrategyOverrides | undefined; } export interface GetConnectionProfileTemplateResponseContent { /** The id of the template. */ id?: string | undefined; /** The user-friendly name of the template displayed in the UI. */ display_name?: string | undefined; template?: Management.ConnectionProfileTemplate | undefined; } export interface GetConnectionResponseContent { /** The name of the connection */ name?: string | undefined; /** Connection name used in login screen */ display_name?: string | undefined; options?: Management.ConnectionOptions | undefined; /** The connection's identifier */ id?: string | undefined; /** The type of the connection, related to the identity provider */ strategy?: string | undefined; /** Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm. */ realms?: string[] | undefined; /** DEPRECATED property. Use the GET /connections/:id/clients endpoint to get the ids of the clients for which the connection is enabled */ enabled_clients?: string[] | undefined; /** True if the connection is domain level */ is_domain_connection?: boolean | undefined; /** Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. */ show_as_button?: boolean | undefined; metadata?: Management.ConnectionsMetadata | undefined; authentication?: Management.ConnectionAuthenticationPurpose | undefined; connected_accounts?: Management.ConnectionConnectedAccountsPurpose | undefined; } export interface GetCustomDomainResponseContent { /** ID of the custom domain. */ custom_domain_id: string; /** Domain name. */ domain: string; /** Whether this is a primary domain (true) or not (false). */ primary: boolean; /** Whether this is the default custom domain (true) or not (false). */ is_default?: boolean | undefined; status: Management.CustomDomainStatusFilterEnum; type: Management.CustomDomainTypeEnum; /** Intermediate address. */ origin_domain_name?: string | undefined; verification?: Management.DomainVerification | undefined; /** The HTTP header to fetch the client's IP address */ custom_client_ip_header?: (string | null) | undefined; /** The TLS version policy */ tls_policy?: string | undefined; domain_metadata?: Management.DomainMetadata | undefined; certificate?: Management.DomainCertificate | undefined; /** Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not present, the full domain will be used. */ relying_party_identifier?: string | undefined; } /** * JWKS representing an array of custom public signing keys. */ export interface GetCustomSigningKeysResponseContent { /** An array of custom public signing keys. */ keys?: Management.CustomSigningKeyJwk[] | undefined; } /** * An object containing custom dictionaries for a group of screens. */ export type GetCustomTextsByLanguageResponseContent = Record; export interface GetDefaultCanonicalDomainResponseContent { /** Domain name. */ domain: string; } export interface GetDefaultCustomDomainResponseContent { /** ID of the custom domain. */ custom_domain_id: string; /** Domain name. */ domain: string; /** Whether this is a primary domain (true) or not (false). */ primary: boolean; /** Whether this is the default custom domain (true) or not (false). */ is_default?: boolean | undefined; status: Management.CustomDomainStatusFilterEnum; type: Management.CustomDomainTypeEnum; /** Intermediate address. */ origin_domain_name?: string | undefined; verification?: Management.DomainVerification | undefined; /** The HTTP header to fetch the client's IP address */ custom_client_ip_header?: (string | null) | undefined; /** The TLS version policy */ tls_policy?: string | undefined; domain_metadata?: Management.DomainMetadata | undefined; certificate?: Management.DomainCertificate | undefined; /** Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not present, the full domain will be used. */ relying_party_identifier?: string | undefined; } export type GetDefaultDomainResponseContent = Management.GetDefaultCustomDomainResponseContent | Management.GetDefaultCanonicalDomainResponseContent; export interface GetDirectoryProvisioningDefaultMappingResponseContent { /** The mapping between Auth0 and IDP user attributes */ mapping?: Management.DirectoryProvisioningMappingItem[] | undefined; } export interface GetDirectoryProvisioningResponseContent { /** The connection's identifier */ connection_id: string; /** The connection's name */ connection_name: string; /** The connection's strategy */ strategy: string; /** The mapping between Auth0 and IDP user attributes */ mapping: Management.DirectoryProvisioningMappingItem[]; /** Whether periodic automatic synchronization is enabled */ synchronize_automatically: boolean; synchronize_groups?: Management.SynchronizeGroupsEnum | undefined; /** The timestamp at which the directory provisioning configuration was created */ created_at: string; /** The timestamp at which the directory provisioning configuration was last updated */ updated_at: string; /** The timestamp at which the connection was last synchronized */ last_synchronization_at?: string | undefined; /** The status of the last synchronization */ last_synchronization_status?: string | undefined; /** The error message of the last synchronization, if any */ last_synchronization_error?: string | undefined; } export interface GetEmailProviderResponseContent { /** Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, `ms365`, or `custom`. */ name?: string | undefined; /** Whether the provider is enabled (true) or disabled (false). */ enabled?: boolean | undefined; /** Email address to use as "from" when no other address specified. */ default_from_address?: string | undefined; credentials?: Management.EmailProviderCredentials | undefined; settings?: Management.EmailProviderSettings | undefined; } export interface GetEmailTemplateResponseContent { template?: Management.EmailTemplateNameEnum | undefined; /** Body of the email template. */ body?: (string | null) | undefined; /** Senders `from` email address. */ from?: (string | null) | undefined; /** URL to redirect the user to after a successful action. */ resultUrl?: (string | null) | undefined; /** Subject line of the email. */ subject?: (string | null) | undefined; /** Syntax of the template body. */ syntax?: (string | null) | undefined; /** Lifetime in seconds that the link within the email will be valid for. */ urlLifetimeInSeconds?: (number | null) | undefined; /** Whether the `reset_email` and `verify_email` templates should include the user's email address as the `email` parameter in the returnUrl (true) or whether no email address should be included in the redirect (false). Defaults to true. */ includeEmailInRedirect?: boolean | undefined; /** Whether the template is enabled (true) or disabled (false). */ enabled?: (boolean | null) | undefined; } /** * Encryption key */ export interface GetEncryptionKeyResponseContent { /** Key ID */ kid: string; type: Management.EncryptionKeyType; state: Management.EncryptionKeyState; /** Key creation timestamp */ created_at: string; /** Key update timestamp */ updated_at: string; /** ID of parent wrapping key */ parent_kid?: (string | null) | undefined; /** Public key in PEM format */ public_key?: (string | null) | undefined; } /** * Metadata about a specific attempt to deliver an event */ export interface GetEventStreamDeliveryHistoryResponseContent { /** Unique identifier for the delivery */ id: string; /** Unique identifier for the event stream. */ event_stream_id: string; status: Management.EventStreamDeliveryStatusEnum; event_type: Management.EventStreamDeliveryEventTypeEnum; /** Results of delivery attempts */ attempts: Management.EventStreamDeliveryAttempt[]; event?: Management.EventStreamCloudEvent | undefined; } export type GetEventStreamResponseContent = Management.EventStreamWebhookResponseContent | Management.EventStreamEventBridgeResponseContent | Management.EventStreamActionResponseContent; export declare const GetFlowExecutionRequestParametersHydrateEnum: { readonly Debug: "debug"; }; export type GetFlowExecutionRequestParametersHydrateEnum = (typeof GetFlowExecutionRequestParametersHydrateEnum)[keyof typeof GetFlowExecutionRequestParametersHydrateEnum]; export interface GetFlowExecutionResponseContent { /** Flow execution identifier */ id: string; /** Trace id */ trace_id: string; /** Journey id */ journey_id?: string | undefined; /** Execution status */ status: string; debug?: Management.FlowExecutionDebug | undefined; /** The ISO 8601 formatted date when this flow execution was created. */ created_at: string; /** The ISO 8601 formatted date when this flow execution was updated. */ updated_at: string; /** The ISO 8601 formatted date when this flow execution started. */ started_at?: string | undefined; /** The ISO 8601 formatted date when this flow execution ended. */ ended_at?: string | undefined; } export declare const GetFlowRequestParametersHydrateEnum: { readonly FormCount: "form_count"; readonly Forms: "forms"; }; export type GetFlowRequestParametersHydrateEnum = (typeof GetFlowRequestParametersHydrateEnum)[keyof typeof GetFlowRequestParametersHydrateEnum]; export interface GetFlowResponseContent { id: string; name: string; actions?: Management.FlowAction[] | undefined; created_at: string; updated_at: string; executed_at?: string | undefined; } export interface GetFlowsVaultConnectionResponseContent { /** Flows Vault Connection identifier. */ id: string; /** Flows Vault Connection app identifier. */ app_id: string; /** Flows Vault Connection environment. */ environment?: string | undefined; /** Flows Vault Connection name. */ name: string; /** Flows Vault Connection custom account name. */ account_name?: string | undefined; /** Whether the Flows Vault Connection is configured. */ ready: boolean; /** The ISO 8601 formatted date when this Flows Vault Connection was created. */ created_at: string; /** The ISO 8601 formatted date when this Flows Vault Connection was updated. */ updated_at: string; /** The ISO 8601 formatted date when this Flows Vault Connection was refreshed. */ refreshed_at?: string | undefined; fingerprint: string; } export interface GetFormResponseContent { id: string; name: string; messages?: Management.FormMessages | undefined; languages?: Management.FormLanguages | undefined; translations?: Management.FormTranslations | undefined; nodes?: Management.FormNodeList | undefined; start?: Management.FormStartNode | undefined; ending?: Management.FormEndingNode | undefined; style?: Management.FormStyle | undefined; created_at: string; updated_at: string; embedded_at?: string | undefined; submitted_at?: string | undefined; } export interface GetGroupMembersResponseContent { members: Management.GroupMember[]; /** A cursor to be used as the "from" query parameter for the next page of results. */ next?: string | undefined; } /** * Represents the metadata of a group. Member lists are retrieved via a separate endpoint. */ export interface GetGroupResponseContent { /** Unique identifier for the group (service-generated). */ id: string; /** Name of the group. Must be unique within its connection. Must contain between 1 and 128 printable ASCII characters. */ name: string; /** External identifier for the group, often used for SCIM synchronization. Max length of 256 characters. */ external_id?: string | undefined; /** Identifier for the connection this group belongs to (if a connection group). */ connection_id?: string | undefined; /** Identifier for the tenant this group belongs to. */ tenant_name: string; /** Timestamp of when the group was created. */ created_at: string; /** Timestamp of when the group was last updated. */ updated_at: string; /** Accepts any additional properties */ [key: string]: any; } export interface GetGuardianEnrollmentResponseContent { /** ID for this enrollment. */ id: string; status?: Management.GuardianEnrollmentStatus | undefined; /** Device name (only for push notification). */ name?: string | undefined; /** Device identifier. This is usually the phone identifier. */ identifier?: string | undefined; /** Phone number. */ phone_number?: string | undefined; enrolled_at?: Management.GuardianEnrollmentDate | undefined; last_auth?: Management.GuardianEnrollmentDate | undefined; } export interface GetGuardianFactorDuoSettingsResponseContent { ikey?: string | undefined; skey?: string | undefined; host?: string | undefined; } export interface GetGuardianFactorPhoneMessageTypesResponseContent { /** The list of phone factors to enable on the tenant. Can include `sms` and `voice`. */ message_types?: Management.GuardianFactorPhoneFactorMessageTypeEnum[] | undefined; } export interface GetGuardianFactorPhoneTemplatesResponseContent { /** Message sent to the user when they are invited to enroll with a phone number. */ enrollment_message: string; /** Message sent to the user when they are prompted to verify their account. */ verification_message: string; } export interface GetGuardianFactorSmsTemplatesResponseContent { /** Message sent to the user when they are invited to enroll with a phone number. */ enrollment_message: string; /** Message sent to the user when they are prompted to verify their account. */ verification_message: string; } export interface GetGuardianFactorsProviderApnsResponseContent { bundle_id?: (string | null) | undefined; sandbox?: boolean | undefined; enabled?: boolean | undefined; } export interface GetGuardianFactorsProviderPhoneResponseContent { provider?: Management.GuardianFactorsProviderSmsProviderEnum | undefined; } export interface GetGuardianFactorsProviderPhoneTwilioResponseContent { /** From number */ from?: (string | null) | undefined; /** Copilot SID */ messaging_service_sid?: (string | null) | undefined; /** Twilio Authentication token */ auth_token?: (string | null) | undefined; /** Twilio SID */ sid?: (string | null) | undefined; } export interface GetGuardianFactorsProviderPushNotificationResponseContent { provider?: Management.GuardianFactorsProviderPushNotificationProviderDataEnum | undefined; } export interface GetGuardianFactorsProviderSmsResponseContent { provider?: Management.GuardianFactorsProviderSmsProviderEnum | undefined; } export interface GetGuardianFactorsProviderSmsTwilioResponseContent { /** From number */ from?: (string | null) | undefined; /** Copilot SID */ messaging_service_sid?: (string | null) | undefined; /** Twilio Authentication token */ auth_token?: (string | null) | undefined; /** Twilio SID */ sid?: (string | null) | undefined; } export interface GetGuardianFactorsProviderSnsResponseContent { aws_access_key_id?: (string | null) | undefined; aws_secret_access_key?: (string | null) | undefined; aws_region?: (string | null) | undefined; sns_apns_platform_application_arn?: (string | null) | undefined; sns_gcm_platform_application_arn?: (string | null) | undefined; } export interface GetHookResponseContent { /** Trigger ID */ triggerId?: string | undefined; /** ID of this hook. */ id?: string | undefined; /** Name of this hook. */ name?: string | undefined; /** Whether this hook will be executed (true) or ignored (false). */ enabled?: boolean | undefined; /** Code to be executed when this hook runs. */ script?: string | undefined; dependencies?: Management.HookDependencies | undefined; } /** * Hashmap of key-value pairs where the value must be a string. */ export type GetHookSecretResponseContent = Record; export interface GetJobErrorResponseContent { user?: Management.GetJobUserError | undefined; /** Errors importing the user. */ errors?: Management.GetJobImportUserError[] | undefined; } export interface GetJobGenericErrorResponseContent { /** Status of this job. */ status: string; /** Type of job this is. */ type: string; /** When this job was created. */ created_at?: string | undefined; /** ID of this job. */ id: string; /** connection_id of the connection this job uses. */ connection_id?: string | undefined; /** Status details. */ status_details?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetJobImportUserError { /** Error code. */ code?: string | undefined; /** Error message. */ message?: string | undefined; /** Error field. */ path?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetJobResponseContent { /** Status of this job. */ status: string; /** Type of job this is. */ type: string; /** When this job was created. */ created_at?: string | undefined; /** ID of this job. */ id: string; /** connection_id of the connection this job uses. */ connection_id?: string | undefined; /** URL to download the result of this job. */ location?: string | undefined; /** Completion percentage of this job. */ percentage_done?: number | undefined; /** Estimated time remaining before job completes. */ time_left_seconds?: number | undefined; format?: Management.JobFileFormatEnum | undefined; /** Status details. */ status_details?: string | undefined; summary?: Management.GetJobSummary | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Job execution summary. */ export interface GetJobSummary { /** Number of failed operations. */ failed?: number | undefined; /** Number of updated records. */ updated?: number | undefined; /** Number of inserted records. */ inserted?: number | undefined; /** Total number of operations. */ total?: number | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * User, as provided in the import file */ export type GetJobUserError = Record; export interface GetLogResponseContent { date?: Management.LogDate | undefined; /** Type of event. */ type?: string | undefined; /** Description of this event. */ description?: (string | null) | undefined; /** Name of the connection the event relates to. */ connection?: string | undefined; /** ID of the connection the event relates to. */ connection_id?: string | undefined; /** ID of the client (application). */ client_id?: string | undefined; /** Name of the client (application). */ client_name?: string | undefined; /** IP address of the log event source. */ ip?: string | undefined; /** Hostname the event applies to. */ hostname?: string | undefined; /** ID of the user involved in the event. */ user_id?: string | undefined; /** Name of the user involved in the event. */ user_name?: string | undefined; /** API audience the event applies to. */ audience?: string | undefined; /** Scope permissions applied to the event. */ scope?: string | undefined; /** Name of the strategy involved in the event. */ strategy?: string | undefined; /** Type of strategy involved in the event. */ strategy_type?: string | undefined; /** Unique ID of the event. */ log_id?: string | undefined; /** Whether the client was a mobile device (true) or desktop/laptop/server (false). */ isMobile?: boolean | undefined; details?: Management.LogDetails | undefined; /** User agent string from the client device that caused the event. */ user_agent?: string | undefined; security_context?: Management.LogSecurityContext | undefined; location_info?: Management.LogLocationInfo | undefined; /** Accepts any additional properties */ [key: string]: any; } export type GetLogStreamResponseContent = Management.LogStreamHttpResponseSchema | Management.LogStreamEventBridgeResponseSchema | Management.LogStreamEventGridResponseSchema | Management.LogStreamDatadogResponseSchema | Management.LogStreamSplunkResponseSchema | Management.LogStreamSumoResponseSchema | Management.LogStreamSegmentResponseSchema | Management.LogStreamMixpanelResponseSchema; export interface GetNetworkAclsResponseContent { id?: string | undefined; description?: string | undefined; active?: boolean | undefined; priority?: number | undefined; rule?: Management.NetworkAclRule | undefined; /** The timestamp when the Network ACL Configuration was created */ created_at?: string | undefined; /** The timestamp when the Network ACL Configuration was last updated */ updated_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetOrganizationAllConnectionResponseContent { /** Name of the connection in the scope of this organization. */ organization_connection_name?: string | undefined; /** 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. */ assign_membership_on_login?: boolean | undefined; /** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */ show_as_button?: boolean | undefined; /** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */ is_signup_enabled?: boolean | undefined; organization_access_level?: Management.OrganizationAccessLevelEnum | undefined; /** Whether the connection is enabled for the organization. */ is_enabled?: boolean | undefined; /** Connection identifier. */ connection_id: string; connection?: Management.OrganizationConnectionInformation | undefined; } export interface GetOrganizationByNameResponseContent { /** Organization identifier. */ id?: string | undefined; /** The name of this organization. */ name?: string | undefined; /** Friendly name of this organization. */ display_name?: string | undefined; branding?: Management.OrganizationBranding | undefined; metadata?: Management.OrganizationMetadata | undefined; token_quota?: Management.TokenQuota | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetOrganizationConnectionResponseContent { /** ID of the connection. */ connection_id?: string | undefined; /** 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. */ assign_membership_on_login?: boolean | undefined; /** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */ show_as_button?: boolean | undefined; /** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */ is_signup_enabled?: boolean | undefined; connection?: Management.OrganizationConnectionInformation | undefined; } export interface GetOrganizationDiscoveryDomainByNameResponseContent { /** Organization discovery domain identifier. */ id: string; /** The domain name to associate with the organization e.g. acme.com. */ domain: string; status: Management.OrganizationDiscoveryDomainStatus; /** Indicates whether this domain should be used for organization discovery. */ use_for_organization_discovery?: boolean | undefined; /** A unique token generated for the discovery domain. This must be placed in a DNS TXT record at the location specified by the verification_host field to prove domain ownership. */ verification_txt: string; /** The full domain where the TXT record should be added. */ verification_host: string; } export interface GetOrganizationDiscoveryDomainResponseContent { /** Organization discovery domain identifier. */ id: string; /** The domain name to associate with the organization e.g. acme.com. */ domain: string; status: Management.OrganizationDiscoveryDomainStatus; /** Indicates whether this domain should be used for organization discovery. */ use_for_organization_discovery?: boolean | undefined; /** A unique token generated for the discovery domain. This must be placed in a DNS TXT record at the location specified by the verification_host field to prove domain ownership. */ verification_txt: string; /** The full domain where the TXT record should be added. */ verification_host: string; } export interface GetOrganizationInvitationResponseContent { /** The id of the user invitation. */ id?: string | undefined; /** Organization identifier. */ organization_id?: string | undefined; inviter?: Management.OrganizationInvitationInviter | undefined; invitee?: Management.OrganizationInvitationInvitee | undefined; /** The invitation url to be send to the invitee. */ invitation_url?: string | undefined; /** The ISO 8601 formatted timestamp representing the creation time of the invitation. */ created_at?: string | undefined; /** The ISO 8601 formatted timestamp representing the expiration time of the invitation. */ expires_at?: string | undefined; /** Auth0 client ID. Used to resolve the application's login initiation endpoint. */ client_id?: string | undefined; /** The id of the connection to force invitee to authenticate with. */ connection_id?: string | undefined; app_metadata?: Management.AppMetadata | undefined; user_metadata?: Management.UserMetadata | undefined; /** List of roles IDs to associated with the user. */ roles?: string[] | undefined; /** The id of the invitation ticket */ ticket_id?: string | undefined; } export interface GetOrganizationResponseContent { /** Organization identifier. */ id?: string | undefined; /** The name of this organization. */ name?: string | undefined; /** Friendly name of this organization. */ display_name?: string | undefined; branding?: Management.OrganizationBranding | undefined; metadata?: Management.OrganizationMetadata | undefined; token_quota?: Management.TokenQuota | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * An object containing template partials for a group of screens. */ export type GetPartialsResponseContent = Record; export interface GetPhoneTemplateResponseContent { id: string; channel?: string | undefined; customizable?: boolean | undefined; tenant?: string | undefined; content: Management.PhoneTemplateContent; type: Management.PhoneTemplateNotificationTypeEnum; /** Whether the template is enabled (false) or disabled (true). */ disabled: boolean; } export interface GetRefreshTokenResponseContent { /** The ID of the refresh token */ id?: string | undefined; /** ID of the user which can be used when interacting with other APIs. */ user_id?: string | undefined; created_at?: Management.RefreshTokenDate | undefined; idle_expires_at?: Management.RefreshTokenDate | undefined; expires_at?: Management.RefreshTokenDate | undefined; device?: Management.RefreshTokenDevice | undefined; /** ID of the client application granted with this refresh token */ client_id?: string | undefined; session_id?: ((Management.RefreshTokenSessionId | undefined) | null) | undefined; /** True if the token is a rotating refresh token */ rotating?: boolean | undefined; /** A list of the resource server IDs associated to this refresh-token and their granted scopes */ resource_servers?: Management.RefreshTokenResourceServer[] | undefined; refresh_token_metadata?: ((Management.RefreshTokenMetadata | undefined) | null) | undefined; last_exchanged_at?: Management.RefreshTokenDate | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetRefreshTokensPaginatedResponseContent { refresh_tokens?: Management.RefreshTokenResponseContent[] | undefined; /** A cursor to be used as the "from" query parameter for the next page of results. */ next?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetResourceServerResponseContent { /** ID of the API (resource server). */ id?: string | undefined; /** Friendly name for this resource server. Can not contain `<` or `>` characters. */ name?: string | undefined; /** Whether this is an Auth0 system API (true) or a custom API (false). */ is_system?: boolean | undefined; /** Unique identifier for the API used as the audience parameter on authorization calls. Can not be changed once set. */ identifier?: string | undefined; /** List of permissions (scopes) that this API uses. */ scopes?: Management.ResourceServerScope[] | undefined; signing_alg?: Management.SigningAlgorithmEnum | undefined; /** Secret used to sign tokens when using symmetric algorithms (HS256). */ signing_secret?: string | undefined; /** Whether refresh tokens can be issued for this API (true) or not (false). */ allow_offline_access?: boolean | undefined; /** Whether Online Refresh Tokens can be issued for this API (true) or not (false). */ allow_online_access?: boolean | undefined; /** Whether to skip user consent for applications flagged as first party (true) or not (false). */ skip_consent_for_verifiable_first_party_clients?: boolean | undefined; /** Expiration value (in seconds) for access tokens issued for this API from the token endpoint. */ token_lifetime?: number | undefined; /** Expiration value (in seconds) for access tokens issued for this API via Implicit or Hybrid Flows. Cannot be greater than the `token_lifetime` value. */ token_lifetime_for_web?: number | undefined; /** Whether authorization polices are enforced (true) or unenforced (false). */ enforce_policies?: boolean | undefined; token_dialect?: Management.ResourceServerTokenDialectResponseEnum | undefined; token_encryption?: (Management.ResourceServerTokenEncryption | null) | undefined; consent_policy?: (Management.ResourceServerConsentPolicyEnum | null) | undefined; authorization_details?: (unknown[] | null) | undefined; proof_of_possession?: (Management.ResourceServerProofOfPossession | null) | undefined; subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization | undefined; /** The client ID of the client that this resource server is linked to */ client_id?: string | undefined; } export interface GetRiskAssessmentsSettingsNewDeviceResponseContent { /** Length of time to remember devices for, in days. */ remember_for: number; } export interface GetRiskAssessmentsSettingsResponseContent { /** Whether or not risk assessment is enabled. */ enabled: boolean; } export interface GetRoleResponseContent { /** ID for this role. */ id?: string | undefined; /** Name of this role. */ name?: string | undefined; /** Description of this role. */ description?: string | undefined; } export interface GetRuleResponseContent { /** Name of this rule. */ name?: string | undefined; /** ID of this rule. */ id?: string | undefined; /** Whether the rule is enabled (true), or disabled (false). */ enabled?: boolean | undefined; /** Code to be executed when this rule runs. */ script?: string | undefined; /** Order that this rule should execute in relative to other rules. Lower-valued rules execute first. */ order?: number | undefined; /** Execution stage of this rule. Can be `login_success`, `login_failure`, or `pre_authorize`. */ stage?: string | undefined; } export interface GetScimConfigurationDefaultMappingResponseContent { /** The mapping between auth0 and SCIM */ mapping?: Management.ScimMappingItem[] | undefined; } export interface GetScimConfigurationResponseContent { /** The connection's identifier */ connection_id: string; /** The connection's name */ connection_name: string; /** The connection's strategy */ strategy: string; /** The tenant's name */ tenant_name: string; /** User ID attribute for generating unique user ids */ user_id_attribute: string; /** The mapping between auth0 and SCIM */ mapping: Management.ScimMappingItem[]; /** The ISO 8601 date and time the SCIM configuration was created at */ created_at: string; /** The ISO 8601 date and time the SCIM configuration was last updated on */ updated_on: string; } /** * The list of scim tokens for scim clients */ export type GetScimTokensResponseContent = Management.ScimTokenItem[]; export interface GetSelfServiceProfileResponseContent { /** The unique ID of the self-service Profile. */ id?: string | undefined; /** The name of the self-service Profile. */ name?: string | undefined; /** The description of the self-service Profile. */ description?: string | undefined; /** List of attributes to be mapped that will be shown to the user during the SS-SSO flow. */ user_attributes?: Management.SelfServiceProfileUserAttribute[] | undefined; /** The time when this self-service Profile was created. */ created_at?: string | undefined; /** The time when this self-service Profile was updated. */ updated_at?: string | undefined; branding?: Management.SelfServiceProfileBrandingProperties | undefined; /** List of IdP strategies that will be shown to users during the Self-Service SSO flow. Possible values: [`oidc`, `samlp`, `waad`, `google-apps`, `adfs`, `okta`, `auth0-samlp`, `okta-samlp`, `keycloak-samlp`, `pingfederate`] */ allowed_strategies?: Management.SelfServiceProfileAllowedStrategyEnum[] | undefined; /** ID of the user-attribute-profile to associate with this self-service profile. */ user_attribute_profile_id?: string | undefined; } export interface GetSessionResponseContent { /** The ID of the session */ id?: string | undefined; /** ID of the user which can be used when interacting with other APIs. */ user_id?: string | undefined; created_at?: Management.SessionDate | undefined; updated_at?: Management.SessionDate | undefined; authenticated_at?: Management.SessionDate | undefined; idle_expires_at?: Management.SessionDate | undefined; expires_at?: Management.SessionDate | undefined; last_interacted_at?: Management.SessionDate | undefined; device?: Management.SessionDeviceMetadata | undefined; /** List of client details for the session */ clients?: Management.SessionClientMetadata[] | undefined; authentication?: Management.SessionAuthenticationSignals | undefined; cookie?: Management.SessionCookieMetadata | undefined; session_metadata?: ((Management.SessionMetadata | undefined) | null) | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetSettingsResponseContent { universal_login_experience?: Management.UniversalLoginExperienceEnum | undefined; /** Whether identifier first is enabled or not */ identifier_first?: boolean | undefined; /** Use WebAuthn with Device Biometrics as the first authentication factor */ webauthn_platform_first_factor?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetSigningKeysResponseContent { /** The key id of the signing key */ kid: string; /** The public certificate of the signing key */ cert: string; /** The public certificate of the signing key in pkcs7 format */ pkcs7?: string | undefined; /** True if the key is the the current key */ current?: boolean | undefined; /** True if the key is the the next key */ next?: boolean | undefined; /** True if the key is the the previous key */ previous?: boolean | undefined; current_since?: Management.SigningKeysDate | undefined; current_until?: Management.SigningKeysDate | undefined; /** The cert fingerprint */ fingerprint: string; /** The cert thumbprint */ thumbprint: string; /** True if the key is revoked */ revoked?: boolean | undefined; revoked_at?: Management.SigningKeysDate | undefined; } export interface GetSupplementalSignalsResponseContent { /** Indicates if incoming Akamai Headers should be processed */ akamai_enabled?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetSuspiciousIpThrottlingSettingsResponseContent { /** Whether or not suspicious IP throttling attack protections are active. */ enabled?: boolean | undefined; /** * Action to take when a suspicious IP throttling threshold is violated. * Possible values: block, admin_notification. */ shields?: Management.SuspiciousIpThrottlingShieldsEnum[] | undefined; allowlist?: Management.SuspiciousIpThrottlingAllowlist | undefined; stage?: Management.SuspiciousIpThrottlingStage | undefined; } export interface GetTenantSettingsResponseContent { change_password?: (Management.TenantSettingsPasswordPage | null) | undefined; guardian_mfa_page?: (Management.TenantSettingsGuardianPage | null) | undefined; /** Default audience for API authorization. */ default_audience?: string | undefined; /** Name of connection used for password grants at the `/token`endpoint. The following connection types are supported: LDAP, AD, Database Connections, Passwordless, Windows Azure Active Directory, ADFS. */ default_directory?: string | undefined; error_page?: (Management.TenantSettingsErrorPage | null) | undefined; device_flow?: (Management.TenantSettingsDeviceFlow | null) | undefined; default_token_quota?: (Management.DefaultTokenQuota | null) | undefined; flags?: Management.TenantSettingsFlags | undefined; /** Friendly name for this tenant. */ friendly_name?: string | undefined; /** URL of logo to be shown for this tenant (recommended size: 150x150) */ picture_url?: string | undefined; /** End-user support email address. */ support_email?: string | undefined; /** End-user support URL. */ support_url?: string | undefined; /** URLs that are valid to redirect to after logout from Auth0. */ allowed_logout_urls?: string[] | undefined; /** Number of hours a session will stay valid. */ session_lifetime?: number | undefined; /** Number of hours for which a session can be inactive before the user must log in again. */ idle_session_lifetime?: number | undefined; /** Number of hours an ephemeral (non-persistent) session will stay valid. */ ephemeral_session_lifetime?: number | undefined; /** Number of hours for which an ephemeral (non-persistent) session can be inactive before the user must log in again. */ idle_ephemeral_session_lifetime?: number | undefined; /** Selected sandbox version for the extensibility environment. */ sandbox_version?: string | undefined; /** Selected sandbox version for rules and hooks extensibility. */ legacy_sandbox_version?: string | undefined; /** Available sandbox versions for the extensibility environment. */ sandbox_versions_available?: string[] | undefined; /** The default absolute redirection uri, must be https */ default_redirection_uri?: string | undefined; /** Supported locales for the user interface. */ enabled_locales?: Management.SupportedLocales[] | undefined; session_cookie?: (Management.SessionCookieSchema | null) | undefined; sessions?: (Management.TenantSettingsSessions | null) | undefined; oidc_logout?: Management.TenantOidcLogoutSettings | undefined; /** Whether to accept an organization name instead of an ID on auth endpoints */ allow_organization_name_in_authentication_api?: boolean | undefined; /** Whether to enable flexible factors for MFA in the PostLogin action */ customize_mfa_in_postlogin_action?: boolean | undefined; /** Supported ACR values */ acr_values_supported?: (string[] | null) | undefined; mtls?: (Management.TenantSettingsMtls | null) | undefined; /** Enables the use of Pushed Authorization Requests */ pushed_authorization_requests_supported?: boolean | undefined; /** Supports iss parameter in authorization responses */ authorization_response_iss_parameter_supported?: (boolean | null) | undefined; /** * Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as `myapp://`, or `localhost`). * If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps. * See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information. */ skip_non_verifiable_callback_uri_confirmation_prompt?: (boolean | null) | undefined; resource_parameter_profile?: Management.TenantSettingsResourceParameterProfile | undefined; /** Whether the authorization server supports retrieving client metadata from a client_id URL. */ client_id_metadata_document_supported?: boolean | undefined; /** Whether Phone Consolidated Experience is enabled for this tenant. */ phone_consolidated_experience?: boolean | undefined; /** Whether Auth0 Guide (AI-powered assistance) is enabled for this tenant. */ enable_ai_guide?: boolean | undefined; dynamic_client_registration_security_mode?: Management.TenantSettingsDynamicClientRegistrationSecurityMode | undefined; } export interface GetTokenExchangeProfileResponseContent { /** The unique ID of the token exchange profile. */ id?: string | undefined; /** Friendly name of this profile. */ name?: string | undefined; /** Subject token type for this profile. When receiving a token exchange request on the Authentication API, the corresponding token exchange profile with a matching subject_token_type will be executed. This must be a URI. */ subject_token_type?: string | undefined; /** The ID of the Custom Token Exchange action to execute for this profile, in order to validate the subject_token. The action must use the custom-token-exchange trigger. */ action_id?: string | undefined; type?: Management.TokenExchangeProfileTypeEnum | undefined; /** The time when this profile was created. */ created_at?: string | undefined; /** The time when this profile was updated. */ updated_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetUniversalLoginTemplate { /** The custom page template for the New Universal Login Experience */ body?: string | undefined; } export type GetUniversalLoginTemplateResponseContent = Management.GetUniversalLoginTemplate /** * The custom page template for the New Universal Login Experience */ | string; export interface GetUserAttributeProfileResponseContent { id?: Management.UserAttributeProfileId | undefined; name?: Management.UserAttributeProfileName | undefined; user_id?: Management.UserAttributeProfileUserId | undefined; user_attributes?: Management.UserAttributeProfileUserAttributes | undefined; } export interface GetUserAttributeProfileTemplateResponseContent { /** The id of the template. */ id?: string | undefined; /** The user-friendly name of the template displayed in the UI. */ display_name?: string | undefined; template?: Management.UserAttributeProfileTemplate | undefined; } export interface GetUserAuthenticationMethodResponseContent { /** The ID of the authentication method (auto generated) */ id: string; type: Management.AuthenticationMethodTypeEnum; /** The authentication method status */ confirmed?: boolean | undefined; /** A human-readable label to identify the authentication method */ name?: string | undefined; authentication_methods?: Management.UserAuthenticationMethodProperties[] | undefined; preferred_authentication_method?: Management.PreferredAuthenticationMethodEnum | undefined; /** The ID of a linked authentication method. Linked authentication methods will be deleted together. */ link_id?: string | undefined; /** Applies to phone authentication methods only. The destination phone number used to send verification codes via text and voice. */ phone_number?: string | undefined; /** Applies to email and email-verification authentication methods only. The email address used to send verification messages. */ email?: string | undefined; /** Applies to webauthn authentication methods only. The ID of the generated credential. */ key_id?: string | undefined; /** Applies to webauthn authentication methods only. The public key. */ public_key?: string | undefined; /** Authenticator creation date */ created_at: string; /** Enrollment date */ enrolled_at?: string | undefined; /** Last authentication */ last_auth_at?: string | undefined; /** Applies to passkeys only. The kind of device the credential is stored on as defined by backup eligibility. "single_device" credentials cannot be backed up and synced to another device, "multi_device" credentials can be backed up if enabled by the end-user. */ credential_device_type?: string | undefined; /** Applies to passkeys only. Whether the credential was backed up. */ credential_backed_up?: boolean | undefined; /** Applies to passkeys only. The ID of the user identity linked with the authentication method. */ identity_user_id?: string | undefined; /** Applies to passkeys only. The user-agent of the browser used to create the passkey. */ user_agent?: string | undefined; /** Applies to passkey authentication methods only. Authenticator Attestation Globally Unique Identifier. */ aaguid?: string | undefined; /** Applies to webauthn/passkey authentication methods only. The credential's relying party identifier. */ relying_party_identifier?: string | undefined; } export interface GetUserGroupsPaginatedResponseContent { groups: Management.UserGroupsResponseSchema[]; /** A cursor to be used as the "from" query parameter for the next page of results. */ next?: string | undefined; start?: number | undefined; limit?: number | undefined; total?: number | undefined; } export interface GetUserResponseContent { /** ID of the user which can be used when interacting with other APIs. */ user_id?: string | undefined; /** Email address of this user. */ email?: string | undefined; /** Whether this email address is verified (true) or unverified (false). */ email_verified?: boolean | undefined; /** Username of this user. */ username?: string | undefined; /** Phone number for this user. Follows the E.164 recommendation. */ phone_number?: string | undefined; /** Whether this phone number has been verified (true) or not (false). */ phone_verified?: boolean | undefined; created_at?: Management.UserDateSchema | undefined; updated_at?: Management.UserDateSchema | undefined; /** Array of user identity objects when accounts are linked. */ identities?: Management.UserIdentitySchema[] | undefined; app_metadata?: Management.UserAppMetadataSchema | undefined; user_metadata?: Management.UserMetadataSchema | undefined; /** URL to picture, photo, or avatar of this user. */ picture?: string | undefined; /** Name of this user. */ name?: string | undefined; /** Preferred nickname or alias of this user. */ nickname?: string | undefined; /** List of multi-factor authentication providers with which this user has enrolled. */ multifactor?: string[] | undefined; /** Last IP address from which this user logged in. */ last_ip?: string | undefined; last_login?: Management.UserDateSchema | undefined; /** Total number of logins this user has performed. */ logins_count?: number | undefined; /** Whether this user was blocked by an administrator (true) or is not (false). */ blocked?: boolean | undefined; /** Given name/first name/forename of this user. */ given_name?: string | undefined; /** Family name/last name/surname of this user. */ family_name?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface GetVerifiableCredentialTemplateResponseContent { /** The id of the template. */ id?: string | undefined; /** The name of the template. */ name?: string | undefined; /** The type of the template. */ type?: string | undefined; /** The dialect of the template. */ dialect?: string | undefined; presentation?: Management.MdlPresentationRequest | undefined; /** The custom certificate authority. */ custom_certificate_authority?: (string | null) | undefined; /** The well-known trusted issuers, comma separated. */ well_known_trusted_issuers?: (string | null) | undefined; /** The date and time the template was created. */ created_at?: string | undefined; /** The date and time the template was created. */ updated_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Represents the metadata of a group. Member lists are retrieved via a separate endpoint. */ export interface Group { /** Unique identifier for the group (service-generated). */ id?: string | undefined; /** Name of the group. Must be unique within its connection. Must contain between 1 and 128 printable ASCII characters. */ name?: string | undefined; /** External identifier for the group, often used for SCIM synchronization. Max length of 256 characters. */ external_id?: string | undefined; /** Identifier for the connection this group belongs to (if a connection group). */ connection_id?: string | undefined; /** Identifier for the tenant this group belongs to. */ tenant_name?: string | undefined; /** Timestamp of when the group was created. */ created_at?: string | undefined; /** Timestamp of when the group was last updated. */ updated_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Represents the metadata of a group membership. */ export interface GroupMember { /** Unique identifier for the member. */ id?: string | undefined; member_type?: Management.GroupMemberTypeEnum | undefined; type?: Management.GroupTypeEnum | undefined; /** Identifier for the connection this group belongs to (if a connection group). */ connection_id?: string | undefined; /** Timestamp of when the membership was created. */ created_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** Type of the member. */ export declare const GroupMemberTypeEnum: { readonly User: "user"; readonly Group: "group"; }; export type GroupMemberTypeEnum = (typeof GroupMemberTypeEnum)[keyof typeof GroupMemberTypeEnum]; /** Type of the group. */ export declare const GroupTypeEnum: { readonly Connection: "connection"; readonly Organization: "organization"; readonly Tenant: "tenant"; }; export type GroupTypeEnum = (typeof GroupTypeEnum)[keyof typeof GroupTypeEnum]; /** * Enrollment date and time. */ export type GuardianEnrollmentDate = string; /** Optional. Specifies which factor the user must enroll with.
Note: Parameter can only be used with Universal Login; it cannot be used with Classic Login or custom MFA pages. */ export declare const GuardianEnrollmentFactorEnum: { readonly PushNotification: "push-notification"; readonly Phone: "phone"; readonly Email: "email"; readonly Otp: "otp"; readonly WebauthnRoaming: "webauthn-roaming"; readonly WebauthnPlatform: "webauthn-platform"; }; export type GuardianEnrollmentFactorEnum = (typeof GuardianEnrollmentFactorEnum)[keyof typeof GuardianEnrollmentFactorEnum]; /** Status of this enrollment. Can be `pending` or `confirmed`. */ export declare const GuardianEnrollmentStatus: { readonly Pending: "pending"; readonly Confirmed: "confirmed"; }; export type GuardianEnrollmentStatus = (typeof GuardianEnrollmentStatus)[keyof typeof GuardianEnrollmentStatus]; export interface GuardianFactor { /** Whether this factor is enabled (true) or disabled (false). */ enabled: boolean; /** Whether trial limits have been exceeded. */ trial_expired?: boolean | undefined; name?: Management.GuardianFactorNameEnum | undefined; } /** Factor name. Can be `sms`, `push-notification`, `email`, `duo` `otp` `webauthn-roaming`, `webauthn-platform`, or `recovery-code`. */ export declare const GuardianFactorNameEnum: { readonly PushNotification: "push-notification"; readonly Sms: "sms"; readonly Email: "email"; readonly Duo: "duo"; readonly Otp: "otp"; readonly WebauthnRoaming: "webauthn-roaming"; readonly WebauthnPlatform: "webauthn-platform"; readonly RecoveryCode: "recovery-code"; }; export type GuardianFactorNameEnum = (typeof GuardianFactorNameEnum)[keyof typeof GuardianFactorNameEnum]; export declare const GuardianFactorPhoneFactorMessageTypeEnum: { readonly Sms: "sms"; readonly Voice: "voice"; }; export type GuardianFactorPhoneFactorMessageTypeEnum = (typeof GuardianFactorPhoneFactorMessageTypeEnum)[keyof typeof GuardianFactorPhoneFactorMessageTypeEnum]; export declare const GuardianFactorsProviderPushNotificationProviderDataEnum: { readonly Guardian: "guardian"; readonly Sns: "sns"; readonly Direct: "direct"; }; export type GuardianFactorsProviderPushNotificationProviderDataEnum = (typeof GuardianFactorsProviderPushNotificationProviderDataEnum)[keyof typeof GuardianFactorsProviderPushNotificationProviderDataEnum]; export declare const GuardianFactorsProviderSmsProviderEnum: { readonly Auth0: "auth0"; readonly Twilio: "twilio"; readonly PhoneMessageHook: "phone-message-hook"; }; export type GuardianFactorsProviderSmsProviderEnum = (typeof GuardianFactorsProviderSmsProviderEnum)[keyof typeof GuardianFactorsProviderSmsProviderEnum]; export interface Hook { /** Trigger ID */ triggerId?: string | undefined; /** ID of this hook. */ id?: string | undefined; /** Name of this hook. */ name?: string | undefined; /** Whether this hook will be executed (true) or ignored (false). */ enabled?: boolean | undefined; /** Code to be executed when this hook runs. */ script?: string | undefined; dependencies?: Management.HookDependencies | undefined; } /** * Dependencies of this hook used by webtask server. */ export type HookDependencies = Record; /** Retrieves hooks that match the trigger */ export declare const HookTriggerIdEnum: { readonly CredentialsExchange: "credentials-exchange"; readonly PreUserRegistration: "pre-user-registration"; readonly PostUserRegistration: "post-user-registration"; readonly PostChangePassword: "post-change-password"; readonly SendPhoneMessage: "send-phone-message"; }; export type HookTriggerIdEnum = (typeof HookTriggerIdEnum)[keyof typeof HookTriggerIdEnum]; export interface HttpCustomHeader { /** HTTP header name */ header?: string | undefined; /** HTTP header value */ value?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * This must be provided to verify primary social, enterprise and passwordless email identities. Also, is needed to verify secondary identities. */ export interface Identity { /** user_id of the identity to be verified. */ user_id: string; provider: Management.IdentityProviderEnum; /** connection_id of the identity. */ connection_id?: string | undefined; } /** Identity provider name of the identity (e.g. `google-oauth2`). */ export declare const IdentityProviderEnum: { readonly Ad: "ad"; readonly Adfs: "adfs"; readonly Amazon: "amazon"; readonly Apple: "apple"; readonly Dropbox: "dropbox"; readonly Bitbucket: "bitbucket"; readonly Auth0Oidc: "auth0-oidc"; readonly Auth0: "auth0"; readonly Baidu: "baidu"; readonly Bitly: "bitly"; readonly Box: "box"; readonly Custom: "custom"; readonly Daccount: "daccount"; readonly Dwolla: "dwolla"; readonly Email: "email"; readonly EvernoteSandbox: "evernote-sandbox"; readonly Evernote: "evernote"; readonly Exact: "exact"; readonly Facebook: "facebook"; readonly Fitbit: "fitbit"; readonly Github: "github"; readonly GoogleApps: "google-apps"; readonly GoogleOauth2: "google-oauth2"; readonly Instagram: "instagram"; readonly Ip: "ip"; readonly Line: "line"; readonly Linkedin: "linkedin"; readonly Oauth1: "oauth1"; readonly Oauth2: "oauth2"; readonly Office365: "office365"; readonly Oidc: "oidc"; readonly Okta: "okta"; readonly Paypal: "paypal"; readonly PaypalSandbox: "paypal-sandbox"; readonly Pingfederate: "pingfederate"; readonly Planningcenter: "planningcenter"; readonly SalesforceCommunity: "salesforce-community"; readonly SalesforceSandbox: "salesforce-sandbox"; readonly Salesforce: "salesforce"; readonly Samlp: "samlp"; readonly Sharepoint: "sharepoint"; readonly Shopify: "shopify"; readonly Shop: "shop"; readonly Sms: "sms"; readonly Soundcloud: "soundcloud"; readonly Thirtysevensignals: "thirtysevensignals"; readonly Twitter: "twitter"; readonly Untappd: "untappd"; readonly Vkontakte: "vkontakte"; readonly Waad: "waad"; readonly Weibo: "weibo"; readonly Windowslive: "windowslive"; readonly Wordpress: "wordpress"; readonly Yahoo: "yahoo"; readonly Yandex: "yandex"; }; export type IdentityProviderEnum = (typeof IdentityProviderEnum)[keyof typeof IdentityProviderEnum]; /** Identity provider name of the identity. Only `auth0` is supported */ export declare const IdentityProviderOnlyAuth0Enum: { readonly Auth0: "auth0"; }; export type IdentityProviderOnlyAuth0Enum = (typeof IdentityProviderOnlyAuth0Enum)[keyof typeof IdentityProviderOnlyAuth0Enum]; /** * Encryption key */ export interface ImportEncryptionKeyResponseContent { /** Key ID */ kid: string; type: Management.EncryptionKeyType; state: Management.EncryptionKeyState; /** Key creation timestamp */ created_at: string; /** Key update timestamp */ updated_at: string; /** ID of parent wrapping key */ parent_kid?: (string | null) | undefined; /** Public key in PEM format */ public_key?: (string | null) | undefined; } /** * Integration defines a self contained functioning unit which partners * publish. A partner may create one or many of these integrations. */ export interface Integration { /** * id is a system generated GUID. This same ID is designed to be federated in * all the applicable localities. */ id?: string | undefined; /** catalog_id refers to the ID in the marketplace catalog */ catalog_id?: string | undefined; /** url_slug refers to the url_slug in the marketplace catalog */ url_slug?: string | undefined; /** * partner_id is the foreign key reference to the partner account this * integration belongs to. */ partner_id?: string | undefined; /** * name is the integration name, which will be used for display purposes in * the marketplace. * * To start we're going to make sure the display name is at least 3 * characters. Can adjust this easily later. */ name?: string | undefined; /** * description adds more text for the integration name -- also relevant for * the marketplace listing. */ description?: string | undefined; /** short_description is the brief description of the integration, which is used for display purposes in cards */ short_description?: string | undefined; logo?: string | undefined; feature_type?: Management.IntegrationFeatureTypeEnum | undefined; terms_of_use_url?: string | undefined; privacy_policy_url?: string | undefined; public_support_link?: string | undefined; current_release?: Management.IntegrationRelease | undefined; created_at?: string | undefined; updated_at?: string | undefined; } /** feature_type is the type of the integration. */ export declare const IntegrationFeatureTypeEnum: { readonly Unspecified: "unspecified"; readonly Action: "action"; readonly SocialConnection: "social_connection"; readonly LogStream: "log_stream"; readonly SsoIntegration: "sso_integration"; readonly SmsProvider: "sms_provider"; }; export type IntegrationFeatureTypeEnum = (typeof IntegrationFeatureTypeEnum)[keyof typeof IntegrationFeatureTypeEnum]; export interface IntegrationRelease { /** The id of the associated IntegrationRelease */ id?: string | undefined; trigger?: Management.ActionTrigger | undefined; semver?: Management.IntegrationSemVer | undefined; /** * required_secrets declares all the necessary secrets for an integration to * work. */ required_secrets?: Management.IntegrationRequiredParam[] | undefined; /** required_configuration declares all the necessary configuration fields for an integration to work. */ required_configuration?: Management.IntegrationRequiredParam[] | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Param are form input values, primarily utilized when specifying secrets and * configuration values for actions. * * These are especially important for partner integrations -- but can be * exposed to tenant admins as well if they want to parameterize their custom * actions. */ export interface IntegrationRequiredParam { type?: Management.IntegrationRequiredParamTypeEnum | undefined; /** The name of the parameter. */ name?: string | undefined; /** The flag for if this parameter is required. */ required?: boolean | undefined; /** The temp flag for if this parameter is required (experimental; for Labs use only). */ optional?: boolean | undefined; /** The short label for this parameter. */ label?: string | undefined; /** The lengthier description for this parameter. */ description?: string | undefined; /** The default value for this parameter. */ default_value?: string | undefined; /** Placeholder text for this parameter. */ placeholder?: string | undefined; /** The allowable options for this param. */ options?: Management.IntegrationRequiredParamOption[] | undefined; } export interface IntegrationRequiredParamOption { /** The value of an option that will be used within the application. */ value?: string | undefined; /** The display value of an option suitable for displaying in a UI. */ label?: string | undefined; } export declare const IntegrationRequiredParamTypeEnum: { readonly Unspecified: "UNSPECIFIED"; readonly String: "STRING"; }; export type IntegrationRequiredParamTypeEnum = (typeof IntegrationRequiredParamTypeEnum)[keyof typeof IntegrationRequiredParamTypeEnum]; /** * Semver denotes the major.minor version of an integration release */ export interface IntegrationSemVer { /** Major is the major number of a semver */ major?: number | undefined; /** Minior is the minior number of a semver */ minor?: number | undefined; } /** Format of the file. Must be `json` or `csv`. */ export declare const JobFileFormatEnum: { readonly Json: "json"; readonly Csv: "csv"; }; export type JobFileFormatEnum = (typeof JobFileFormatEnum)[keyof typeof JobFileFormatEnum]; /** * Configuration for linked clients in the OIN Express Configuration feature. */ export interface LinkedClientConfiguration { /** The ID of the linked client. */ client_id: string; } export interface ListActionBindingsPaginatedResponseContent { /** The total result count. */ total?: number | undefined; /** Page index of the results being returned. First page is 0. */ page?: number | undefined; /** Number of results per page. */ per_page?: number | undefined; /** The list of actions that are bound to this trigger in the order in which they will be executed. */ bindings?: Management.ActionBinding[] | undefined; } export interface ListActionTriggersResponseContent { triggers?: Management.ActionTrigger[] | undefined; } export interface ListActionVersionsPaginatedResponseContent { /** The total result count. */ total?: number | undefined; /** Page index of the results being returned. First page is 0. */ page?: number | undefined; /** Number of results per page. */ per_page?: number | undefined; versions?: Management.ActionVersion[] | undefined; } export interface ListActionsPaginatedResponseContent { /** The total result count. */ total?: number | undefined; /** Page index of the results being returned. First page is 0. */ page?: number | undefined; /** Number of results per page. */ per_page?: number | undefined; /** The list of actions. */ actions?: Management.Action[] | undefined; } export interface ListAculsOffsetPaginatedResponseContent { configs?: Management.ListAculsResponseContentItem[] | undefined; /** the index of the first configuration in the response (before filtering) */ start?: number | undefined; /** the maximum number of configurations shown per page (before filtering) */ limit?: number | undefined; /** the total number of configurations on this tenant */ total?: number | undefined; } export interface ListAculsResponseContentItem { /** Tenant ID */ tenant?: string | undefined; /** Name of the prompt */ prompt?: string | undefined; /** Name of the screen */ screen?: string | undefined; /** Rendering mode */ rendering_mode?: Management.AculRenderingModeEnum | undefined; context_configuration?: ((Management.AculContextConfiguration | undefined) | null) | undefined; /** Override Universal Login default head tags */ default_head_tags_disabled?: (boolean | null) | undefined; /** Use page template with ACUL */ use_page_template?: (boolean | null) | undefined; /** An array of head tags */ head_tags?: (Management.AculHeadTag[] | null) | undefined; filters?: (Management.AculFilters | null) | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface ListBrandingPhoneProvidersResponseContent { providers?: Management.PhoneProviderSchemaMasked[] | undefined; } export interface ListClientConnectionsResponseContent { connections: Management.ConnectionForList[]; /** Encoded next token */ next?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface ListClientGrantOrganizationsPaginatedResponseContent { /** Opaque identifier for use with the from query parameter for the next page of results.
This identifier is valid for 24 hours. */ next?: string | undefined; organizations?: Management.Organization[] | undefined; } export interface ListClientGrantPaginatedResponseContent { /** Opaque identifier for use with the from query parameter for the next page of results.
This identifier is valid for 24 hours. */ next?: string | undefined; client_grants?: Management.ClientGrantResponseContent[] | undefined; } export interface ListClientsOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; clients?: Management.Client[] | undefined; } export interface ListConnectionProfileTemplateResponseContent { connection_profile_templates?: Management.ConnectionProfileTemplateItem[] | undefined; } export interface ListConnectionProfilesPaginatedResponseContent { /** A cursor to be used as the "from" query parameter for the next page of results. */ next?: string | undefined; connection_profiles?: Management.ConnectionProfile[] | undefined; } export interface ListConnectionsCheckpointPaginatedResponseContent { /** Opaque identifier for use with the from query parameter for the next page of results. */ next?: string | undefined; connections?: Management.ConnectionForList[] | undefined; } export type ListCustomDomainsResponseContent = Management.CustomDomain[]; export interface ListDeviceCredentialsOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; device_credentials?: Management.DeviceCredential[] | undefined; } export interface ListDirectoryProvisioningsResponseContent { /** List of directory provisioning configurations */ directory_provisionings: Management.DirectoryProvisioning[]; /** The cursor to be used as the "from" query parameter for the next page of results. */ next?: string | undefined; } export interface ListEncryptionKeyOffsetPaginatedResponseContent { /** Page index of the results to return. First page is 0. */ start?: number | undefined; /** Number of results per page. */ limit?: number | undefined; /** Total amount of encryption keys. */ total?: number | undefined; /** Encryption keys. */ keys?: Management.EncryptionKey[] | undefined; } export interface ListEventStreamsResponseContent { eventStreams?: Management.EventStreamResponseContent[] | undefined; /** Opaque identifier for use with the from query parameter for the next page of results. */ next?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface ListFlowExecutionsPaginatedResponseContent { /** Opaque identifier for use with the from query parameter for the next page of results.
This identifier is valid for 24 hours. */ next?: string | undefined; executions?: Management.FlowExecutionSummary[] | undefined; } export interface ListFlowsOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; flows?: Management.FlowSummary[] | undefined; } export declare const ListFlowsRequestParametersHydrateEnum: { readonly FormCount: "form_count"; }; export type ListFlowsRequestParametersHydrateEnum = (typeof ListFlowsRequestParametersHydrateEnum)[keyof typeof ListFlowsRequestParametersHydrateEnum]; export interface ListFlowsVaultConnectionsOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; connections?: Management.FlowsVaultConnectionSummary[] | undefined; } export interface ListFormsOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; forms?: Management.FormSummary[] | undefined; } export interface ListGroupsPaginatedResponseContent { groups: Management.Group[]; /** A cursor to be used as the "from" query parameter for the next page of results. */ next?: string | undefined; start?: number | undefined; limit?: number | undefined; total?: number | undefined; } export type ListGuardianPoliciesResponseContent = Management.MfaPolicyEnum[]; export interface ListHooksOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; hooks?: Management.Hook[] | undefined; } export interface ListLogOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; length?: number | undefined; total?: number | undefined; logs?: Management.Log[] | undefined; } export interface ListNetworkAclsOffsetPaginatedResponseContent { network_acls?: Management.NetworkAclsResponseContent[] | undefined; start?: number | undefined; limit?: number | undefined; total?: number | undefined; } export interface ListOrganizationAllConnectionsOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; connections?: Management.OrganizationAllConnectionPost[] | undefined; } export interface ListOrganizationClientGrantsOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; client_grants?: Management.OrganizationClientGrant[] | undefined; } export interface ListOrganizationConnectionsOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; enabled_connections?: Management.OrganizationConnection[] | undefined; } export interface ListOrganizationDiscoveryDomainsResponseContent { next?: string | undefined; domains: Management.OrganizationDiscoveryDomain[]; } export interface ListOrganizationInvitationsOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; invitations?: Management.OrganizationInvitation[] | undefined; } export interface ListOrganizationMemberRolesOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; roles?: Management.Role[] | undefined; } export interface ListOrganizationMembersPaginatedResponseContent { next?: string | undefined; members?: Management.OrganizationMember[] | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface ListOrganizationsPaginatedResponseContent { next?: string | undefined; organizations?: Management.Organization[] | undefined; } export interface ListPhoneTemplatesResponseContent { templates?: Management.PhoneTemplate[] | undefined; } export interface ListRefreshTokensPaginatedResponseContent { tokens?: Management.RefreshTokenResponseContent[] | undefined; /** A cursor to be used as the "from" query parameter for the next page of results. */ next?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface ListResourceServerOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; resource_servers?: Management.ResourceServer[] | undefined; } export interface ListRolePermissionsOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; permissions?: Management.PermissionsResponsePayload[] | undefined; } export interface ListRoleUsersPaginatedResponseContent { next?: string | undefined; users?: Management.RoleUser[] | undefined; } export interface ListRolesOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; roles?: Management.Role[] | undefined; } export interface ListRulesOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; rules?: Management.Rule[] | undefined; } export interface ListScimConfigurationsResponseContent { /** List of SCIM configurations */ scim_configurations: Management.ScimConfiguration[]; /** The cursor to be used as the "from" query parameter for the next page of results. */ next?: string | undefined; } /** * The list of custom text keys and values. */ export type ListSelfServiceProfileCustomTextResponseContent = Record; export interface ListSelfServiceProfilesPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; self_service_profiles?: Management.SelfServiceProfile[] | undefined; } export interface ListSynchronizedGroupsResponseContent { /** Array of Google Workspace group ids configured for synchronization. */ groups: Management.SynchronizedGroupPayload[]; /** The cursor to be used as the "from" query parameter for the next page of results. */ next?: string | undefined; } export interface ListTokenExchangeProfileResponseContent { /** Opaque identifier for use with the from query parameter for the next page of results.
This identifier is valid for 24 hours. */ next?: string | undefined; token_exchange_profiles?: Management.TokenExchangeProfileResponseContent[] | undefined; } export interface ListUserAttributeProfileTemplateResponseContent { user_attribute_profile_templates?: Management.UserAttributeProfileTemplateItem[] | undefined; } export interface ListUserAttributeProfilesPaginatedResponseContent { /** A cursor to be used as the "from" query parameter for the next page of results. */ next?: string | undefined; user_attribute_profiles?: Management.UserAttributeProfile[] | undefined; } export interface ListUserAuthenticationMethodsOffsetPaginatedResponseContent { /** Index of the starting record. Derived from the page and per_page parameters. */ start?: number | undefined; /** Maximum amount of records to return. */ limit?: number | undefined; /** Total number of pageable records. */ total?: number | undefined; /** The paginated authentication methods. Returned in this structure when include_totals is true. */ authenticators?: Management.UserAuthenticationMethod[] | undefined; } export interface ListUserBlocksByIdentifierResponseContent { /** Array of identifier + IP address pairs. IP address is optional, and may be omitted in certain circumstances (such as Account Lockout mode). */ blocked_for?: Management.UserBlockIdentifier[] | undefined; } export interface ListUserBlocksResponseContent { /** Array of identifier + IP address pairs. IP address is optional, and may be omitted in certain circumstances (such as Account Lockout mode). */ blocked_for?: Management.UserBlockIdentifier[] | undefined; } export interface ListUserConnectedAccountsResponseContent { connected_accounts: Management.ConnectedAccount[]; /** The token to retrieve the next page of connected accounts (if there is one) */ next?: string | undefined; } export interface ListUserGrantsOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; grants?: Management.UserGrant[] | undefined; } export interface ListUserOrganizationsOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; organizations?: Management.Organization[] | undefined; } export interface ListUserPermissionsOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; permissions?: Management.UserPermissionSchema[] | undefined; } export interface ListUserRolesOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; total?: number | undefined; roles?: Management.Role[] | undefined; } export interface ListUserSessionsPaginatedResponseContent { sessions?: Management.SessionResponseContent[] | undefined; /** A cursor to be used as the "from" query parameter for the next page of results. */ next?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface ListUsersOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; length?: number | undefined; total?: number | undefined; users?: Management.UserResponseSchema[] | undefined; } export interface ListVerifiableCredentialTemplatesPaginatedResponseContent { /** Opaque identifier for use with the from query parameter for the next page of results.
This identifier is valid for 24 hours. */ next?: (string | null) | undefined; templates?: Management.VerifiableCredentialTemplateResponse[] | undefined; } export interface Log { date?: Management.LogDate | undefined; /** Type of event. */ type?: string | undefined; /** Description of this event. */ description?: (string | null) | undefined; /** Name of the connection the event relates to. */ connection?: string | undefined; /** ID of the connection the event relates to. */ connection_id?: string | undefined; /** ID of the client (application). */ client_id?: string | undefined; /** Name of the client (application). */ client_name?: string | undefined; /** IP address of the log event source. */ ip?: string | undefined; /** Hostname the event applies to. */ hostname?: string | undefined; /** ID of the user involved in the event. */ user_id?: string | undefined; /** Name of the user involved in the event. */ user_name?: string | undefined; /** API audience the event applies to. */ audience?: string | undefined; /** Scope permissions applied to the event. */ scope?: string | undefined; /** Name of the strategy involved in the event. */ strategy?: string | undefined; /** Type of strategy involved in the event. */ strategy_type?: string | undefined; /** Unique ID of the event. */ log_id?: string | undefined; /** Whether the client was a mobile device (true) or desktop/laptop/server (false). */ isMobile?: boolean | undefined; details?: Management.LogDetails | undefined; /** User agent string from the client device that caused the event. */ user_agent?: string | undefined; security_context?: Management.LogSecurityContext | undefined; location_info?: Management.LogLocationInfo | undefined; /** Accepts any additional properties */ [key: string]: any; } export type LogDate = /** * Date when the event occurred in ISO 8601 format. */ string | Management.LogDateObject; /** * Date when the event occurred in ISO 8601 format. */ export type LogDateObject = Record; /** * Additional useful details about this event (structure is dependent upon event type). */ export type LogDetails = Record; /** * Information about the location that triggered this event based on the `ip`. */ export interface LogLocationInfo { /** Two-letter Alpha-2 ISO 3166-1 country code. */ country_code?: string | undefined; /** Three-letter Alpha-3 ISO 3166-1 country code. */ country_code3?: string | undefined; /** Full country name in English. */ country_name?: string | undefined; /** Full city name in English. */ city_name?: string | undefined; /** Global latitude (horizontal) position. */ latitude?: number | undefined; /** Global longitude (vertical) position. */ longitude?: number | undefined; /** Time zone name as found in the tz database. */ time_zone?: string | undefined; /** Continent the country is located within. Can be `AF` (Africa), `AN` (Antarctica), `AS` (Asia), `EU` (Europe), `NA` (North America), `OC` (Oceania) or `SA` (South America). */ continent_code?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Information about security-related signals. */ export interface LogSecurityContext { /** JA3 fingerprint value. */ ja3?: string | undefined; /** JA4 fingerprint value. */ ja4?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export declare const LogStreamDatadogEnum: { readonly Datadog: "datadog"; }; export type LogStreamDatadogEnum = (typeof LogStreamDatadogEnum)[keyof typeof LogStreamDatadogEnum]; /** Datadog region */ export declare const LogStreamDatadogRegionEnum: { readonly Us: "us"; readonly Eu: "eu"; readonly Us3: "us3"; readonly Us5: "us5"; }; export type LogStreamDatadogRegionEnum = (typeof LogStreamDatadogRegionEnum)[keyof typeof LogStreamDatadogRegionEnum]; export interface LogStreamDatadogResponseSchema { /** The id of the log stream */ id?: string | undefined; /** log stream name */ name?: string | undefined; status?: Management.LogStreamStatusEnum | undefined; type?: Management.LogStreamDatadogEnum | undefined; /** True for priority log streams, false for non-priority */ isPriority?: boolean | undefined; /** Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. */ filters?: Management.LogStreamFilter[] | undefined; pii_config?: Management.LogStreamPiiConfig | undefined; sink?: Management.LogStreamDatadogSink | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface LogStreamDatadogSink { /** Datadog API Key */ datadogApiKey: string; datadogRegion: Management.LogStreamDatadogRegionEnum; } export declare const LogStreamEventBridgeEnum: { readonly Eventbridge: "eventbridge"; }; export type LogStreamEventBridgeEnum = (typeof LogStreamEventBridgeEnum)[keyof typeof LogStreamEventBridgeEnum]; export interface LogStreamEventBridgeResponseSchema { /** The id of the log stream */ id?: string | undefined; /** log stream name */ name?: string | undefined; status?: Management.LogStreamStatusEnum | undefined; type?: Management.LogStreamEventBridgeEnum | undefined; /** True for priority log streams, false for non-priority */ isPriority?: boolean | undefined; /** Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. */ filters?: Management.LogStreamFilter[] | undefined; pii_config?: Management.LogStreamPiiConfig | undefined; sink?: Management.LogStreamEventBridgeSink | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface LogStreamEventBridgeSink { /** AWS account ID */ awsAccountId: string; awsRegion: Management.LogStreamEventBridgeSinkRegionEnum; /** AWS EventBridge partner event source */ awsPartnerEventSource?: string | undefined; } /** The region in which the EventBridge event source will be created */ export declare const LogStreamEventBridgeSinkRegionEnum: { readonly AfSouth1: "af-south-1"; readonly ApEast1: "ap-east-1"; readonly ApEast2: "ap-east-2"; readonly ApNortheast1: "ap-northeast-1"; readonly ApNortheast2: "ap-northeast-2"; readonly ApNortheast3: "ap-northeast-3"; readonly ApSouth1: "ap-south-1"; readonly ApSouth2: "ap-south-2"; readonly ApSoutheast1: "ap-southeast-1"; readonly ApSoutheast2: "ap-southeast-2"; readonly ApSoutheast3: "ap-southeast-3"; readonly ApSoutheast4: "ap-southeast-4"; readonly ApSoutheast5: "ap-southeast-5"; readonly ApSoutheast6: "ap-southeast-6"; readonly ApSoutheast7: "ap-southeast-7"; readonly CaCentral1: "ca-central-1"; readonly CaWest1: "ca-west-1"; readonly EuCentral1: "eu-central-1"; readonly EuCentral2: "eu-central-2"; readonly EuNorth1: "eu-north-1"; readonly EuSouth1: "eu-south-1"; readonly EuSouth2: "eu-south-2"; readonly EuWest1: "eu-west-1"; readonly EuWest2: "eu-west-2"; readonly EuWest3: "eu-west-3"; readonly IlCentral1: "il-central-1"; readonly MeCentral1: "me-central-1"; readonly MeSouth1: "me-south-1"; readonly MxCentral1: "mx-central-1"; readonly SaEast1: "sa-east-1"; readonly UsGovEast1: "us-gov-east-1"; readonly UsGovWest1: "us-gov-west-1"; readonly UsEast1: "us-east-1"; readonly UsEast2: "us-east-2"; readonly UsWest1: "us-west-1"; readonly UsWest2: "us-west-2"; }; export type LogStreamEventBridgeSinkRegionEnum = (typeof LogStreamEventBridgeSinkRegionEnum)[keyof typeof LogStreamEventBridgeSinkRegionEnum]; export declare const LogStreamEventGridEnum: { readonly Eventgrid: "eventgrid"; }; export type LogStreamEventGridEnum = (typeof LogStreamEventGridEnum)[keyof typeof LogStreamEventGridEnum]; /** Azure Region Name */ export declare const LogStreamEventGridRegionEnum: { readonly Australiacentral: "australiacentral"; readonly Australiaeast: "australiaeast"; readonly Australiasoutheast: "australiasoutheast"; readonly Brazilsouth: "brazilsouth"; readonly Canadacentral: "canadacentral"; readonly Canadaeast: "canadaeast"; readonly Centralindia: "centralindia"; readonly Centralus: "centralus"; readonly Eastasia: "eastasia"; readonly Eastus: "eastus"; readonly Eastus2: "eastus2"; readonly Francecentral: "francecentral"; readonly Germanywestcentral: "germanywestcentral"; readonly Japaneast: "japaneast"; readonly Japanwest: "japanwest"; readonly Koreacentral: "koreacentral"; readonly Koreasouth: "koreasouth"; readonly Northcentralus: "northcentralus"; readonly Northeurope: "northeurope"; readonly Norwayeast: "norwayeast"; readonly Southafricanorth: "southafricanorth"; readonly Southcentralus: "southcentralus"; readonly Southeastasia: "southeastasia"; readonly Southindia: "southindia"; readonly Swedencentral: "swedencentral"; readonly Switzerlandnorth: "switzerlandnorth"; readonly Uaenorth: "uaenorth"; readonly Uksouth: "uksouth"; readonly Ukwest: "ukwest"; readonly Westcentralus: "westcentralus"; readonly Westeurope: "westeurope"; readonly Westindia: "westindia"; readonly Westus: "westus"; readonly Westus2: "westus2"; }; export type LogStreamEventGridRegionEnum = (typeof LogStreamEventGridRegionEnum)[keyof typeof LogStreamEventGridRegionEnum]; export interface LogStreamEventGridResponseSchema { /** The id of the log stream */ id?: string | undefined; /** log stream name */ name?: string | undefined; status?: Management.LogStreamStatusEnum | undefined; type?: Management.LogStreamEventGridEnum | undefined; /** True for priority log streams, false for non-priority */ isPriority?: boolean | undefined; /** Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. */ filters?: Management.LogStreamFilter[] | undefined; pii_config?: Management.LogStreamPiiConfig | undefined; sink?: Management.LogStreamEventGridSink | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface LogStreamEventGridSink { /** Subscription ID */ azureSubscriptionId: string; azureRegion: Management.LogStreamEventGridRegionEnum; /** Resource Group */ azureResourceGroup: string; /** Partner Topic */ azurePartnerTopic?: string | undefined; } export interface LogStreamFilter { type?: Management.LogStreamFilterTypeEnum | undefined; name?: Management.LogStreamFilterGroupNameEnum | undefined; /** Accepts any additional properties */ [key: string]: any; } /** Category group name */ export declare const LogStreamFilterGroupNameEnum: { readonly AuthLoginFail: "auth.login.fail"; readonly AuthLoginNotification: "auth.login.notification"; readonly AuthLoginSuccess: "auth.login.success"; readonly AuthLogoutFail: "auth.logout.fail"; readonly AuthLogoutSuccess: "auth.logout.success"; readonly AuthSignupFail: "auth.signup.fail"; readonly AuthSignupSuccess: "auth.signup.success"; readonly AuthSilentAuthFail: "auth.silent_auth.fail"; readonly AuthSilentAuthSuccess: "auth.silent_auth.success"; readonly AuthTokenExchangeFail: "auth.token_exchange.fail"; readonly AuthTokenExchangeSuccess: "auth.token_exchange.success"; readonly ManagementFail: "management.fail"; readonly ManagementSuccess: "management.success"; readonly ScimEvent: "scim.event"; readonly SystemNotification: "system.notification"; readonly UserFail: "user.fail"; readonly UserNotification: "user.notification"; readonly UserSuccess: "user.success"; readonly Actions: "actions"; readonly Other: "other"; }; export type LogStreamFilterGroupNameEnum = (typeof LogStreamFilterGroupNameEnum)[keyof typeof LogStreamFilterGroupNameEnum]; /** Filter type. Currently `category` is the only valid type. */ export declare const LogStreamFilterTypeEnum: { readonly Category: "category"; }; export type LogStreamFilterTypeEnum = (typeof LogStreamFilterTypeEnum)[keyof typeof LogStreamFilterTypeEnum]; /** HTTP JSON format */ export declare const LogStreamHttpContentFormatEnum: { readonly Jsonarray: "JSONARRAY"; readonly Jsonlines: "JSONLINES"; readonly Jsonobject: "JSONOBJECT"; }; export type LogStreamHttpContentFormatEnum = (typeof LogStreamHttpContentFormatEnum)[keyof typeof LogStreamHttpContentFormatEnum]; export declare const LogStreamHttpEnum: { readonly Http: "http"; }; export type LogStreamHttpEnum = (typeof LogStreamHttpEnum)[keyof typeof LogStreamHttpEnum]; export interface LogStreamHttpResponseSchema { /** The id of the log stream */ id?: string | undefined; /** log stream name */ name?: string | undefined; status?: Management.LogStreamStatusEnum | undefined; type?: Management.LogStreamHttpEnum | undefined; /** True for priority log streams, false for non-priority */ isPriority?: boolean | undefined; /** Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. */ filters?: Management.LogStreamFilter[] | undefined; pii_config?: Management.LogStreamPiiConfig | undefined; sink?: Management.LogStreamHttpSink | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface LogStreamHttpSink { /** HTTP Authorization header */ httpAuthorization?: string | undefined; httpContentFormat?: Management.LogStreamHttpContentFormatEnum | undefined; /** HTTP Content-Type header */ httpContentType?: string | undefined; /** HTTP endpoint */ httpEndpoint: string; /** custom HTTP headers */ httpCustomHeaders?: Management.HttpCustomHeader[] | undefined; } export declare const LogStreamMixpanelEnum: { readonly Mixpanel: "mixpanel"; }; export type LogStreamMixpanelEnum = (typeof LogStreamMixpanelEnum)[keyof typeof LogStreamMixpanelEnum]; /** Mixpanel Region */ export declare const LogStreamMixpanelRegionEnum: { readonly Us: "us"; readonly Eu: "eu"; }; export type LogStreamMixpanelRegionEnum = (typeof LogStreamMixpanelRegionEnum)[keyof typeof LogStreamMixpanelRegionEnum]; export interface LogStreamMixpanelResponseSchema { /** The id of the log stream */ id?: string | undefined; /** log stream name */ name?: string | undefined; status?: Management.LogStreamStatusEnum | undefined; type?: Management.LogStreamMixpanelEnum | undefined; /** True for priority log streams, false for non-priority */ isPriority?: boolean | undefined; /** Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. */ filters?: Management.LogStreamFilter[] | undefined; pii_config?: Management.LogStreamPiiConfig | undefined; sink?: Management.LogStreamMixpanelSink | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface LogStreamMixpanelSink { mixpanelRegion: Management.LogStreamMixpanelRegionEnum; /** Mixpanel Project Id */ mixpanelProjectId: string; /** Mixpanel Service Account Username */ mixpanelServiceAccountUsername: string; /** Mixpanel Service Account Password */ mixpanelServiceAccountPassword: string; } export interface LogStreamMixpanelSinkPatch { mixpanelRegion: Management.LogStreamMixpanelRegionEnum; /** Mixpanel Project Id */ mixpanelProjectId: string; /** Mixpanel Service Account Username */ mixpanelServiceAccountUsername: string; /** Mixpanel Service Account Password */ mixpanelServiceAccountPassword?: string | undefined; } export declare const LogStreamPiiAlgorithmEnum: { readonly Xxhash: "xxhash"; }; export type LogStreamPiiAlgorithmEnum = (typeof LogStreamPiiAlgorithmEnum)[keyof typeof LogStreamPiiAlgorithmEnum]; export interface LogStreamPiiConfig { log_fields: Management.LogStreamPiiLogFieldsEnum[]; method?: Management.LogStreamPiiMethodEnum | undefined; algorithm?: Management.LogStreamPiiAlgorithmEnum | undefined; } export declare const LogStreamPiiLogFieldsEnum: { readonly FirstName: "first_name"; readonly LastName: "last_name"; readonly Username: "username"; readonly Email: "email"; readonly Phone: "phone"; readonly Address: "address"; }; export type LogStreamPiiLogFieldsEnum = (typeof LogStreamPiiLogFieldsEnum)[keyof typeof LogStreamPiiLogFieldsEnum]; export declare const LogStreamPiiMethodEnum: { readonly Mask: "mask"; readonly Hash: "hash"; }; export type LogStreamPiiMethodEnum = (typeof LogStreamPiiMethodEnum)[keyof typeof LogStreamPiiMethodEnum]; export type LogStreamResponseSchema = Management.LogStreamHttpResponseSchema | Management.LogStreamEventBridgeResponseSchema | Management.LogStreamEventGridResponseSchema | Management.LogStreamDatadogResponseSchema | Management.LogStreamSplunkResponseSchema | Management.LogStreamSumoResponseSchema | Management.LogStreamSegmentResponseSchema | Management.LogStreamMixpanelResponseSchema; export declare const LogStreamSegmentEnum: { readonly Segment: "segment"; }; export type LogStreamSegmentEnum = (typeof LogStreamSegmentEnum)[keyof typeof LogStreamSegmentEnum]; export interface LogStreamSegmentResponseSchema { /** The id of the log stream */ id?: string | undefined; /** log stream name */ name?: string | undefined; status?: Management.LogStreamStatusEnum | undefined; type?: Management.LogStreamSegmentEnum | undefined; /** True for priority log streams, false for non-priority */ isPriority?: boolean | undefined; /** Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. */ filters?: Management.LogStreamFilter[] | undefined; pii_config?: Management.LogStreamPiiConfig | undefined; sink?: Management.LogStreamSegmentSinkWriteKey | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface LogStreamSegmentSink { /** Segment write key */ segmentWriteKey?: string | undefined; } export interface LogStreamSegmentSinkWriteKey { /** Segment write key */ segmentWriteKey: string; } export type LogStreamSinkPatch = Management.LogStreamHttpSink | Management.LogStreamDatadogSink | Management.LogStreamSplunkSink | Management.LogStreamSumoSink | Management.LogStreamSegmentSink | Management.LogStreamMixpanelSinkPatch; export declare const LogStreamSplunkEnum: { readonly Splunk: "splunk"; }; export type LogStreamSplunkEnum = (typeof LogStreamSplunkEnum)[keyof typeof LogStreamSplunkEnum]; export interface LogStreamSplunkResponseSchema { /** The id of the log stream */ id?: string | undefined; /** log stream name */ name?: string | undefined; status?: Management.LogStreamStatusEnum | undefined; type?: Management.LogStreamSplunkEnum | undefined; /** True for priority log streams, false for non-priority */ isPriority?: boolean | undefined; /** Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. */ filters?: Management.LogStreamFilter[] | undefined; pii_config?: Management.LogStreamPiiConfig | undefined; sink?: Management.LogStreamSplunkSink | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface LogStreamSplunkSink { /** Splunk URL Endpoint */ splunkDomain: string; /** Port */ splunkPort: string; /** Splunk token */ splunkToken: string; /** Verify TLS certificate */ splunkSecure: boolean; } /** The status of the log stream. Possible values: `active`, `paused`, `suspended` */ export declare const LogStreamStatusEnum: { readonly Active: "active"; readonly Paused: "paused"; readonly Suspended: "suspended"; }; export type LogStreamStatusEnum = (typeof LogStreamStatusEnum)[keyof typeof LogStreamStatusEnum]; export declare const LogStreamSumoEnum: { readonly Sumo: "sumo"; }; export type LogStreamSumoEnum = (typeof LogStreamSumoEnum)[keyof typeof LogStreamSumoEnum]; export interface LogStreamSumoResponseSchema { /** The id of the log stream */ id?: string | undefined; /** log stream name */ name?: string | undefined; status?: Management.LogStreamStatusEnum | undefined; type?: Management.LogStreamSumoEnum | undefined; /** True for priority log streams, false for non-priority */ isPriority?: boolean | undefined; /** Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. */ filters?: Management.LogStreamFilter[] | undefined; pii_config?: Management.LogStreamPiiConfig | undefined; sink?: Management.LogStreamSumoSink | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface LogStreamSumoSink { /** HTTP Source Address */ sumoSourceAddress: string; } /** The MFA policy */ export declare const MfaPolicyEnum: { readonly AllApplications: "all-applications"; readonly ConfidenceScore: "confidence-score"; }; export type MfaPolicyEnum = (typeof MfaPolicyEnum)[keyof typeof MfaPolicyEnum]; export interface MdlPresentationProperties { /** Family Name */ family_name?: boolean | undefined; /** Given Name */ given_name?: boolean | undefined; /** Birth Date */ birth_date?: boolean | undefined; /** Issue Date */ issue_date?: boolean | undefined; /** Expiry Date */ expiry_date?: boolean | undefined; /** Issuing Country */ issuing_country?: boolean | undefined; /** Issuing Authority */ issuing_authority?: boolean | undefined; /** Portrait */ portrait?: boolean | undefined; /** Driving Privileges */ driving_privileges?: boolean | undefined; /** Resident Address */ resident_address?: boolean | undefined; /** Portrait Capture Date */ portrait_capture_date?: boolean | undefined; /** Age in Years */ age_in_years?: boolean | undefined; /** Age Birth Year */ age_birth_year?: boolean | undefined; /** Issuing Jurisdiction */ issuing_jurisdiction?: boolean | undefined; /** Nationality */ nationality?: boolean | undefined; /** Resident City */ resident_city?: boolean | undefined; /** Resident State */ resident_state?: boolean | undefined; /** Resident Postal Code */ resident_postal_code?: boolean | undefined; /** Resident Country */ resident_country?: boolean | undefined; /** Family Name National Character */ family_name_national_character?: boolean | undefined; /** Given Name National Character */ given_name_national_character?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * A simplified presentation request */ export interface MdlPresentationRequest { "org.iso.18013.5.1.mDL": Management.MdlPresentationRequestProperties; } export interface MdlPresentationRequestProperties { "org.iso.18013.5.1": Management.MdlPresentationProperties; } /** * Configure native social settings */ export interface NativeSocialLogin { apple?: Management.NativeSocialLoginApple | undefined; facebook?: Management.NativeSocialLoginFacebook | undefined; google?: Management.NativeSocialLoginGoogle | undefined; } /** * Native Social Login support for the Apple connection */ export interface NativeSocialLoginApple { /** Determine whether or not to allow signing in natively using an Apple authorization code */ enabled?: boolean | undefined; } /** * Native Social Login support for the Facebook connection */ export interface NativeSocialLoginFacebook { /** Determine whether or not to allow signing in natively using Facebook */ enabled?: boolean | undefined; } /** * Native Social Login support for the google-oauth2 connection */ export interface NativeSocialLoginGoogle { /** Determine whether or not to allow signing in natively using a Google ID token */ enabled?: boolean | undefined; } export type NetworkAclMatchConnectingIpv4Cidr = string; export type NetworkAclMatchConnectingIpv6Cidr = string; export type NetworkAclMatchIpv4Cidr = string; export type NetworkAclMatchIpv6Cidr = string; export interface NetworkAclAction { block?: Management.NetworkAclActionBlockEnum | undefined; allow?: Management.NetworkAclActionAllowEnum | undefined; log?: Management.NetworkAclActionLogEnum | undefined; redirect?: Management.NetworkAclActionRedirectEnum | undefined; /** The URI to which the match or not_match requests will be routed */ redirect_uri?: string | undefined; } /** * Indicates the rule will allow requests that either match or not_match specific criteria */ export type NetworkAclActionAllowEnum = boolean; /** * Indicates the rule will block requests that either match or not_match specific criteria */ export type NetworkAclActionBlockEnum = boolean; /** * Indicates the rule will log requests that either match or not_match specific criteria */ export type NetworkAclActionLogEnum = boolean; /** * Indicates the rule will redirect requests that either match or not_match specific criteria */ export type NetworkAclActionRedirectEnum = boolean; export interface NetworkAclMatch { asns?: number[] | undefined; geo_country_codes?: string[] | undefined; geo_subdivision_codes?: string[] | undefined; ipv4_cidrs?: Management.NetworkAclMatchIpv4Cidr[] | undefined; ipv6_cidrs?: Management.NetworkAclMatchIpv6Cidr[] | undefined; ja3_fingerprints?: string[] | undefined; ja4_fingerprints?: string[] | undefined; user_agents?: string[] | undefined; hostnames?: string[] | undefined; connecting_ipv4_cidrs?: Management.NetworkAclMatchConnectingIpv4Cidr[] | undefined; connecting_ipv6_cidrs?: Management.NetworkAclMatchConnectingIpv6Cidr[] | undefined; } export interface NetworkAclRule { action: Management.NetworkAclAction; match?: Management.NetworkAclMatch | undefined; not_match?: Management.NetworkAclMatch | undefined; scope: Management.NetworkAclRuleScopeEnum; } /** Identifies the origin of the request as the Management API (management), Authentication API (authentication), Dynamic Client Registration API (dynamic_client_registration), or any (tenant) */ export declare const NetworkAclRuleScopeEnum: { readonly Management: "management"; readonly Authentication: "authentication"; readonly Tenant: "tenant"; readonly DynamicClientRegistration: "dynamic_client_registration"; }; export type NetworkAclRuleScopeEnum = (typeof NetworkAclRuleScopeEnum)[keyof typeof NetworkAclRuleScopeEnum]; export interface NetworkAclsResponseContent { id?: string | undefined; description?: string | undefined; active?: boolean | undefined; priority?: number | undefined; rule?: Management.NetworkAclRule | undefined; /** The timestamp when the Network ACL Configuration was created */ created_at?: string | undefined; /** The timestamp when the Network ACL Configuration was last updated */ updated_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface Organization { /** Organization identifier. */ id?: string | undefined; /** The name of this organization. */ name?: string | undefined; /** Friendly name of this organization. */ display_name?: string | undefined; branding?: Management.OrganizationBranding | undefined; metadata?: Management.OrganizationMetadata | undefined; token_quota?: Management.TokenQuota | undefined; /** Accepts any additional properties */ [key: string]: any; } /** Access level for the organization (e.g., "none", "full"). */ export declare const OrganizationAccessLevelEnum: { readonly None: "none"; readonly Readonly: "readonly"; readonly Limited: "limited"; readonly Full: "full"; }; export type OrganizationAccessLevelEnum = (typeof OrganizationAccessLevelEnum)[keyof typeof OrganizationAccessLevelEnum]; /** Access level for the organization (e.g., "none", "full"). */ export declare const OrganizationAccessLevelEnumWithNull: { readonly None: "none"; readonly Readonly: "readonly"; readonly Limited: "limited"; readonly Full: "full"; }; export type OrganizationAccessLevelEnumWithNull = (typeof OrganizationAccessLevelEnumWithNull)[keyof typeof OrganizationAccessLevelEnumWithNull]; export interface OrganizationAllConnectionPost { /** Name of the connection in the scope of this organization. */ organization_connection_name?: string | undefined; /** 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. */ assign_membership_on_login?: boolean | undefined; /** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */ show_as_button?: boolean | undefined; /** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */ is_signup_enabled?: boolean | undefined; organization_access_level?: Management.OrganizationAccessLevelEnum | undefined; /** Whether the connection is enabled for the organization. */ is_enabled?: boolean | undefined; /** Connection identifier. */ connection_id: string; connection?: Management.OrganizationConnectionInformation | undefined; } /** * Theme defines how to style the login pages. */ export interface OrganizationBranding { /** URL of logo to display on login page. */ logo_url?: string | undefined; colors?: Management.OrganizationBrandingColors | undefined; } /** * Color scheme used to customize the login pages. */ export interface OrganizationBrandingColors { /** HEX Color for primary elements. */ primary: string; /** HEX Color for background. */ page_background: string; } export interface OrganizationClientGrant { /** ID of the client grant. */ id?: string | undefined; /** ID of the client. */ client_id?: string | undefined; /** The audience (API identifier) of this client grant */ audience?: string | undefined; /** Scopes allowed for this client grant. */ scope?: string[] | undefined; organization_usage?: Management.OrganizationUsageEnum | undefined; /** If enabled, any organization can be used with this grant. If disabled (default), the grant must be explicitly assigned to the desired organizations. */ allow_any_organization?: boolean | undefined; } export interface OrganizationConnection { /** ID of the connection. */ connection_id?: string | undefined; /** 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. */ assign_membership_on_login?: boolean | undefined; /** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */ show_as_button?: boolean | undefined; /** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */ is_signup_enabled?: boolean | undefined; connection?: Management.OrganizationConnectionInformation | undefined; } export interface OrganizationConnectionInformation { /** The name of the enabled connection. */ name?: string | undefined; /** The strategy of the enabled connection. */ strategy?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface OrganizationDiscoveryDomain { /** Organization discovery domain identifier. */ id: string; /** The domain name to associate with the organization e.g. acme.com. */ domain: string; status: Management.OrganizationDiscoveryDomainStatus; /** Indicates whether this domain should be used for organization discovery. */ use_for_organization_discovery?: boolean | undefined; /** A unique token generated for the discovery domain. This must be placed in a DNS TXT record at the location specified by the verification_host field to prove domain ownership. */ verification_txt: string; /** The full domain where the TXT record should be added. */ verification_host: string; } /** The verification status of the discovery domain. */ export declare const OrganizationDiscoveryDomainStatus: { readonly Pending: "pending"; readonly Verified: "verified"; }; export type OrganizationDiscoveryDomainStatus = (typeof OrganizationDiscoveryDomainStatus)[keyof typeof OrganizationDiscoveryDomainStatus]; export interface OrganizationEnabledConnection { /** ID of the connection. */ connection_id?: string | undefined; /** 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. */ assign_membership_on_login?: boolean | undefined; /** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */ show_as_button?: boolean | undefined; /** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */ is_signup_enabled?: boolean | undefined; connection?: Management.OrganizationConnectionInformation | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface OrganizationInvitation { /** The id of the user invitation. */ id?: string | undefined; /** Organization identifier. */ organization_id?: string | undefined; inviter?: Management.OrganizationInvitationInviter | undefined; invitee?: Management.OrganizationInvitationInvitee | undefined; /** The invitation url to be send to the invitee. */ invitation_url?: string | undefined; /** The ISO 8601 formatted timestamp representing the creation time of the invitation. */ created_at?: string | undefined; /** The ISO 8601 formatted timestamp representing the expiration time of the invitation. */ expires_at?: string | undefined; /** Auth0 client ID. Used to resolve the application's login initiation endpoint. */ client_id?: string | undefined; /** The id of the connection to force invitee to authenticate with. */ connection_id?: string | undefined; app_metadata?: Management.AppMetadata | undefined; user_metadata?: Management.UserMetadata | undefined; /** List of roles IDs to associated with the user. */ roles?: string[] | undefined; /** The id of the invitation ticket */ ticket_id?: string | undefined; } export interface OrganizationInvitationInvitee { /** The invitee's email. */ email: string; } export interface OrganizationInvitationInviter { /** The inviter's name. */ name: string; } export interface OrganizationMember { /** ID of this user. */ user_id?: string | undefined; /** URL to a picture for this user. */ picture?: string | undefined; /** Name of this user. */ name?: string | undefined; /** Email address of this user. */ email?: string | undefined; roles?: Management.OrganizationMemberRole[] | undefined; } export interface OrganizationMemberRole { /** ID for this role. */ id?: string | undefined; /** Name of this role. */ name?: string | undefined; } /** * Metadata associated with the organization, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed. */ export type OrganizationMetadata = Record; /** Defines whether organizations can be used with client credentials exchanges for this grant. */ export declare const OrganizationUsageEnum: { readonly Deny: "deny"; readonly Allow: "allow"; readonly Require: "require"; }; export type OrganizationUsageEnum = (typeof OrganizationUsageEnum)[keyof typeof OrganizationUsageEnum]; /** Name of the prompt. */ export declare const PartialGroupsEnum: { readonly Login: "login"; readonly LoginId: "login-id"; readonly LoginPassword: "login-password"; readonly LoginPasswordless: "login-passwordless"; readonly Signup: "signup"; readonly SignupId: "signup-id"; readonly SignupPassword: "signup-password"; readonly CustomizedConsent: "customized-consent"; readonly Passkeys: "passkeys"; }; export type PartialGroupsEnum = (typeof PartialGroupsEnum)[keyof typeof PartialGroupsEnum]; export interface PartialPhoneTemplateContent { /** Default phone number to be used as 'from' when sending a phone notification */ from?: string | undefined; body?: Management.PhoneTemplateBody | undefined; } export declare const PasswordCharacterTypeEnum: { readonly Uppercase: "uppercase"; readonly Lowercase: "lowercase"; readonly Number: "number"; readonly Special: "special"; }; export type PasswordCharacterTypeEnum = (typeof PasswordCharacterTypeEnum)[keyof typeof PasswordCharacterTypeEnum]; /** When enabled, passwords must contain at least 3 out of 4 character types. Can only be enabled when all 4 character types are specified */ export declare const PasswordCharacterTypeRulePolicyEnum: { readonly All: "all"; readonly ThreeOfFour: "three_of_four"; }; export type PasswordCharacterTypeRulePolicyEnum = (typeof PasswordCharacterTypeRulePolicyEnum)[keyof typeof PasswordCharacterTypeRulePolicyEnum]; /** Default dictionary to use for password validation. Options: "en_10k" (10,000 common words) or "en_100k" (100,000 common words) */ export declare const PasswordDefaultDictionariesEnum: { readonly En10K: "en_10k"; readonly En100K: "en_100k"; }; export type PasswordDefaultDictionariesEnum = (typeof PasswordDefaultDictionariesEnum)[keyof typeof PasswordDefaultDictionariesEnum]; /** Controls whether identical consecutive characters are allowed in passwords */ export declare const PasswordIdenticalCharactersPolicyEnum: { readonly Allow: "allow"; readonly Block: "block"; }; export type PasswordIdenticalCharactersPolicyEnum = (typeof PasswordIdenticalCharactersPolicyEnum)[keyof typeof PasswordIdenticalCharactersPolicyEnum]; /** Controls whether passwords that exceed the maximum length are truncated or rejected */ export declare const PasswordMaxLengthExceededPolicyEnum: { readonly Truncate: "truncate"; readonly Error: "error"; }; export type PasswordMaxLengthExceededPolicyEnum = (typeof PasswordMaxLengthExceededPolicyEnum)[keyof typeof PasswordMaxLengthExceededPolicyEnum]; /** Controls whether sequential characters are allowed in passwords */ export declare const PasswordSequentialCharactersPolicyEnum: { readonly Allow: "allow"; readonly Block: "block"; }; export type PasswordSequentialCharactersPolicyEnum = (typeof PasswordSequentialCharactersPolicyEnum)[keyof typeof PasswordSequentialCharactersPolicyEnum]; export interface PatchClientCredentialResponseContent { /** ID of the credential. Generated on creation. */ id?: string | undefined; /** The name given to the credential by the user. */ name?: string | undefined; /** The key identifier of the credential, generated on creation. */ kid?: string | undefined; alg?: Management.ClientCredentialAlgorithmEnum | undefined; credential_type?: Management.ClientCredentialTypeEnum | undefined; /** The X509 certificate's Subject Distinguished Name */ subject_dn?: string | undefined; /** The X509 certificate's SHA256 thumbprint */ thumbprint_sha256?: string | undefined; /** The ISO 8601 formatted date the credential was created. */ created_at?: string | undefined; /** The ISO 8601 formatted date the credential was updated. */ updated_at?: string | undefined; /** The ISO 8601 formatted date representing the expiration of the credential. */ expires_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface PatchSupplementalSignalsResponseContent { /** Indicates if incoming Akamai Headers should be processed */ akamai_enabled?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface PermissionRequestPayload { /** Resource server (API) identifier that this permission is for. */ resource_server_identifier: string; /** Name of this permission. */ permission_name: string; } export interface PermissionsResponsePayload { /** Resource server (API) identifier that this permission is for. */ resource_server_identifier?: string | undefined; /** Name of this permission. */ permission_name?: string | undefined; /** Resource server (API) name this permission is for. */ resource_server_name?: string | undefined; /** Description of this permission. */ description?: string | undefined; } /** * Configuration for the phone number attribute for users. */ export interface PhoneAttribute { identifier?: Management.ConnectionAttributeIdentifier | undefined; /** Determines if property should be required for users */ profile_required?: boolean | undefined; signup?: Management.SignupVerified | undefined; } /** This depicts the type of notifications this provider can receive. */ export declare const PhoneProviderChannelEnum: { readonly Phone: "phone"; }; export type PhoneProviderChannelEnum = (typeof PhoneProviderChannelEnum)[keyof typeof PhoneProviderChannelEnum]; export type PhoneProviderConfiguration = Management.TwilioProviderConfiguration | Management.CustomProviderConfiguration; /** * Provider credentials required to use authenticate to the provider. */ export type PhoneProviderCredentials = Management.TwilioProviderCredentials | Management.CustomProviderCredentials; /** The delivery method for the notification */ export declare const PhoneProviderDeliveryMethodEnum: { readonly Text: "text"; readonly Voice: "voice"; }; export type PhoneProviderDeliveryMethodEnum = (typeof PhoneProviderDeliveryMethodEnum)[keyof typeof PhoneProviderDeliveryMethodEnum]; /** Name of the phone notification provider */ export declare const PhoneProviderNameEnum: { readonly Twilio: "twilio"; readonly Custom: "custom"; }; export type PhoneProviderNameEnum = (typeof PhoneProviderNameEnum)[keyof typeof PhoneProviderNameEnum]; /** * Phone provider configuration schema */ export interface PhoneProviderSchemaMasked { id?: string | undefined; /** The name of the tenant */ tenant?: string | undefined; name: Management.PhoneProviderNameEnum; channel?: Management.PhoneProviderChannelEnum | undefined; /** Whether the provider is enabled (false) or disabled (true). */ disabled?: boolean | undefined; configuration?: Management.PhoneProviderConfiguration | undefined; /** The provider's creation date and time in ISO 8601 format */ created_at?: string | undefined; /** The date and time of the last update to the provider in ISO 8601 format */ updated_at?: string | undefined; } export interface PhoneTemplate { id: string; channel?: string | undefined; customizable?: boolean | undefined; tenant?: string | undefined; content: Management.PhoneTemplateContent; type: Management.PhoneTemplateNotificationTypeEnum; /** Whether the template is enabled (false) or disabled (true). */ disabled: boolean; } export interface PhoneTemplateBody { /** Content of the phone template for text notifications */ text?: string | undefined; /** Content of the phone template for voice notifications */ voice?: string | undefined; } export interface PhoneTemplateContent { syntax?: string | undefined; /** Default phone number to be used as 'from' when sending a phone notification */ from?: string | undefined; body?: Management.PhoneTemplateBody | undefined; } export declare const PhoneTemplateNotificationTypeEnum: { readonly OtpVerify: "otp_verify"; readonly OtpEnroll: "otp_enroll"; readonly ChangePassword: "change_password"; readonly BlockedAccount: "blocked_account"; readonly PasswordBreach: "password_breach"; }; export type PhoneTemplateNotificationTypeEnum = (typeof PhoneTemplateNotificationTypeEnum)[keyof typeof PhoneTemplateNotificationTypeEnum]; export interface PostClientCredentialResponseContent { /** ID of the credential. Generated on creation. */ id?: string | undefined; /** The name given to the credential by the user. */ name?: string | undefined; /** The key identifier of the credential, generated on creation. */ kid?: string | undefined; alg?: Management.ClientCredentialAlgorithmEnum | undefined; credential_type?: Management.ClientCredentialTypeEnum | undefined; /** The X509 certificate's Subject Distinguished Name */ subject_dn?: string | undefined; /** The X509 certificate's SHA256 thumbprint */ thumbprint_sha256?: string | undefined; /** The ISO 8601 formatted date the credential was created. */ created_at?: string | undefined; /** The ISO 8601 formatted date the credential was updated. */ updated_at?: string | undefined; /** The ISO 8601 formatted date representing the expiration of the credential. */ expires_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** Selected Signing Algorithm */ export declare const PostConnectionKeysAlgEnum: { readonly Rs256: "RS256"; readonly Rs384: "RS384"; readonly Rs512: "RS512"; readonly Ps256: "PS256"; readonly Ps384: "PS384"; readonly Es256: "ES256"; readonly Es384: "ES384"; }; export type PostConnectionKeysAlgEnum = (typeof PostConnectionKeysAlgEnum)[keyof typeof PostConnectionKeysAlgEnum]; export interface PostConnectionKeysRequestContent { signing_alg?: Management.PostConnectionKeysAlgEnum | undefined; } export interface PostConnectionsKeysResponseContentItem { /** The key id of the signing key */ kid: string; /** The public certificate of the signing key */ cert: string; /** The public certificate of the signing key in pkcs7 format */ pkcs?: string | undefined; /** True if the key is the current key */ current?: boolean | undefined; /** True if the key is the next key */ next?: boolean | undefined; /** The date and time when the key became the current key */ current_since?: string | undefined; /** The cert fingerprint */ fingerprint: string; /** The cert thumbprint */ thumbprint: string; /** Signing key algorithm */ algorithm?: string | undefined; key_use?: Management.ConnectionKeyUseEnum | undefined; subject_dn?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export type PostConnectionsKeysResponseContent = Management.PostConnectionsKeysResponseContentItem[]; /** Applies to phone authentication methods only. The preferred communication method. */ export declare const PreferredAuthenticationMethodEnum: { readonly Voice: "voice"; readonly Sms: "sms"; }; export type PreferredAuthenticationMethodEnum = (typeof PreferredAuthenticationMethodEnum)[keyof typeof PreferredAuthenticationMethodEnum]; export interface PreviewCimdMetadataResponseContent { /** The client_id of an existing client registered with this external_client_id, if one exists. */ client_id?: string | undefined; /** Array of retrieval errors (populated when the metadata document could not be fetched). When present, validation is omitted. */ errors?: string[] | undefined; validation?: Management.CimdValidationResult | undefined; mapped_fields?: Management.CimdMappedClientFields | undefined; /** Accepts any additional properties */ [key: string]: any; } /** Name of the prompt */ export declare const PromptGroupNameEnum: { readonly Login: "login"; readonly LoginId: "login-id"; readonly LoginPassword: "login-password"; readonly LoginPasswordless: "login-passwordless"; readonly LoginEmailVerification: "login-email-verification"; readonly Signup: "signup"; readonly SignupId: "signup-id"; readonly SignupPassword: "signup-password"; readonly PhoneIdentifierEnrollment: "phone-identifier-enrollment"; readonly PhoneIdentifierChallenge: "phone-identifier-challenge"; readonly EmailIdentifierChallenge: "email-identifier-challenge"; readonly ResetPassword: "reset-password"; readonly CustomForm: "custom-form"; readonly Consent: "consent"; readonly CustomizedConsent: "customized-consent"; readonly Logout: "logout"; readonly MfaPush: "mfa-push"; readonly MfaOtp: "mfa-otp"; readonly MfaVoice: "mfa-voice"; readonly MfaPhone: "mfa-phone"; readonly MfaWebauthn: "mfa-webauthn"; readonly MfaSms: "mfa-sms"; readonly MfaEmail: "mfa-email"; readonly MfaRecoveryCode: "mfa-recovery-code"; readonly Mfa: "mfa"; readonly Status: "status"; readonly DeviceFlow: "device-flow"; readonly EmailVerification: "email-verification"; readonly EmailOtpChallenge: "email-otp-challenge"; readonly Organizations: "organizations"; readonly Invitation: "invitation"; readonly Common: "common"; readonly Passkeys: "passkeys"; readonly Captcha: "captcha"; readonly BruteForceProtection: "brute-force-protection"; readonly AsyncApprovalFlow: "async-approval-flow"; }; export type PromptGroupNameEnum = (typeof PromptGroupNameEnum)[keyof typeof PromptGroupNameEnum]; /** Language to update. */ export declare const PromptLanguageEnum: { readonly Am: "am"; readonly Ar: "ar"; readonly ArEg: "ar-EG"; readonly ArSa: "ar-SA"; readonly Az: "az"; readonly Bg: "bg"; readonly Bn: "bn"; readonly Bs: "bs"; readonly CaEs: "ca-ES"; readonly Cnr: "cnr"; readonly Cs: "cs"; readonly Cy: "cy"; readonly Da: "da"; readonly De: "de"; readonly El: "el"; readonly En: "en"; readonly EnCa: "en-CA"; readonly Es: "es"; readonly Es419: "es-419"; readonly EsAr: "es-AR"; readonly EsMx: "es-MX"; readonly Et: "et"; readonly EuEs: "eu-ES"; readonly Fa: "fa"; readonly Fi: "fi"; readonly Fr: "fr"; readonly FrCa: "fr-CA"; readonly FrFr: "fr-FR"; readonly GlEs: "gl-ES"; readonly Gu: "gu"; readonly He: "he"; readonly Hi: "hi"; readonly Hr: "hr"; readonly Hu: "hu"; readonly Hy: "hy"; readonly Id: "id"; readonly Is: "is"; readonly It: "it"; readonly Ja: "ja"; readonly Ka: "ka"; readonly Kk: "kk"; readonly Kn: "kn"; readonly Ko: "ko"; readonly Lt: "lt"; readonly Lv: "lv"; readonly Mk: "mk"; readonly Ml: "ml"; readonly Mn: "mn"; readonly Mr: "mr"; readonly Ms: "ms"; readonly My: "my"; readonly Nb: "nb"; readonly Nl: "nl"; readonly Nn: "nn"; readonly No: "no"; readonly Pa: "pa"; readonly Pl: "pl"; readonly Pt: "pt"; readonly PtBr: "pt-BR"; readonly PtPt: "pt-PT"; readonly Ro: "ro"; readonly Ru: "ru"; readonly Sk: "sk"; readonly Sl: "sl"; readonly So: "so"; readonly Sq: "sq"; readonly Sr: "sr"; readonly Sv: "sv"; readonly Sw: "sw"; readonly Ta: "ta"; readonly Te: "te"; readonly Th: "th"; readonly Tl: "tl"; readonly Tr: "tr"; readonly Uk: "uk"; readonly Ur: "ur"; readonly Vi: "vi"; readonly Zgh: "zgh"; readonly ZhCn: "zh-CN"; readonly ZhHk: "zh-HK"; readonly ZhMo: "zh-MO"; readonly ZhTw: "zh-TW"; }; export type PromptLanguageEnum = (typeof PromptLanguageEnum)[keyof typeof PromptLanguageEnum]; export interface PublicKeyCredential { credential_type: Management.PublicKeyCredentialTypeEnum; /** Friendly name for a credential. */ name?: string | undefined; /** PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped. */ pem: string; alg?: Management.PublicKeyCredentialAlgorithmEnum | undefined; /** Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. Applies to `public_key` credential type. */ parse_expiry_from_cert?: boolean | undefined; /** The ISO 8601 formatted date representing the expiration of the credential. If not specified (not recommended), the credential never expires. Applies to `public_key` credential type. */ expires_at?: string | undefined; /** Optional kid (Key ID), used to uniquely identify the credential. If not specified, a kid value will be auto-generated. The kid header parameter in JWTs sent by your client should match this value. Valid format is [0-9a-zA-Z-_]{10,64} */ kid?: string | undefined; } /** Algorithm which will be used with the credential. Can be one of RS256, RS384, PS256. If not specified, RS256 will be used. Applies to `public_key` credential type. */ export declare const PublicKeyCredentialAlgorithmEnum: { readonly Rs256: "RS256"; readonly Rs384: "RS384"; readonly Ps256: "PS256"; }; export type PublicKeyCredentialAlgorithmEnum = (typeof PublicKeyCredentialAlgorithmEnum)[keyof typeof PublicKeyCredentialAlgorithmEnum]; /** Credential type. Supported types: public_key. */ export declare const PublicKeyCredentialTypeEnum: { readonly PublicKey: "public_key"; }; export type PublicKeyCredentialTypeEnum = (typeof PublicKeyCredentialTypeEnum)[keyof typeof PublicKeyCredentialTypeEnum]; export type RefreshTokenDate = /** * The date and time when the refresh token was created */ string | Management.RefreshTokenDateObject; /** * The date and time when the refresh token was created */ export type RefreshTokenDateObject = Record; /** * Device used while issuing/exchanging the refresh token */ export interface RefreshTokenDevice { /** First IP address associated with the refresh token */ initial_ip?: string | undefined; /** First autonomous system number associated with the refresh token */ initial_asn?: string | undefined; /** First user agent associated with the refresh token */ initial_user_agent?: string | undefined; /** Last IP address associated with the refresh token */ last_ip?: string | undefined; /** Last autonomous system number associated with the refresh token */ last_asn?: string | undefined; /** Last user agent associated with the refresh token */ last_user_agent?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** Refresh token expiration types, one of: expiring, non-expiring */ export declare const RefreshTokenExpirationTypeEnum: { readonly Expiring: "expiring"; readonly NonExpiring: "non-expiring"; }; export type RefreshTokenExpirationTypeEnum = (typeof RefreshTokenExpirationTypeEnum)[keyof typeof RefreshTokenExpirationTypeEnum]; /** * Metadata associated with the refresh token, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed. */ export type RefreshTokenMetadata = (Record | null) | undefined; export interface RefreshTokenResourceServer { /** Resource server ID */ audience?: string | undefined; /** List of scopes for the refresh token */ scopes?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface RefreshTokenResponseContent { /** The ID of the refresh token */ id?: string | undefined; /** ID of the user which can be used when interacting with other APIs. */ user_id?: string | undefined; created_at?: Management.RefreshTokenDate | undefined; idle_expires_at?: Management.RefreshTokenDate | undefined; expires_at?: Management.RefreshTokenDate | undefined; device?: Management.RefreshTokenDevice | undefined; /** ID of the client application granted with this refresh token */ client_id?: string | undefined; session_id?: ((Management.RefreshTokenSessionId | undefined) | null) | undefined; /** True if the token is a rotating refresh token */ rotating?: boolean | undefined; /** A list of the resource server IDs associated to this refresh-token and their granted scopes */ resource_servers?: Management.RefreshTokenResourceServer[] | undefined; refresh_token_metadata?: ((Management.RefreshTokenMetadata | undefined) | null) | undefined; last_exchanged_at?: Management.RefreshTokenDate | undefined; /** Accepts any additional properties */ [key: string]: any; } /** Refresh token rotation types, one of: rotating, non-rotating */ export declare const RefreshTokenRotationTypeEnum: { readonly Rotating: "rotating"; readonly NonRotating: "non-rotating"; }; export type RefreshTokenRotationTypeEnum = (typeof RefreshTokenRotationTypeEnum)[keyof typeof RefreshTokenRotationTypeEnum]; /** * ID of the authenticated session used to obtain this refresh-token */ export type RefreshTokenSessionId = (string | null) | undefined; export interface RegenerateUsersRecoveryCodeResponseContent { /** New account recovery code. */ recovery_code?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Response after successfully registering or updating a CIMD client */ export interface RegisterCimdClientResponseContent { /** The Auth0 client_id of the created or updated client */ client_id: string; mapped_fields: Management.CimdMappedClientFields; validation: Management.CimdValidationResult; /** Accepts any additional properties */ [key: string]: any; } export type ResetPhoneTemplateRequestContent = unknown; export interface ResetPhoneTemplateResponseContent { id: string; channel?: string | undefined; customizable?: boolean | undefined; tenant?: string | undefined; content: Management.PhoneTemplateContent; type: Management.PhoneTemplateNotificationTypeEnum; /** Whether the template is enabled (false) or disabled (true). */ disabled: boolean; } export interface ResourceServer { /** ID of the API (resource server). */ id?: string | undefined; /** Friendly name for this resource server. Can not contain `<` or `>` characters. */ name?: string | undefined; /** Whether this is an Auth0 system API (true) or a custom API (false). */ is_system?: boolean | undefined; /** Unique identifier for the API used as the audience parameter on authorization calls. Can not be changed once set. */ identifier?: string | undefined; /** List of permissions (scopes) that this API uses. */ scopes?: Management.ResourceServerScope[] | undefined; signing_alg?: Management.SigningAlgorithmEnum | undefined; /** Secret used to sign tokens when using symmetric algorithms (HS256). */ signing_secret?: string | undefined; /** Whether refresh tokens can be issued for this API (true) or not (false). */ allow_offline_access?: boolean | undefined; /** Whether Online Refresh Tokens can be issued for this API (true) or not (false). */ allow_online_access?: boolean | undefined; /** Whether to skip user consent for applications flagged as first party (true) or not (false). */ skip_consent_for_verifiable_first_party_clients?: boolean | undefined; /** Expiration value (in seconds) for access tokens issued for this API from the token endpoint. */ token_lifetime?: number | undefined; /** Expiration value (in seconds) for access tokens issued for this API via Implicit or Hybrid Flows. Cannot be greater than the `token_lifetime` value. */ token_lifetime_for_web?: number | undefined; /** Whether authorization polices are enforced (true) or unenforced (false). */ enforce_policies?: boolean | undefined; token_dialect?: Management.ResourceServerTokenDialectResponseEnum | undefined; token_encryption?: (Management.ResourceServerTokenEncryption | null) | undefined; consent_policy?: (Management.ResourceServerConsentPolicyEnum | null) | undefined; authorization_details?: (unknown[] | null) | undefined; proof_of_possession?: (Management.ResourceServerProofOfPossession | null) | undefined; subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization | undefined; /** The client ID of the client that this resource server is linked to */ client_id?: string | undefined; } export declare const ResourceServerConsentPolicyEnum: { readonly TransactionalAuthorizationWithMfa: "transactional-authorization-with-mfa"; }; export type ResourceServerConsentPolicyEnum = (typeof ResourceServerConsentPolicyEnum)[keyof typeof ResourceServerConsentPolicyEnum]; /** * Proof-of-Possession configuration for access tokens */ export interface ResourceServerProofOfPossession { mechanism: Management.ResourceServerProofOfPossessionMechanismEnum; /** Whether the use of Proof-of-Possession is required for the resource server */ required: boolean; required_for?: Management.ResourceServerProofOfPossessionRequiredForEnum | undefined; } /** Intended mechanism for Proof-of-Possession */ export declare const ResourceServerProofOfPossessionMechanismEnum: { readonly Mtls: "mtls"; readonly Dpop: "dpop"; }; export type ResourceServerProofOfPossessionMechanismEnum = (typeof ResourceServerProofOfPossessionMechanismEnum)[keyof typeof ResourceServerProofOfPossessionMechanismEnum]; /** Specifies which client types require Proof-of-Possession */ export declare const ResourceServerProofOfPossessionRequiredForEnum: { readonly PublicClients: "public_clients"; readonly AllClients: "all_clients"; }; export type ResourceServerProofOfPossessionRequiredForEnum = (typeof ResourceServerProofOfPossessionRequiredForEnum)[keyof typeof ResourceServerProofOfPossessionRequiredForEnum]; export interface ResourceServerScope { /** Value of this scope. */ value: string; /** User-friendly description of this scope. */ description?: string | undefined; } /** * Defines application access permission for a resource server */ export interface ResourceServerSubjectTypeAuthorization { user?: Management.ResourceServerSubjectTypeAuthorizationUser | undefined; client?: Management.ResourceServerSubjectTypeAuthorizationClient | undefined; } /** * Access Permissions for client flows */ export interface ResourceServerSubjectTypeAuthorizationClient { policy?: Management.ResourceServerSubjectTypeAuthorizationClientPolicyEnum | undefined; /** Accepts any additional properties */ [key: string]: any; } /** Defines the client flows policy for the resource server */ export declare const ResourceServerSubjectTypeAuthorizationClientPolicyEnum: { readonly DenyAll: "deny_all"; readonly RequireClientGrant: "require_client_grant"; }; export type ResourceServerSubjectTypeAuthorizationClientPolicyEnum = (typeof ResourceServerSubjectTypeAuthorizationClientPolicyEnum)[keyof typeof ResourceServerSubjectTypeAuthorizationClientPolicyEnum]; /** * Access Permissions for user flows */ export interface ResourceServerSubjectTypeAuthorizationUser { policy?: Management.ResourceServerSubjectTypeAuthorizationUserPolicyEnum | undefined; /** Accepts any additional properties */ [key: string]: any; } /** Defines the user flows policy for the resource server */ export declare const ResourceServerSubjectTypeAuthorizationUserPolicyEnum: { readonly AllowAll: "allow_all"; readonly DenyAll: "deny_all"; readonly RequireClientGrant: "require_client_grant"; }; export type ResourceServerSubjectTypeAuthorizationUserPolicyEnum = (typeof ResourceServerSubjectTypeAuthorizationUserPolicyEnum)[keyof typeof ResourceServerSubjectTypeAuthorizationUserPolicyEnum]; /** Dialect of access tokens that should be issued. `access_token` is a JWT containing standard Auth0 claims; `rfc9068_profile` is a JWT conforming to the IETF JWT Access Token Profile. `access_token_authz` and `rfc9068_profile_authz` additionally include RBAC permissions claims. */ export declare const ResourceServerTokenDialectResponseEnum: { readonly AccessToken: "access_token"; readonly AccessTokenAuthz: "access_token_authz"; readonly Rfc9068Profile: "rfc9068_profile"; readonly Rfc9068ProfileAuthz: "rfc9068_profile_authz"; }; export type ResourceServerTokenDialectResponseEnum = (typeof ResourceServerTokenDialectResponseEnum)[keyof typeof ResourceServerTokenDialectResponseEnum]; /** Dialect of issued access token. `access_token` is a JWT containing standard Auth0 claims; `rfc9068_profile` is a JWT conforming to the IETF JWT Access Token Profile. `access_token_authz` and `rfc9068_profile_authz` additionally include RBAC permissions claims. */ export declare const ResourceServerTokenDialectSchemaEnum: { readonly AccessToken: "access_token"; readonly AccessTokenAuthz: "access_token_authz"; readonly Rfc9068Profile: "rfc9068_profile"; readonly Rfc9068ProfileAuthz: "rfc9068_profile_authz"; }; export type ResourceServerTokenDialectSchemaEnum = (typeof ResourceServerTokenDialectSchemaEnum)[keyof typeof ResourceServerTokenDialectSchemaEnum]; export interface ResourceServerTokenEncryption { format: Management.ResourceServerTokenEncryptionFormatEnum; encryption_key: Management.ResourceServerTokenEncryptionKey; } /** Algorithm used to encrypt the token. */ export declare const ResourceServerTokenEncryptionAlgorithmEnum: { readonly RsaOaep256: "RSA-OAEP-256"; readonly RsaOaep384: "RSA-OAEP-384"; readonly RsaOaep512: "RSA-OAEP-512"; }; export type ResourceServerTokenEncryptionAlgorithmEnum = (typeof ResourceServerTokenEncryptionAlgorithmEnum)[keyof typeof ResourceServerTokenEncryptionAlgorithmEnum]; /** Format of the encrypted JWT payload. */ export declare const ResourceServerTokenEncryptionFormatEnum: { readonly CompactNestedJwe: "compact-nested-jwe"; }; export type ResourceServerTokenEncryptionFormatEnum = (typeof ResourceServerTokenEncryptionFormatEnum)[keyof typeof ResourceServerTokenEncryptionFormatEnum]; export interface ResourceServerTokenEncryptionKey { /** Name of the encryption key. */ name?: string | undefined; alg: Management.ResourceServerTokenEncryptionAlgorithmEnum; /** Key ID. */ kid?: string | undefined; /** PEM-formatted public key. Must be JSON escaped. */ pem: string; } /** * PEM-encoded certificate */ export type ResourceServerVerificationKeyPemCertificate = string; export interface RevokedSigningKeysResponseContent { /** Revoked key certificate */ cert: string; /** Revoked key id */ kid: string; /** Accepts any additional properties */ [key: string]: any; } export interface Role { /** ID for this role. */ id?: string | undefined; /** Name of this role. */ name?: string | undefined; /** Description of this role. */ description?: string | undefined; } export interface RoleUser { /** ID of this user. */ user_id?: string | undefined; /** URL to a picture for this user. */ picture?: string | undefined; /** Name of this user. */ name?: string | undefined; /** Email address of this user. */ email?: string | undefined; } export interface RollbackActionModuleResponseContent { /** The unique ID of the module. */ id?: string | undefined; /** The name of the module. */ name?: string | undefined; /** The source code from the module's draft version. */ code?: string | undefined; /** The npm dependencies from the module's draft version. */ dependencies?: Management.ActionModuleDependency[] | undefined; /** The secrets from the module's draft version (names and timestamps only, values never returned). */ secrets?: Management.ActionModuleSecret[] | undefined; /** The number of deployed actions using this module. */ actions_using_module_total?: number | undefined; /** Whether all draft changes have been published as a version. */ all_changes_published?: boolean | undefined; /** The version number of the latest published version. Omitted if no versions have been published. */ latest_version_number?: number | undefined; /** Timestamp when the module was created. */ created_at?: string | undefined; /** Timestamp when the module was last updated. */ updated_at?: string | undefined; latest_version?: Management.ActionModuleVersionReference | undefined; } export interface RotateClientSecretResponseContent { /** ID of this client. */ client_id?: string | undefined; /** Name of the tenant this client belongs to. */ tenant?: string | undefined; /** Name of this client (min length: 1 character, does not allow `<` or `>`). */ name?: string | undefined; /** Free text description of this client (max length: 140 characters). */ description?: string | undefined; /** Whether this is your global 'All Applications' client representing legacy tenant settings (true) or a regular client (false). */ global?: boolean | undefined; /** Client secret (which you must not make public). */ client_secret?: string | undefined; app_type?: Management.ClientAppTypeEnum | undefined; /** URL of the logo to display for this client. Recommended size is 150x150 pixels. */ logo_uri?: string | undefined; /** Whether this client a first party client (true) or not (false). */ is_first_party?: boolean | undefined; /** Whether this client conforms to strict OIDC specifications (true) or uses legacy features (false). */ oidc_conformant?: boolean | undefined; /** Comma-separated list of URLs whitelisted for Auth0 to use as a callback to the client after authentication. */ callbacks?: string[] | undefined; /** Comma-separated list of URLs allowed to make requests from JavaScript to Auth0 API (typically used with CORS). By default, all your callback URLs will be allowed. This field allows you to enter other origins if necessary. You can also use wildcards at the subdomain level (e.g., https://*.contoso.com). Query strings and hash information are not taken into account when validating these URLs. */ allowed_origins?: string[] | undefined; /** Comma-separated list of allowed origins for use with Cross-Origin Authentication, Device Flow, and web message response mode. */ web_origins?: string[] | undefined; /** List of audiences/realms for SAML protocol. Used by the wsfed addon. */ client_aliases?: string[] | undefined; /** List of allow clients and API ids that are allowed to make delegation requests. Empty means all all your clients are allowed. */ allowed_clients?: string[] | undefined; /** Comma-separated list of URLs that are valid to redirect to after logout from Auth0. Wildcards are allowed for subdomains. */ allowed_logout_urls?: string[] | undefined; session_transfer?: (Management.ClientSessionTransferConfiguration | null) | undefined; oidc_logout?: Management.ClientOidcBackchannelLogoutSettings | undefined; /** List of grant types supported for this application. Can include `authorization_code`, `implicit`, `refresh_token`, `client_credentials`, `password`, `http://auth0.com/oauth/grant-type/password-realm`, `http://auth0.com/oauth/grant-type/mfa-oob`, `http://auth0.com/oauth/grant-type/mfa-otp`, `http://auth0.com/oauth/grant-type/mfa-recovery-code`, `urn:openid:params:grant-type:ciba`, `urn:ietf:params:oauth:grant-type:device_code`, and `urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token`. */ grant_types?: string[] | undefined; jwt_configuration?: Management.ClientJwtConfiguration | undefined; signing_keys?: ((Management.ClientSigningKeys | undefined) | null) | undefined; encryption_key?: (Management.ClientEncryptionKey | null) | undefined; /** Applies only to SSO clients and determines whether Auth0 will handle Single Sign On (true) or whether the Identity Provider will (false). */ sso?: boolean | undefined; /** Whether Single Sign On is disabled (true) or enabled (true). Defaults to true. */ sso_disabled?: boolean | undefined; /** Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false). */ cross_origin_authentication?: boolean | undefined; /** URL of the location in your site where the cross origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page. */ cross_origin_loc?: string | undefined; /** Whether a custom login page is to be used (true) or the default provided login page (false). */ custom_login_page_on?: boolean | undefined; /** The content (HTML, CSS, JS) of the custom login page. */ custom_login_page?: string | undefined; /** The content (HTML, CSS, JS) of the custom login page. (Used on Previews) */ custom_login_page_preview?: string | undefined; /** HTML form template to be used for WS-Federation. */ form_template?: string | undefined; addons?: Management.ClientAddons | undefined; token_endpoint_auth_method?: Management.ClientTokenEndpointAuthMethodEnum | undefined; /** If true, trust that the IP specified in the `auth0-forwarded-for` header is the end-user's IP for brute-force-protection on token endpoint. */ is_token_endpoint_ip_header_trusted?: boolean | undefined; client_metadata?: Management.ClientMetadata | undefined; mobile?: Management.ClientMobile | undefined; /** Initiate login uri, must be https */ initiate_login_uri?: string | undefined; refresh_token?: (Management.ClientRefreshTokenConfiguration | null) | undefined; default_organization?: (Management.ClientDefaultOrganization | null) | undefined; organization_usage?: Management.ClientOrganizationUsageEnum | undefined; organization_require_behavior?: Management.ClientOrganizationRequireBehaviorEnum | undefined; /** Defines the available methods for organization discovery during the `pre_login_prompt`. Users can discover their organization either by `email`, `organization_name` or both. */ organization_discovery_methods?: Management.ClientOrganizationDiscoveryEnum[] | undefined; client_authentication_methods?: (Management.ClientAuthenticationMethod | null) | undefined; /** Makes the use of Pushed Authorization Requests mandatory for this client */ require_pushed_authorization_requests?: boolean | undefined; /** Makes the use of Proof-of-Possession mandatory for this client */ require_proof_of_possession?: boolean | undefined; signed_request_object?: Management.ClientSignedRequestObjectWithCredentialId | undefined; compliance_level?: (Management.ClientComplianceLevelEnum | null) | undefined; /** * Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as `myapp://`, or `localhost`). * If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps. * See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information. */ skip_non_verifiable_callback_uri_confirmation_prompt?: boolean | undefined; token_exchange?: Management.ClientTokenExchangeConfiguration | undefined; /** Specifies how long, in seconds, a Pushed Authorization Request URI remains valid */ par_request_expiry?: (number | null) | undefined; token_quota?: Management.TokenQuota | undefined; express_configuration?: Management.ExpressConfiguration | undefined; my_organization_configuration?: Management.ClientMyOrganizationResponseConfiguration | undefined; third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum | undefined; redirection_policy?: Management.ClientRedirectionPolicyEnum | undefined; /** The identifier of the resource server that this client is linked to. */ resource_server_identifier?: string | undefined; async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPostConfiguration | undefined; external_metadata_type?: Management.ClientExternalMetadataTypeEnum | undefined; external_metadata_created_by?: Management.ClientExternalMetadataCreatedByEnum | undefined; /** An alternate client identifier to be used during authorization flows. Only supports CIMD-based client identifiers. */ external_client_id?: string | undefined; /** URL for the JSON Web Key Set (JWKS) containing the public keys used for private_key_jwt authentication. Only present for CIMD clients using private_key_jwt authentication. */ jwks_uri?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface RotateConnectionKeysRequestContent { signing_alg?: Management.RotateConnectionKeysSigningAlgEnum | undefined; } /** Selected Signing Algorithm */ export declare const RotateConnectionKeysSigningAlgEnum: { readonly Rs256: "RS256"; readonly Rs384: "RS384"; readonly Rs512: "RS512"; readonly Ps256: "PS256"; readonly Ps384: "PS384"; readonly Es256: "ES256"; readonly Es384: "ES384"; }; export type RotateConnectionKeysSigningAlgEnum = (typeof RotateConnectionKeysSigningAlgEnum)[keyof typeof RotateConnectionKeysSigningAlgEnum]; export interface RotateConnectionsKeysResponseContent { /** The key id of the signing key */ kid: string; /** The public certificate of the signing key */ cert: string; /** The public certificate of the signing key in pkcs7 format */ pkcs?: string | undefined; /** True if the key is the the next key */ next?: boolean | undefined; /** The cert fingerprint */ fingerprint: string; /** The cert thumbprint */ thumbprint: string; /** Signing key algorithm */ algorithm?: string | undefined; key_use?: Management.ConnectionKeyUseEnum | undefined; subject_dn?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface RotateSigningKeysResponseContent { /** Next key certificate */ cert: string; /** Next key id */ kid: string; /** Accepts any additional properties */ [key: string]: any; } export interface Rule { /** Name of this rule. */ name?: string | undefined; /** ID of this rule. */ id?: string | undefined; /** Whether the rule is enabled (true), or disabled (false). */ enabled?: boolean | undefined; /** Code to be executed when this rule runs. */ script?: string | undefined; /** Order that this rule should execute in relative to other rules. Lower-valued rules execute first. */ order?: number | undefined; /** Execution stage of this rule. Can be `login_success`, `login_failure`, or `pre_authorize`. */ stage?: string | undefined; } export interface RulesConfig { /** Key for a rules config variable. */ key?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface ScimConfiguration { /** The connection's identifier */ connection_id: string; /** The connection's name */ connection_name: string; /** The connection's strategy */ strategy: string; /** The tenant's name */ tenant_name: string; /** User ID attribute for generating unique user ids */ user_id_attribute: string; /** The mapping between auth0 and SCIM */ mapping: Management.ScimMappingItem[]; /** The ISO 8601 date and time the SCIM configuration was created at */ created_at: string; /** The ISO 8601 date and time the SCIM configuration was last updated on */ updated_on: string; } export interface ScimMappingItem { /** The field location in the auth0 schema */ auth0?: string | undefined; /** The field location in the SCIM schema */ scim?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface ScimTokenItem { /** The token's identifier */ token_id?: string | undefined; /** The scopes of the scim token */ scopes?: string[] | undefined; /** The token's created at timestamp */ created_at?: string | undefined; /** The token's valid until timestamp */ valid_until?: string | undefined; /** The token's last used at timestamp */ last_used_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** Name of the screen */ export declare const ScreenGroupNameEnum: { readonly Login: "login"; readonly LoginId: "login-id"; readonly LoginPassword: "login-password"; readonly LoginPasswordlessEmailCode: "login-passwordless-email-code"; readonly LoginPasswordlessEmailLink: "login-passwordless-email-link"; readonly LoginPasswordlessSmsOtp: "login-passwordless-sms-otp"; readonly LoginEmailVerification: "login-email-verification"; readonly Signup: "signup"; readonly SignupId: "signup-id"; readonly SignupPassword: "signup-password"; readonly PhoneIdentifierEnrollment: "phone-identifier-enrollment"; readonly PhoneIdentifierChallenge: "phone-identifier-challenge"; readonly EmailIdentifierChallenge: "email-identifier-challenge"; readonly ResetPasswordRequest: "reset-password-request"; readonly ResetPasswordEmail: "reset-password-email"; readonly ResetPassword: "reset-password"; readonly ResetPasswordSuccess: "reset-password-success"; readonly ResetPasswordError: "reset-password-error"; readonly ResetPasswordMfaEmailChallenge: "reset-password-mfa-email-challenge"; readonly ResetPasswordMfaOtpChallenge: "reset-password-mfa-otp-challenge"; readonly ResetPasswordMfaPhoneChallenge: "reset-password-mfa-phone-challenge"; readonly ResetPasswordMfaPushChallengePush: "reset-password-mfa-push-challenge-push"; readonly ResetPasswordMfaRecoveryCodeChallenge: "reset-password-mfa-recovery-code-challenge"; readonly ResetPasswordMfaSmsChallenge: "reset-password-mfa-sms-challenge"; readonly ResetPasswordMfaVoiceChallenge: "reset-password-mfa-voice-challenge"; readonly ResetPasswordMfaWebauthnPlatformChallenge: "reset-password-mfa-webauthn-platform-challenge"; readonly ResetPasswordMfaWebauthnRoamingChallenge: "reset-password-mfa-webauthn-roaming-challenge"; readonly CustomForm: "custom-form"; readonly Consent: "consent"; readonly CustomizedConsent: "customized-consent"; readonly Logout: "logout"; readonly LogoutComplete: "logout-complete"; readonly LogoutAborted: "logout-aborted"; readonly MfaPushWelcome: "mfa-push-welcome"; readonly MfaPushEnrollmentQr: "mfa-push-enrollment-qr"; readonly MfaPushEnrollmentCode: "mfa-push-enrollment-code"; readonly MfaPushSuccess: "mfa-push-success"; readonly MfaPushChallengePush: "mfa-push-challenge-push"; readonly MfaPushList: "mfa-push-list"; readonly MfaOtpEnrollmentQr: "mfa-otp-enrollment-qr"; readonly MfaOtpEnrollmentCode: "mfa-otp-enrollment-code"; readonly MfaOtpChallenge: "mfa-otp-challenge"; readonly MfaVoiceEnrollment: "mfa-voice-enrollment"; readonly MfaVoiceChallenge: "mfa-voice-challenge"; readonly MfaPhoneChallenge: "mfa-phone-challenge"; readonly MfaPhoneEnrollment: "mfa-phone-enrollment"; readonly MfaWebauthnPlatformEnrollment: "mfa-webauthn-platform-enrollment"; readonly MfaWebauthnRoamingEnrollment: "mfa-webauthn-roaming-enrollment"; readonly MfaWebauthnPlatformChallenge: "mfa-webauthn-platform-challenge"; readonly MfaWebauthnRoamingChallenge: "mfa-webauthn-roaming-challenge"; readonly MfaWebauthnChangeKeyNickname: "mfa-webauthn-change-key-nickname"; readonly MfaWebauthnEnrollmentSuccess: "mfa-webauthn-enrollment-success"; readonly MfaWebauthnError: "mfa-webauthn-error"; readonly MfaWebauthnNotAvailableError: "mfa-webauthn-not-available-error"; readonly MfaCountryCodes: "mfa-country-codes"; readonly MfaSmsEnrollment: "mfa-sms-enrollment"; readonly MfaSmsChallenge: "mfa-sms-challenge"; readonly MfaSmsList: "mfa-sms-list"; readonly MfaEmailChallenge: "mfa-email-challenge"; readonly MfaEmailList: "mfa-email-list"; readonly MfaRecoveryCodeEnrollment: "mfa-recovery-code-enrollment"; readonly MfaRecoveryCodeChallengeNewCode: "mfa-recovery-code-challenge-new-code"; readonly MfaRecoveryCodeChallenge: "mfa-recovery-code-challenge"; readonly MfaDetectBrowserCapabilities: "mfa-detect-browser-capabilities"; readonly MfaEnrollResult: "mfa-enroll-result"; readonly MfaLoginOptions: "mfa-login-options"; readonly MfaBeginEnrollOptions: "mfa-begin-enroll-options"; readonly Status: "status"; readonly DeviceCodeActivation: "device-code-activation"; readonly DeviceCodeActivationAllowed: "device-code-activation-allowed"; readonly DeviceCodeActivationDenied: "device-code-activation-denied"; readonly DeviceCodeConfirmation: "device-code-confirmation"; readonly EmailVerificationResult: "email-verification-result"; readonly EmailOtpChallenge: "email-otp-challenge"; readonly OrganizationSelection: "organization-selection"; readonly OrganizationPicker: "organization-picker"; readonly PreLoginOrganizationPicker: "pre-login-organization-picker"; readonly AcceptInvitation: "accept-invitation"; readonly RedeemTicket: "redeem-ticket"; readonly PasskeyEnrollment: "passkey-enrollment"; readonly PasskeyEnrollmentLocal: "passkey-enrollment-local"; readonly InterstitialCaptcha: "interstitial-captcha"; readonly BruteForceProtectionUnblock: "brute-force-protection-unblock"; readonly BruteForceProtectionUnblockSuccess: "brute-force-protection-unblock-success"; readonly BruteForceProtectionUnblockFailure: "brute-force-protection-unblock-failure"; readonly AsyncApprovalError: "async-approval-error"; readonly AsyncApprovalAccepted: "async-approval-accepted"; readonly AsyncApprovalDenied: "async-approval-denied"; readonly AsyncApprovalWrongUser: "async-approval-wrong-user"; }; export type ScreenGroupNameEnum = (typeof ScreenGroupNameEnum)[keyof typeof ScreenGroupNameEnum]; /** The version of the search engine */ export declare const SearchEngineVersionsEnum: { readonly V1: "v1"; readonly V2: "v2"; readonly V3: "v3"; }; export type SearchEngineVersionsEnum = (typeof SearchEngineVersionsEnum)[keyof typeof SearchEngineVersionsEnum]; export interface SelfServiceProfile { /** The unique ID of the self-service Profile. */ id?: string | undefined; /** The name of the self-service Profile. */ name?: string | undefined; /** The description of the self-service Profile. */ description?: string | undefined; /** List of attributes to be mapped that will be shown to the user during the SS-SSO flow. */ user_attributes?: Management.SelfServiceProfileUserAttribute[] | undefined; /** The time when this self-service Profile was created. */ created_at?: string | undefined; /** The time when this self-service Profile was updated. */ updated_at?: string | undefined; branding?: Management.SelfServiceProfileBrandingProperties | undefined; /** List of IdP strategies that will be shown to users during the Self-Service SSO flow. Possible values: [`oidc`, `samlp`, `waad`, `google-apps`, `adfs`, `okta`, `auth0-samlp`, `okta-samlp`, `keycloak-samlp`, `pingfederate`] */ allowed_strategies?: Management.SelfServiceProfileAllowedStrategyEnum[] | undefined; /** ID of the user-attribute-profile to associate with this self-service profile. */ user_attribute_profile_id?: string | undefined; } export declare const SelfServiceProfileAllowedStrategyEnum: { readonly Oidc: "oidc"; readonly Samlp: "samlp"; readonly Waad: "waad"; readonly GoogleApps: "google-apps"; readonly Adfs: "adfs"; readonly Okta: "okta"; readonly Auth0Samlp: "auth0-samlp"; readonly OktaSamlp: "okta-samlp"; readonly KeycloakSamlp: "keycloak-samlp"; readonly Pingfederate: "pingfederate"; }; export type SelfServiceProfileAllowedStrategyEnum = (typeof SelfServiceProfileAllowedStrategyEnum)[keyof typeof SelfServiceProfileAllowedStrategyEnum]; export type SelfServiceProfileBranding = (Management.SelfServiceProfileBrandingProperties | null) | undefined; export interface SelfServiceProfileBrandingColors { primary: string; /** Accepts any additional properties */ [key: string]: any; } export interface SelfServiceProfileBrandingProperties { logo_url?: string | undefined; colors?: Management.SelfServiceProfileBrandingColors | undefined; /** Accepts any additional properties */ [key: string]: any; } /** The language of the custom text. */ export declare const SelfServiceProfileCustomTextLanguageEnum: { readonly En: "en"; }; export type SelfServiceProfileCustomTextLanguageEnum = (typeof SelfServiceProfileCustomTextLanguageEnum)[keyof typeof SelfServiceProfileCustomTextLanguageEnum]; /** The page where the custom text is shown. */ export declare const SelfServiceProfileCustomTextPageEnum: { readonly GetStarted: "get-started"; }; export type SelfServiceProfileCustomTextPageEnum = (typeof SelfServiceProfileCustomTextPageEnum)[keyof typeof SelfServiceProfileCustomTextPageEnum]; /** * The description of the self-service Profile. */ export type SelfServiceProfileDescription = (string | null) | undefined; /** * If provided, this will create a new connection for the SSO flow with the given configuration */ export interface SelfServiceProfileSsoTicketConnectionConfig { /** The name of the connection that will be created as a part of the SSO flow. */ name: string; /** Connection name used in the new universal login experience */ display_name?: string | undefined; /** true promotes to a domain-level connection so that third-party applications can use it. false does not promote the connection, so only first-party applications with the connection enabled can use it. (Defaults to false.) */ is_domain_connection?: boolean | undefined; /** Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. (Defaults to false.) */ show_as_button?: boolean | undefined; metadata?: Management.ConnectionsMetadata | undefined; options?: (Management.SelfServiceProfileSsoTicketConnectionOptions | null) | undefined; } /** * The connection's options (depend on the connection strategy) */ export interface SelfServiceProfileSsoTicketConnectionOptions { /** URL for the icon. Must use HTTPS. */ icon_url?: (string | null) | undefined; /** List of domain_aliases that can be authenticated in the Identity Provider */ domain_aliases?: (string[] | null) | undefined; idpinitiated?: (Management.SelfServiceProfileSsoTicketIdpInitiatedOptions | null) | undefined; } /** * Configuration for the setup of the connection’s domain_aliases in the self-service SSO flow. */ export interface SelfServiceProfileSsoTicketDomainAliasesConfig { domain_verification: Management.SelfServiceProfileSsoTicketDomainVerificationEnum; } /** Whether the end user should complete the domain verification step. Possible values are 'none' (the step is not shown to the user), 'optional' (the user may add a domain alias in the domain verification step) or 'required' (the user must add a domain alias in order to enable the connection). Defaults to 'none'. */ export declare const SelfServiceProfileSsoTicketDomainVerificationEnum: { readonly None: "none"; readonly Optional: "optional"; readonly Required: "required"; }; export type SelfServiceProfileSsoTicketDomainVerificationEnum = (typeof SelfServiceProfileSsoTicketDomainVerificationEnum)[keyof typeof SelfServiceProfileSsoTicketDomainVerificationEnum]; export interface SelfServiceProfileSsoTicketEnabledOrganization { /** Organization identifier. */ organization_id: string; /** 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. */ assign_membership_on_login?: boolean | undefined; /** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */ show_as_button?: boolean | undefined; } /** * Configuration for Google Workspace Directory Sync during the self-service flow. */ export interface SelfServiceProfileSsoTicketGoogleWorkspaceConfig { /** Whether to enable Google Workspace Directory Sync for users during the self-service flow. */ sync_users: boolean; } /** The protocol used to connect to the the default application */ export declare const SelfServiceProfileSsoTicketIdpInitiatedClientProtocolEnum: { readonly Samlp: "samlp"; readonly Wsfed: "wsfed"; readonly Oauth2: "oauth2"; }; export type SelfServiceProfileSsoTicketIdpInitiatedClientProtocolEnum = (typeof SelfServiceProfileSsoTicketIdpInitiatedClientProtocolEnum)[keyof typeof SelfServiceProfileSsoTicketIdpInitiatedClientProtocolEnum]; /** * Allows IdP-initiated login */ export interface SelfServiceProfileSsoTicketIdpInitiatedOptions { /** Enables IdP-initiated login for this connection */ enabled?: boolean | undefined; /** Default application client_id user is redirected to after validated SAML response */ client_id?: string | undefined; client_protocol?: Management.SelfServiceProfileSsoTicketIdpInitiatedClientProtocolEnum | undefined; /** Query string options to customize the behaviour for OpenID Connect when idpinitiated.client_protocol is oauth2. Allowed parameters: redirect_uri, scope, response_type. For example, redirect_uri=https://jwt.io&scope=openid email&response_type=token */ client_authorizequery?: string | undefined; } /** * Configuration for the setup of Provisioning in the self-service flow. */ export interface SelfServiceProfileSsoTicketProvisioningConfig { /** The scopes of the SCIM tokens generated during the self-service flow. */ scopes?: Management.SelfServiceProfileSsoTicketProvisioningScopeEnum[] | undefined; google_workspace?: Management.SelfServiceProfileSsoTicketGoogleWorkspaceConfig | undefined; /** Lifetime of the tokens in seconds. Must be greater than 900. If not provided, the tokens don't expire. */ token_lifetime?: (number | null) | undefined; } export declare const SelfServiceProfileSsoTicketProvisioningScopeEnum: { readonly GetUsers: "get:users"; readonly PostUsers: "post:users"; readonly PutUsers: "put:users"; readonly PatchUsers: "patch:users"; readonly DeleteUsers: "delete:users"; readonly GetGroups: "get:groups"; readonly PostGroups: "post:groups"; readonly PutGroups: "put:groups"; readonly PatchGroups: "patch:groups"; readonly DeleteGroups: "delete:groups"; }; export type SelfServiceProfileSsoTicketProvisioningScopeEnum = (typeof SelfServiceProfileSsoTicketProvisioningScopeEnum)[keyof typeof SelfServiceProfileSsoTicketProvisioningScopeEnum]; export interface SelfServiceProfileUserAttribute { /** Identifier of this attribute. */ name: string; /** Description of this attribute. */ description: string; /** Determines if this attribute is required */ is_optional: boolean; } /** * List of attributes to be mapped that will be shown to the user during the SS-SSO flow. */ export type SelfServiceProfileUserAttributes = (Management.SelfServiceProfileUserAttribute[] | null) | undefined; /** * Authentication signal details */ export interface SessionAuthenticationSignal { /** One of: "federated", "passkey", "pwd", "sms", "email", "mfa", "mock" or a custom method denoted by a URL */ name?: string | undefined; timestamp?: Management.SessionDate | undefined; /** A specific MFA factor. Only present when "name" is set to "mfa" */ type?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Details about authentication signals obtained during the login flow */ export interface SessionAuthenticationSignals { /** Contains the authentication methods a user has completed during their session */ methods?: Management.SessionAuthenticationSignal[] | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * Client details */ export interface SessionClientMetadata { /** ID of client for the session */ client_id?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * [Private Early Access] Session cookie configuration. */ export interface SessionCookieMetadata { mode?: Management.SessionCookieMetadataModeEnum | undefined; /** Accepts any additional properties */ [key: string]: any; } /** [Private Early Access] The persistence mode of the session cookie. When set to "non-persistent" (ephemeral), the cookie will be deleted when the browser is closed. When set to "persistent", the cookie will be stored until it expires or is deleted by the user. */ export declare const SessionCookieMetadataModeEnum: { readonly NonPersistent: "non-persistent"; readonly Persistent: "persistent"; }; export type SessionCookieMetadataModeEnum = (typeof SessionCookieMetadataModeEnum)[keyof typeof SessionCookieMetadataModeEnum]; /** Behavior of the session cookie */ export declare const SessionCookieModeEnum: { readonly Persistent: "persistent"; readonly NonPersistent: "non-persistent"; }; export type SessionCookieModeEnum = (typeof SessionCookieModeEnum)[keyof typeof SessionCookieModeEnum]; /** * Session cookie configuration */ export interface SessionCookieSchema { mode: Management.SessionCookieModeEnum; } export type SessionDate = /** * The date and time when the session was created */ string /** * The date and time when the session was created */ | Record; /** * Metadata related to the device used in the session */ export interface SessionDeviceMetadata { /** First user agent of the device from which this user logged in */ initial_user_agent?: string | undefined; initial_ip?: ((Management.SessionIp | undefined) | null) | undefined; /** First autonomous system number associated with this session */ initial_asn?: string | undefined; /** Last user agent of the device from which this user logged in */ last_user_agent?: string | undefined; last_ip?: ((Management.SessionIp | undefined) | null) | undefined; /** Last autonomous system number from which this user logged in */ last_asn?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * First IP address associated with this session */ export type SessionIp = (string | null) | undefined; /** * Metadata associated with the session, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed. */ export type SessionMetadata = (Record | null) | undefined; export interface SessionResponseContent { /** The ID of the session */ id?: string | undefined; /** ID of the user which can be used when interacting with other APIs. */ user_id?: string | undefined; created_at?: Management.SessionDate | undefined; updated_at?: Management.SessionDate | undefined; authenticated_at?: Management.SessionDate | undefined; idle_expires_at?: Management.SessionDate | undefined; expires_at?: Management.SessionDate | undefined; last_interacted_at?: Management.SessionDate | undefined; device?: Management.SessionDeviceMetadata | undefined; /** List of client details for the session */ clients?: Management.SessionClientMetadata[] | undefined; authentication?: Management.SessionAuthenticationSignals | undefined; cookie?: Management.SessionCookieMetadata | undefined; session_metadata?: ((Management.SessionMetadata | undefined) | null) | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * JWKS representing an array of custom public signing keys. */ export interface SetCustomSigningKeysResponseContent { /** An array of custom public signing keys. */ keys?: Management.CustomSigningKeyJwk[] | undefined; } export interface SetEmailTemplateResponseContent { template: Management.EmailTemplateNameEnum; /** Body of the email template. */ body?: (string | null) | undefined; /** Senders `from` email address. */ from?: (string | null) | undefined; /** URL to redirect the user to after a successful action. */ resultUrl?: (string | null) | undefined; /** Subject line of the email. */ subject?: (string | null) | undefined; /** Syntax of the template body. */ syntax?: (string | null) | undefined; /** Lifetime in seconds that the link within the email will be valid for. */ urlLifetimeInSeconds?: (number | null) | undefined; /** Whether the `reset_email` and `verify_email` templates should include the user's email address as the `email` parameter in the returnUrl (true) or whether no email address should be included in the redirect (false). Defaults to true. */ includeEmailInRedirect?: boolean | undefined; /** Whether the template is enabled (true) or disabled (false). */ enabled?: (boolean | null) | undefined; } export interface SetGuardianFactorDuoSettingsResponseContent { ikey?: string | undefined; skey?: string | undefined; host?: string | undefined; } export interface SetGuardianFactorPhoneMessageTypesResponseContent { /** The list of phone factors to enable on the tenant. Can include `sms` and `voice`. */ message_types?: Management.GuardianFactorPhoneFactorMessageTypeEnum[] | undefined; } export interface SetGuardianFactorPhoneTemplatesResponseContent { /** Message sent to the user when they are invited to enroll with a phone number. */ enrollment_message: string; /** Message sent to the user when they are prompted to verify their account. */ verification_message: string; } export interface SetGuardianFactorResponseContent { /** Whether this factor is enabled (true) or disabled (false). */ enabled: boolean; } export interface SetGuardianFactorSmsTemplatesResponseContent { /** Message sent to the user when they are invited to enroll with a phone number. */ enrollment_message: string; /** Message sent to the user when they are prompted to verify their account. */ verification_message: string; } export interface SetGuardianFactorsProviderPhoneResponseContent { provider?: Management.GuardianFactorsProviderSmsProviderEnum | undefined; } export interface SetGuardianFactorsProviderPhoneTwilioResponseContent { /** From number */ from?: (string | null) | undefined; /** Copilot SID */ messaging_service_sid?: (string | null) | undefined; /** Twilio Authentication token */ auth_token?: (string | null) | undefined; /** Twilio SID */ sid?: (string | null) | undefined; } export interface SetGuardianFactorsProviderPushNotificationApnsResponseContent { sandbox?: boolean | undefined; bundle_id?: (string | null) | undefined; } export type SetGuardianFactorsProviderPushNotificationFcmResponseContent = Record; export type SetGuardianFactorsProviderPushNotificationFcmv1ResponseContent = Record; export interface SetGuardianFactorsProviderPushNotificationResponseContent { provider?: Management.GuardianFactorsProviderPushNotificationProviderDataEnum | undefined; } export interface SetGuardianFactorsProviderPushNotificationSnsResponseContent { aws_access_key_id?: (string | null) | undefined; aws_secret_access_key?: (string | null) | undefined; aws_region?: (string | null) | undefined; sns_apns_platform_application_arn?: (string | null) | undefined; sns_gcm_platform_application_arn?: (string | null) | undefined; } export interface SetGuardianFactorsProviderSmsResponseContent { provider?: Management.GuardianFactorsProviderSmsProviderEnum | undefined; } export interface SetGuardianFactorsProviderSmsTwilioResponseContent { /** From number */ from?: (string | null) | undefined; /** Copilot SID */ messaging_service_sid?: (string | null) | undefined; /** Twilio Authentication token */ auth_token?: (string | null) | undefined; /** Twilio SID */ sid?: (string | null) | undefined; } export type SetGuardianPoliciesRequestContent = Management.MfaPolicyEnum[]; export type SetGuardianPoliciesResponseContent = Management.MfaPolicyEnum[]; export interface SetNetworkAclsResponseContent { id?: string | undefined; description?: string | undefined; active?: boolean | undefined; priority?: number | undefined; rule?: Management.NetworkAclRule | undefined; /** The timestamp when the Network ACL Configuration was created */ created_at?: string | undefined; /** The timestamp when the Network ACL Configuration was last updated */ updated_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * An object containing template partials for a group of screens. */ export type SetPartialsRequestContent = Record; export interface SetRulesConfigResponseContent { /** Key for a rules config variable. */ key: string; /** Value for a rules config variable. */ value: string; /** Accepts any additional properties */ [key: string]: any; } /** * The list of text keys and values to customize the self-service SSO page. Values can be plain text or rich HTML content limited to basic styling tags and hyperlinks. */ export type SetSelfServiceProfileCustomTextRequestContent = Record; /** * The resulting list of custom text keys and values. */ export type SetSelfServiceProfileCustomTextResponseContent = Record; /** * The successfully created authentication method. */ export interface SetUserAuthenticationMethodResponseContent { /** The ID of the newly created authentication method (automatically generated by the application) */ id?: string | undefined; type: Management.CreatedAuthenticationMethodTypeEnum; /** A human-readable label to identify the authentication method. */ name?: string | undefined; /** Base32 encoded secret for TOTP generation */ totp_secret?: string | undefined; /** Applies to phone authentication methods only. The destination phone number used to send verification codes via text and voice. */ phone_number?: string | undefined; /** Applies to email authentication methods only. The email address used to send verification messages. */ email?: string | undefined; authentication_methods?: Management.UserAuthenticationMethodProperties[] | undefined; /** Preferred phone authentication method */ preferred_authentication_method?: Management.PreferredAuthenticationMethodEnum | undefined; /** Applies to webauthn authenticators only. The id of the credential. */ key_id?: string | undefined; /** Applies to webauthn authenticators only. The public key. */ public_key?: string | undefined; /** Applies to passkeys only. Authenticator Attestation Globally Unique Identifier. */ aaguid?: string | undefined; /** Applies to webauthn authenticators only. The relying party identifier. */ relying_party_identifier?: string | undefined; /** Authentication method creation date */ created_at?: string | undefined; } export interface SetUserAuthenticationMethods { type: Management.AuthenticationTypeEnum; preferred_authentication_method?: Management.PreferredAuthenticationMethodEnum | undefined; /** AA human-readable label to identify the authentication method. */ name?: string | undefined; /** Applies to phone authentication methods only. The destination phone number used to send verification codes via text and voice. */ phone_number?: string | undefined; /** Applies to email authentication methods only. The email address used to send verification messages. */ email?: string | undefined; /** Applies to totp authentication methods only. The base32 encoded secret for TOTP generation. */ totp_secret?: string | undefined; } export type SetUserAuthenticationMethodsRequestContent = Management.SetUserAuthenticationMethods[]; /** * An object containing custom dictionaries for a group of screens. */ export type SetsCustomTextsByLanguageRequestContent = Record; /** Algorithm used to sign JWTs. Can be `HS256` (default) or `RS256`. `PS256` available via addon. */ export declare const SigningAlgorithmEnum: { readonly Hs256: "HS256"; readonly Rs256: "RS256"; readonly Rs512: "RS512"; readonly Ps256: "PS256"; }; export type SigningAlgorithmEnum = (typeof SigningAlgorithmEnum)[keyof typeof SigningAlgorithmEnum]; export interface SigningKeys { /** The key id of the signing key */ kid: string; /** The public certificate of the signing key */ cert: string; /** The public certificate of the signing key in pkcs7 format */ pkcs7?: string | undefined; /** True if the key is the the current key */ current?: boolean | undefined; /** True if the key is the the next key */ next?: boolean | undefined; /** True if the key is the the previous key */ previous?: boolean | undefined; current_since?: Management.SigningKeysDate | undefined; current_until?: Management.SigningKeysDate | undefined; /** The cert fingerprint */ fingerprint: string; /** The cert thumbprint */ thumbprint: string; /** True if the key is revoked */ revoked?: boolean | undefined; revoked_at?: Management.SigningKeysDate | undefined; } export type SigningKeysDate = /** * The date and time when the key became the current key */ string /** * The date and time when the key became the current key */ | Record; export interface SignupSchema { status?: Management.SignupStatusEnum | undefined; } export declare const SignupStatusEnum: { readonly Required: "required"; readonly Optional: "optional"; readonly Inactive: "inactive"; }; export type SignupStatusEnum = (typeof SignupStatusEnum)[keyof typeof SignupStatusEnum]; export interface SignupVerification { active?: boolean | undefined; } export interface SignupVerified { status?: Management.SignupStatusEnum | undefined; verification?: Management.SignupVerification | undefined; } export declare const SupportedLocales: { readonly Am: "am"; readonly Ar: "ar"; readonly ArEg: "ar-EG"; readonly ArSa: "ar-SA"; readonly Az: "az"; readonly Bg: "bg"; readonly Bn: "bn"; readonly Bs: "bs"; readonly CaEs: "ca-ES"; readonly Cnr: "cnr"; readonly Cs: "cs"; readonly Cy: "cy"; readonly Da: "da"; readonly De: "de"; readonly El: "el"; readonly En: "en"; readonly EnCa: "en-CA"; readonly Es: "es"; readonly Es419: "es-419"; readonly EsAr: "es-AR"; readonly EsMx: "es-MX"; readonly Et: "et"; readonly EuEs: "eu-ES"; readonly Fa: "fa"; readonly Fi: "fi"; readonly Fr: "fr"; readonly FrCa: "fr-CA"; readonly FrFr: "fr-FR"; readonly GlEs: "gl-ES"; readonly Gu: "gu"; readonly He: "he"; readonly Hi: "hi"; readonly Hr: "hr"; readonly Hu: "hu"; readonly Hy: "hy"; readonly Id: "id"; readonly Is: "is"; readonly It: "it"; readonly Ja: "ja"; readonly Ka: "ka"; readonly Kk: "kk"; readonly Kn: "kn"; readonly Ko: "ko"; readonly Lt: "lt"; readonly Lv: "lv"; readonly Mk: "mk"; readonly Ml: "ml"; readonly Mn: "mn"; readonly Mr: "mr"; readonly Ms: "ms"; readonly My: "my"; readonly Nb: "nb"; readonly Nl: "nl"; readonly Nn: "nn"; readonly No: "no"; readonly Pa: "pa"; readonly Pl: "pl"; readonly Pt: "pt"; readonly PtBr: "pt-BR"; readonly PtPt: "pt-PT"; readonly Ro: "ro"; readonly Ru: "ru"; readonly Sk: "sk"; readonly Sl: "sl"; readonly So: "so"; readonly Sq: "sq"; readonly Sr: "sr"; readonly Sv: "sv"; readonly Sw: "sw"; readonly Ta: "ta"; readonly Te: "te"; readonly Th: "th"; readonly Tl: "tl"; readonly Tr: "tr"; readonly Uk: "uk"; readonly Ur: "ur"; readonly Vi: "vi"; readonly Zgh: "zgh"; readonly ZhCn: "zh-CN"; readonly ZhHk: "zh-HK"; readonly ZhMo: "zh-MO"; readonly ZhTw: "zh-TW"; }; export type SupportedLocales = (typeof SupportedLocales)[keyof typeof SupportedLocales]; /** * List of trusted IP addresses that will not have attack protection enforced against them. */ export type SuspiciousIpThrottlingAllowlist = Management.SuspiciousIpThrottlingAllowlistItem[]; export type SuspiciousIpThrottlingAllowlistItem = string; /** * Configuration options that apply before every login attempt. */ export interface SuspiciousIpThrottlingPreLoginStage { /** Total number of attempts allowed per day. */ max_attempts?: number | undefined; /** Interval of time, given in milliseconds, at which new attempts are granted. */ rate?: number | undefined; } /** * Configuration options that apply before every user registration attempt. */ export interface SuspiciousIpThrottlingPreUserRegistrationStage { /** Total number of attempts allowed. */ max_attempts?: number | undefined; /** Interval of time, given in milliseconds, at which new attempts are granted. */ rate?: number | undefined; } export declare const SuspiciousIpThrottlingShieldsEnum: { readonly Block: "block"; readonly AdminNotification: "admin_notification"; }; export type SuspiciousIpThrottlingShieldsEnum = (typeof SuspiciousIpThrottlingShieldsEnum)[keyof typeof SuspiciousIpThrottlingShieldsEnum]; /** * Holds per-stage configuration options (max_attempts and rate). */ export interface SuspiciousIpThrottlingStage { "pre-login"?: Management.SuspiciousIpThrottlingPreLoginStage | undefined; "pre-user-registration"?: Management.SuspiciousIpThrottlingPreUserRegistrationStage | undefined; } /** Group synchronization configuration */ export declare const SynchronizeGroupsEnum: { readonly All: "all"; readonly Off: "off"; readonly Selected: "selected"; }; export type SynchronizeGroupsEnum = (typeof SynchronizeGroupsEnum)[keyof typeof SynchronizeGroupsEnum]; export interface SynchronizedGroupPayload { /** Google Workspace Directory group ID. */ id: string; } /** * Settings related to OIDC RP-initiated Logout */ export interface TenantOidcLogoutSettings { /** Enable the end_session_endpoint URL in the .well-known discovery configuration */ rp_logout_end_session_endpoint_discovery?: boolean | undefined; } /** * Device Flow configuration */ export interface TenantSettingsDeviceFlow { charset?: Management.TenantSettingsDeviceFlowCharset | undefined; /** Mask used to format a generated User Code into a friendly, readable format. */ mask?: string | undefined; } /** Character set used to generate a User Code. Can be `base20` or `digits`. */ export declare const TenantSettingsDeviceFlowCharset: { readonly Base20: "base20"; readonly Digits: "digits"; }; export type TenantSettingsDeviceFlowCharset = (typeof TenantSettingsDeviceFlowCharset)[keyof typeof TenantSettingsDeviceFlowCharset]; /** Sets the `third_party_security_mode` assigned to clients created via Dynamic Client Registration. `strict` applies enhanced security controls. `permissive` preserves pre-existing behavior and is only available to tenants with prior third-party client usage. */ export declare const TenantSettingsDynamicClientRegistrationSecurityMode: { readonly Strict: "strict"; readonly Permissive: "permissive"; }; export type TenantSettingsDynamicClientRegistrationSecurityMode = (typeof TenantSettingsDynamicClientRegistrationSecurityMode)[keyof typeof TenantSettingsDynamicClientRegistrationSecurityMode]; /** * Error page customization. */ export interface TenantSettingsErrorPage { /** Custom Error HTML (Liquid syntax is supported). */ html?: string | undefined; /** Whether to show the link to log as part of the default error page (true, default) or not to show the link (false). */ show_log_link?: boolean | undefined; /** URL to redirect to when an error occurs instead of showing the default error page. */ url?: string | undefined; } /** * Flags used to change the behavior of this tenant. */ export interface TenantSettingsFlags { /** Whether to use the older v1 change password flow (true, not recommended except for backward compatibility) or the newer safer flow (false, recommended). */ change_pwd_flow_v1?: boolean | undefined; /** Whether the APIs section is enabled (true) or disabled (false). */ enable_apis_section?: boolean | undefined; /** Whether the impersonation functionality has been disabled (true) or not (false). Read-only. */ disable_impersonation?: boolean | undefined; /** Whether all current connections should be enabled when a new client (application) is created (true, default) or not (false). */ enable_client_connections?: boolean | undefined; /** Whether advanced API Authorization scenarios are enabled (true) or disabled (false). */ enable_pipeline2?: boolean | undefined; /** If enabled, clients are able to add legacy delegation grants. */ allow_legacy_delegation_grant_types?: boolean | undefined; /** If enabled, clients are able to add legacy RO grants. */ allow_legacy_ro_grant_types?: boolean | undefined; /** Whether the legacy `/tokeninfo` endpoint is enabled for your account (true) or unavailable (false). */ allow_legacy_tokeninfo_endpoint?: boolean | undefined; /** Whether ID tokens and the userinfo endpoint includes a complete user profile (true) or only OpenID Connect claims (false). */ enable_legacy_profile?: boolean | undefined; /** Whether ID tokens can be used to authorize some types of requests to API v2 (true) not not (false). */ enable_idtoken_api2?: boolean | undefined; /** Whether the public sign up process shows a user_exists error (true) or a generic error (false) if the user already exists. */ enable_public_signup_user_exists_error?: boolean | undefined; /** Whether users are prompted to confirm log in before SSO redirection (false) or are not prompted (true). */ enable_sso?: boolean | undefined; /** Whether the `enable_sso` setting can be changed (true) or not (false). */ allow_changing_enable_sso?: boolean | undefined; /** Whether classic Universal Login prompts include additional security headers to prevent clickjacking (true) or no safeguard (false). */ disable_clickjack_protection_headers?: boolean | undefined; /** Do not Publish Enterprise Connections Information with IdP domains on the lock configuration file. */ no_disclose_enterprise_connections?: boolean | undefined; /** Enforce client authentication for passwordless start. */ enforce_client_authentication_on_passwordless_start?: boolean | undefined; /** Enables the email verification flow during login for Azure AD and ADFS connections */ enable_adfs_waad_email_verification?: boolean | undefined; /** Delete underlying grant when a Refresh Token is revoked via the Authentication API. */ revoke_refresh_token_grant?: boolean | undefined; /** Enables beta access to log streaming changes */ dashboard_log_streams_next?: boolean | undefined; /** Enables new insights activity page view */ dashboard_insights_view?: boolean | undefined; /** Disables SAML fields map fix for bad mappings with repeated attributes */ disable_fields_map_fix?: boolean | undefined; /** Used to allow users to pick what factor to enroll of the available MFA factors. */ mfa_show_factor_list_on_enrollment?: boolean | undefined; /** Removes alg property from jwks .well-known endpoint */ remove_alg_from_jwks?: boolean | undefined; /** Improves bot detection during signup in classic universal login */ improved_signup_bot_detection_in_classic?: boolean | undefined; /** This tenant signed up for the Auth4GenAI trail */ genai_trial?: boolean | undefined; /** Whether third-party developers can dynamically register applications for your APIs (true) or not (false). This flag enables dynamic client registration. */ enable_dynamic_client_registration?: boolean | undefined; /** If true, SMS phone numbers will not be obfuscated in Management API GET calls. */ disable_management_api_sms_obfuscation?: boolean | undefined; /** Changes email_verified behavior for Azure AD/ADFS connections when enabled. Sets email_verified to false otherwise. */ trust_azure_adfs_email_verified_connection_property?: boolean | undefined; /** If true, custom domains feature will be enabled for tenant. */ custom_domains_provisioning?: boolean | undefined; } /** * Guardian page customization. */ export interface TenantSettingsGuardianPage { /** Whether to use the custom Guardian HTML (true) or the default Auth0 page (false, default) */ enabled?: boolean | undefined; /** Custom Guardian HTML (Liquid syntax is supported). */ html?: string | undefined; } /** * mTLS configuration. */ export interface TenantSettingsMtls { /** If true, enables mTLS endpoint aliases */ enable_endpoint_aliases?: boolean | undefined; } /** * Change Password page customization. */ export interface TenantSettingsPasswordPage { /** Whether to use the custom change password HTML (true) or the default Auth0 page (false). Default is to use the Auth0 page. */ enabled?: boolean | undefined; /** Custom change password HTML (Liquid syntax supported). */ html?: string | undefined; } /** Profile that determines how the identity of the protected resource (i.e., API) can be specified in the OAuth endpoints when access is being requested. When set to audience (default), the audience parameter is used to specify the resource server. When set to compatibility, the audience parameter is still checked first, but if it not provided, then the resource parameter can be used to specify the resource server. */ export declare const TenantSettingsResourceParameterProfile: { readonly Audience: "audience"; readonly Compatibility: "compatibility"; }; export type TenantSettingsResourceParameterProfile = (typeof TenantSettingsResourceParameterProfile)[keyof typeof TenantSettingsResourceParameterProfile]; /** * Sessions related settings for tenant */ export interface TenantSettingsSessions { /** Whether to bypass prompting logic (false) when performing OIDC Logout */ oidc_logout_prompt_enabled?: boolean | undefined; } export declare const TenantSettingsSupportedLocalesEnum: { readonly Am: "am"; readonly Ar: "ar"; readonly ArEg: "ar-EG"; readonly ArSa: "ar-SA"; readonly Az: "az"; readonly Bg: "bg"; readonly Bn: "bn"; readonly Bs: "bs"; readonly CaEs: "ca-ES"; readonly Cnr: "cnr"; readonly Cs: "cs"; readonly Cy: "cy"; readonly Da: "da"; readonly De: "de"; readonly El: "el"; readonly En: "en"; readonly EnCa: "en-CA"; readonly Es: "es"; readonly Es419: "es-419"; readonly EsAr: "es-AR"; readonly EsMx: "es-MX"; readonly Et: "et"; readonly EuEs: "eu-ES"; readonly Fa: "fa"; readonly Fi: "fi"; readonly Fr: "fr"; readonly FrCa: "fr-CA"; readonly FrFr: "fr-FR"; readonly GlEs: "gl-ES"; readonly Gu: "gu"; readonly He: "he"; readonly Hi: "hi"; readonly Hr: "hr"; readonly Hu: "hu"; readonly Hy: "hy"; readonly Id: "id"; readonly Is: "is"; readonly It: "it"; readonly Ja: "ja"; readonly Ka: "ka"; readonly Kk: "kk"; readonly Kn: "kn"; readonly Ko: "ko"; readonly Lt: "lt"; readonly Lv: "lv"; readonly Mk: "mk"; readonly Ml: "ml"; readonly Mn: "mn"; readonly Mr: "mr"; readonly Ms: "ms"; readonly My: "my"; readonly Nb: "nb"; readonly Nl: "nl"; readonly Nn: "nn"; readonly No: "no"; readonly Pa: "pa"; readonly Pl: "pl"; readonly Pt: "pt"; readonly PtBr: "pt-BR"; readonly PtPt: "pt-PT"; readonly Ro: "ro"; readonly Ru: "ru"; readonly Sk: "sk"; readonly Sl: "sl"; readonly So: "so"; readonly Sq: "sq"; readonly Sr: "sr"; readonly Sv: "sv"; readonly Sw: "sw"; readonly Ta: "ta"; readonly Te: "te"; readonly Th: "th"; readonly Tl: "tl"; readonly Tr: "tr"; readonly Uk: "uk"; readonly Ur: "ur"; readonly Vi: "vi"; readonly Zgh: "zgh"; readonly ZhCn: "zh-CN"; readonly ZhHk: "zh-HK"; readonly ZhMo: "zh-MO"; readonly ZhTw: "zh-TW"; }; export type TenantSettingsSupportedLocalesEnum = (typeof TenantSettingsSupportedLocalesEnum)[keyof typeof TenantSettingsSupportedLocalesEnum]; /** * The payload for the action. */ export type TestActionPayload = Record; export interface TestActionResponseContent { payload?: Management.TestActionResultPayload | undefined; } /** * The resulting payload after an action was executed. */ export type TestActionResultPayload = Record; export interface TestCustomDomainResponseContent { /** Result of the operation. */ success: boolean; /** Message describing the operation status. */ message?: string | undefined; } /** * The raw payload of the test event. */ export type TestEventDataContent = Record; export interface TokenExchangeProfileResponseContent { /** The unique ID of the token exchange profile. */ id?: string | undefined; /** Friendly name of this profile. */ name?: string | undefined; /** Subject token type for this profile. When receiving a token exchange request on the Authentication API, the corresponding token exchange profile with a matching subject_token_type will be executed. This must be a URI. */ subject_token_type?: string | undefined; /** The ID of the Custom Token Exchange action to execute for this profile, in order to validate the subject_token. The action must use the custom-token-exchange trigger. */ action_id?: string | undefined; type?: Management.TokenExchangeProfileTypeEnum | undefined; /** The time when this profile was created. */ created_at?: string | undefined; /** The time when this profile was updated. */ updated_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** The type of the profile, which controls how the profile will be executed when receiving a token exchange request. */ export declare const TokenExchangeProfileTypeEnum: { readonly CustomAuthentication: "custom_authentication"; }; export type TokenExchangeProfileTypeEnum = (typeof TokenExchangeProfileTypeEnum)[keyof typeof TokenExchangeProfileTypeEnum]; export interface TokenQuota { client_credentials: Management.TokenQuotaClientCredentials; } /** * The token quota configuration */ export interface TokenQuotaClientCredentials { /** 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 | undefined; /** Maximum number of issued tokens per day */ per_day?: number | undefined; /** Maximum number of issued tokens per hour */ per_hour?: number | undefined; } export interface TokenQuotaConfiguration { client_credentials: Management.TokenQuotaClientCredentials; /** Accepts any additional properties */ [key: string]: any; } export interface TwilioProviderConfiguration { default_from?: string | undefined; mssid?: string | undefined; sid: string; delivery_methods: Management.TwilioProviderDeliveryMethodEnum[]; } export interface TwilioProviderCredentials { auth_token: string; } export declare const TwilioProviderDeliveryMethodEnum: { readonly Text: "text"; readonly Voice: "voice"; }; export type TwilioProviderDeliveryMethodEnum = (typeof TwilioProviderDeliveryMethodEnum)[keyof typeof TwilioProviderDeliveryMethodEnum]; /** Which login experience to use. Can be `new` or `classic`. */ export declare const UniversalLoginExperienceEnum: { readonly New: "new"; readonly Classic: "classic"; }; export type UniversalLoginExperienceEnum = (typeof UniversalLoginExperienceEnum)[keyof typeof UniversalLoginExperienceEnum]; export interface UpdateActionBindingsResponseContent { bindings?: Management.ActionBinding[] | undefined; } export interface UpdateActionModuleResponseContent { /** The unique ID of the module. */ id?: string | undefined; /** The name of the module. */ name?: string | undefined; /** The source code from the module's draft version. */ code?: string | undefined; /** The npm dependencies from the module's draft version. */ dependencies?: Management.ActionModuleDependency[] | undefined; /** The secrets from the module's draft version (names and timestamps only, values never returned). */ secrets?: Management.ActionModuleSecret[] | undefined; /** The number of deployed actions using this module. */ actions_using_module_total?: number | undefined; /** Whether all draft changes have been published as a version. */ all_changes_published?: boolean | undefined; /** The version number of the latest published version. Omitted if no versions have been published. */ latest_version_number?: number | undefined; /** Timestamp when the module was created. */ created_at?: string | undefined; /** Timestamp when the module was last updated. */ updated_at?: string | undefined; latest_version?: Management.ActionModuleVersionReference | undefined; } export interface UpdateActionResponseContent { /** The unique ID of the action. */ id?: string | undefined; /** The name of an action. */ name?: string | undefined; /** The list of triggers that this action supports. At this time, an action can only target a single trigger at a time. */ supported_triggers?: Management.ActionTrigger[] | undefined; /** True if all of an Action's contents have been deployed. */ all_changes_deployed?: boolean | undefined; /** The time when this action was created. */ created_at?: string | undefined; /** The time when this action was updated. */ updated_at?: string | undefined; /** The source code of the action. */ code?: string | undefined; /** The list of third party npm modules, and their versions, that this action depends on. */ dependencies?: Management.ActionVersionDependency[] | undefined; /** The Node runtime. For example: `node22`, defaults to `node22` */ runtime?: string | undefined; /** The list of secrets that are included in an action or a version of an action. */ secrets?: Management.ActionSecretResponse[] | undefined; deployed_version?: Management.ActionDeployedVersion | undefined; /** installed_integration_id is the fk reference to the InstalledIntegration entity. */ installed_integration_id?: string | undefined; integration?: Management.Integration | undefined; status?: Management.ActionBuildStatusEnum | undefined; /** The time when this action was built successfully. */ built_at?: string | undefined; /** True if the action should be deployed after creation. */ deploy?: boolean | undefined; /** The list of action modules and their versions used by this action. */ modules?: Management.ActionModuleReference[] | undefined; } export interface UpdateAculResponseContent { /** Rendering mode */ rendering_mode?: Management.AculRenderingModeEnum | undefined; context_configuration?: ((Management.AculContextConfiguration | undefined) | null) | undefined; /** Override Universal Login default head tags */ default_head_tags_disabled?: (boolean | null) | undefined; /** Use page template with ACUL */ use_page_template?: (boolean | null) | undefined; /** An array of head tags */ head_tags?: (Management.AculHeadTag[] | null) | undefined; filters?: (Management.AculFilters | null) | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface UpdateAttackProtectionCaptchaResponseContent { active_provider_id?: string | undefined; arkose?: Management.AttackProtectionCaptchaArkoseResponseContent | undefined; auth_challenge?: Management.AttackProtectionCaptchaAuthChallengeResponseContent | undefined; hcaptcha?: Management.AttackProtectionCaptchaHcaptchaResponseContent | undefined; friendly_captcha?: Management.AttackProtectionCaptchaFriendlyCaptchaResponseContent | undefined; recaptcha_enterprise?: Management.AttackProtectionCaptchaRecaptchaEnterpriseResponseContent | undefined; recaptcha_v2?: Management.AttackProtectionCaptchaRecaptchaV2ResponseContent | undefined; simple_captcha?: Management.AttackProtectionCaptchaSimpleCaptchaResponseContent | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface UpdateBotDetectionSettingsResponseContent { bot_detection_level?: Management.BotDetectionLevelEnum | undefined; challenge_password_policy?: Management.BotDetectionChallengePolicyPasswordFlowEnum | undefined; challenge_passwordless_policy?: Management.BotDetectionChallengePolicyPasswordlessFlowEnum | undefined; challenge_password_reset_policy?: Management.BotDetectionChallengePolicyPasswordResetFlowEnum | undefined; allowlist?: Management.BotDetectionAllowlist | undefined; monitoring_mode_enabled?: Management.BotDetectionMonitoringModeEnabled | undefined; } /** * Custom color settings. */ export interface UpdateBrandingColors { /** Accent color. */ primary?: (string | null) | undefined; page_background?: Management.UpdateBrandingPageBackground | undefined; } /** * Custom font settings. */ export interface UpdateBrandingFont { /** URL for the custom font. The URL must point to a font file and not a stylesheet. Must use HTTPS. */ url?: (string | null) | undefined; } /** * Page Background Color or Gradient. * Property contains either null to unset, a solid color as a string value #FFFFFF, or a gradient as an object. * * 

 * {
 *   type: 'linear-gradient',
 *   start: '#FFFFFF',
 *   end: '#000000',
 *   angle_deg: 35
 * }
 *
*/ export type UpdateBrandingPageBackground = (string | null) | undefined | (Record | null) | undefined; /** * Phone provider configuration schema */ export interface UpdateBrandingPhoneProviderResponseContent { id?: string | undefined; /** The name of the tenant */ tenant?: string | undefined; name: Management.PhoneProviderNameEnum; channel?: Management.PhoneProviderChannelEnum | undefined; /** Whether the provider is enabled (false) or disabled (true). */ disabled?: boolean | undefined; configuration?: Management.PhoneProviderConfiguration | undefined; /** The provider's creation date and time in ISO 8601 format */ created_at?: string | undefined; /** The date and time of the last update to the provider in ISO 8601 format */ updated_at?: string | undefined; } export interface UpdateBrandingResponseContent { colors?: Management.BrandingColors | undefined; /** URL for the favicon. Must use HTTPS. */ favicon_url?: string | undefined; /** URL for the logo. Must use HTTPS. */ logo_url?: string | undefined; font?: Management.BrandingFont | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface UpdateBrandingThemeResponseContent { borders: Management.BrandingThemeBorders; colors: Management.BrandingThemeColors; /** Display Name */ displayName: string; fonts: Management.BrandingThemeFonts; page_background: Management.BrandingThemePageBackground; /** Theme Id */ themeId: string; widget: Management.BrandingThemeWidget; } export interface UpdateBreachedPasswordDetectionSettingsResponseContent { /** Whether or not breached password detection is active. */ enabled?: boolean | undefined; /** * Action to take when a breached password is detected during a login. * Possible values: block, user_notification, admin_notification. */ shields?: Management.BreachedPasswordDetectionShieldsEnum[] | undefined; /** * When "admin_notification" is enabled, determines how often email notifications are sent. * Possible values: immediately, daily, weekly, monthly. */ admin_notification_frequency?: Management.BreachedPasswordDetectionAdminNotificationFrequencyEnum[] | undefined; method?: Management.BreachedPasswordDetectionMethodEnum | undefined; stage?: Management.BreachedPasswordDetectionStage | undefined; } export interface UpdateBruteForceSettingsResponseContent { /** Whether or not brute force attack protections are active. */ enabled?: boolean | undefined; /** * Action to take when a brute force protection threshold is violated. * Possible values: block, user_notification. */ shields?: Management.BruteForceProtectionShieldsEnum[] | undefined; /** List of trusted IP addresses that will not have attack protection enforced against them. */ allowlist?: string[] | undefined; mode?: Management.BruteForceProtectionModeEnum | undefined; /** Maximum number of unsuccessful attempts. */ max_attempts?: number | undefined; } export interface UpdateClientGrantResponseContent { /** ID of the client grant. */ id?: string | undefined; /** ID of the client. */ client_id?: string | undefined; /** The audience (API identifier) of this client grant. */ audience?: string | undefined; /** Scopes allowed for this client grant. */ scope?: string[] | undefined; organization_usage?: Management.ClientGrantOrganizationUsageEnum | undefined; /** If enabled, any organization can be used with this grant. If disabled (default), the grant must be explicitly assigned to the desired organizations. */ allow_any_organization?: boolean | undefined; /** Applies this client grant as the default for all clients in the specified group. The only accepted value is `third_party_clients`, which applies the grant to all third-party clients. Per-client grants for the same audience take precedence. Mutually exclusive with `client_id`. */ default_for?: Management.ClientGrantDefaultForEnum | undefined; /** If enabled, this grant is a special grant created by Auth0. It cannot be modified or deleted directly. */ is_system?: boolean | undefined; subject_type?: Management.ClientGrantSubjectTypeEnum | undefined; /** Types of authorization_details allowed for this client grant. */ authorization_details_types?: string[] | undefined; /** If enabled, all scopes configured on the resource server are allowed for this grant. */ allow_all_scopes?: boolean | undefined; } export interface UpdateClientResponseContent { /** ID of this client. */ client_id?: string | undefined; /** Name of the tenant this client belongs to. */ tenant?: string | undefined; /** Name of this client (min length: 1 character, does not allow `<` or `>`). */ name?: string | undefined; /** Free text description of this client (max length: 140 characters). */ description?: string | undefined; /** Whether this is your global 'All Applications' client representing legacy tenant settings (true) or a regular client (false). */ global?: boolean | undefined; /** Client secret (which you must not make public). */ client_secret?: string | undefined; app_type?: Management.ClientAppTypeEnum | undefined; /** URL of the logo to display for this client. Recommended size is 150x150 pixels. */ logo_uri?: string | undefined; /** Whether this client a first party client (true) or not (false). */ is_first_party?: boolean | undefined; /** Whether this client conforms to strict OIDC specifications (true) or uses legacy features (false). */ oidc_conformant?: boolean | undefined; /** Comma-separated list of URLs whitelisted for Auth0 to use as a callback to the client after authentication. */ callbacks?: string[] | undefined; /** Comma-separated list of URLs allowed to make requests from JavaScript to Auth0 API (typically used with CORS). By default, all your callback URLs will be allowed. This field allows you to enter other origins if necessary. You can also use wildcards at the subdomain level (e.g., https://*.contoso.com). Query strings and hash information are not taken into account when validating these URLs. */ allowed_origins?: string[] | undefined; /** Comma-separated list of allowed origins for use with Cross-Origin Authentication, Device Flow, and web message response mode. */ web_origins?: string[] | undefined; /** List of audiences/realms for SAML protocol. Used by the wsfed addon. */ client_aliases?: string[] | undefined; /** List of allow clients and API ids that are allowed to make delegation requests. Empty means all all your clients are allowed. */ allowed_clients?: string[] | undefined; /** Comma-separated list of URLs that are valid to redirect to after logout from Auth0. Wildcards are allowed for subdomains. */ allowed_logout_urls?: string[] | undefined; session_transfer?: (Management.ClientSessionTransferConfiguration | null) | undefined; oidc_logout?: Management.ClientOidcBackchannelLogoutSettings | undefined; /** List of grant types supported for this application. Can include `authorization_code`, `implicit`, `refresh_token`, `client_credentials`, `password`, `http://auth0.com/oauth/grant-type/password-realm`, `http://auth0.com/oauth/grant-type/mfa-oob`, `http://auth0.com/oauth/grant-type/mfa-otp`, `http://auth0.com/oauth/grant-type/mfa-recovery-code`, `urn:openid:params:grant-type:ciba`, `urn:ietf:params:oauth:grant-type:device_code`, and `urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token`. */ grant_types?: string[] | undefined; jwt_configuration?: Management.ClientJwtConfiguration | undefined; signing_keys?: ((Management.ClientSigningKeys | undefined) | null) | undefined; encryption_key?: (Management.ClientEncryptionKey | null) | undefined; /** Applies only to SSO clients and determines whether Auth0 will handle Single Sign On (true) or whether the Identity Provider will (false). */ sso?: boolean | undefined; /** Whether Single Sign On is disabled (true) or enabled (true). Defaults to true. */ sso_disabled?: boolean | undefined; /** Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false). */ cross_origin_authentication?: boolean | undefined; /** URL of the location in your site where the cross origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page. */ cross_origin_loc?: string | undefined; /** Whether a custom login page is to be used (true) or the default provided login page (false). */ custom_login_page_on?: boolean | undefined; /** The content (HTML, CSS, JS) of the custom login page. */ custom_login_page?: string | undefined; /** The content (HTML, CSS, JS) of the custom login page. (Used on Previews) */ custom_login_page_preview?: string | undefined; /** HTML form template to be used for WS-Federation. */ form_template?: string | undefined; addons?: Management.ClientAddons | undefined; token_endpoint_auth_method?: Management.ClientTokenEndpointAuthMethodEnum | undefined; /** If true, trust that the IP specified in the `auth0-forwarded-for` header is the end-user's IP for brute-force-protection on token endpoint. */ is_token_endpoint_ip_header_trusted?: boolean | undefined; client_metadata?: Management.ClientMetadata | undefined; mobile?: Management.ClientMobile | undefined; /** Initiate login uri, must be https */ initiate_login_uri?: string | undefined; refresh_token?: (Management.ClientRefreshTokenConfiguration | null) | undefined; default_organization?: (Management.ClientDefaultOrganization | null) | undefined; organization_usage?: Management.ClientOrganizationUsageEnum | undefined; organization_require_behavior?: Management.ClientOrganizationRequireBehaviorEnum | undefined; /** Defines the available methods for organization discovery during the `pre_login_prompt`. Users can discover their organization either by `email`, `organization_name` or both. */ organization_discovery_methods?: Management.ClientOrganizationDiscoveryEnum[] | undefined; client_authentication_methods?: (Management.ClientAuthenticationMethod | null) | undefined; /** Makes the use of Pushed Authorization Requests mandatory for this client */ require_pushed_authorization_requests?: boolean | undefined; /** Makes the use of Proof-of-Possession mandatory for this client */ require_proof_of_possession?: boolean | undefined; signed_request_object?: Management.ClientSignedRequestObjectWithCredentialId | undefined; compliance_level?: (Management.ClientComplianceLevelEnum | null) | undefined; /** * Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as `myapp://`, or `localhost`). * If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps. * See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information. */ skip_non_verifiable_callback_uri_confirmation_prompt?: boolean | undefined; token_exchange?: Management.ClientTokenExchangeConfiguration | undefined; /** Specifies how long, in seconds, a Pushed Authorization Request URI remains valid */ par_request_expiry?: (number | null) | undefined; token_quota?: Management.TokenQuota | undefined; express_configuration?: Management.ExpressConfiguration | undefined; my_organization_configuration?: Management.ClientMyOrganizationResponseConfiguration | undefined; third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum | undefined; redirection_policy?: Management.ClientRedirectionPolicyEnum | undefined; /** The identifier of the resource server that this client is linked to. */ resource_server_identifier?: string | undefined; async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPostConfiguration | undefined; external_metadata_type?: Management.ClientExternalMetadataTypeEnum | undefined; external_metadata_created_by?: Management.ClientExternalMetadataCreatedByEnum | undefined; /** An alternate client identifier to be used during authorization flows. Only supports CIMD-based client identifiers. */ external_client_id?: string | undefined; /** URL for the JSON Web Key Set (JWKS) containing the public keys used for private_key_jwt authentication. Only present for CIMD clients using private_key_jwt authentication. */ jwks_uri?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * The connection's options (depend on the connection strategy). To update these options, the `update:connections_options` scope must be present. To verify your changes, also include the `read:connections_options` scope. If this scope is not specified, you will not be able to review the updated object. */ export interface UpdateConnectionOptions { validation?: (Management.ConnectionValidationOptions | null) | undefined; /** An array of user fields that should not be stored in the Auth0 database (https://auth0.com/docs/security/data-security/denylist) */ non_persistent_attrs?: (string[] | null) | undefined; /** Order of precedence for attribute types. If the property is not specified, the default precedence of attributes will be used. */ precedence?: Management.ConnectionIdentifierPrecedenceEnum[] | undefined; attributes?: Management.ConnectionAttributes | undefined; /** Set to true to inject context into custom DB scripts (warning: cannot be disabled once enabled) */ enable_script_context?: boolean | undefined; /** Set to true to use a legacy user store */ enabledDatabaseCustomization?: boolean | undefined; /** Enable this if you have a legacy user store and you want to gradually migrate those users to the Auth0 user store */ import_mode?: boolean | undefined; /** Stores encrypted string only configurations for connections */ configuration?: (Record | null) | undefined; customScripts?: Management.ConnectionCustomScripts | undefined; authentication_methods?: (Management.ConnectionAuthenticationMethods | null) | undefined; passkey_options?: (Management.ConnectionPasskeyOptions | null) | undefined; passwordPolicy?: (Management.ConnectionPasswordPolicyEnum | null) | undefined; password_complexity_options?: (Management.ConnectionPasswordComplexityOptions | null) | undefined; password_history?: (Management.ConnectionPasswordHistoryOptions | null) | undefined; password_no_personal_info?: (Management.ConnectionPasswordNoPersonalInfoOptions | null) | undefined; password_dictionary?: (Management.ConnectionPasswordDictionaryOptions | null) | undefined; api_enable_users?: boolean | undefined; api_enable_groups?: boolean | undefined; basic_profile?: boolean | undefined; ext_admin?: boolean | undefined; ext_is_suspended?: boolean | undefined; ext_agreed_terms?: boolean | undefined; ext_groups?: boolean | undefined; ext_assigned_plans?: boolean | undefined; ext_profile?: boolean | undefined; disable_self_service_change_password?: boolean | undefined; upstream_params?: ((Management.ConnectionUpstreamParams | undefined) | null) | undefined; set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum | undefined; gateway_authentication?: (Management.ConnectionGatewayAuthentication | null) | undefined; federated_connections_access_tokens?: (Management.ConnectionFederatedConnectionsAccessTokens | null) | undefined; password_options?: Management.ConnectionPasswordOptions | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface UpdateConnectionProfileResponseContent { id?: Management.ConnectionProfileId | undefined; name?: Management.ConnectionProfileName | undefined; organization?: Management.ConnectionProfileOrganization | undefined; connection_name_prefix_template?: Management.ConnectionNamePrefixTemplate | undefined; enabled_features?: Management.ConnectionProfileEnabledFeatures | undefined; connection_config?: Management.ConnectionProfileConfig | undefined; strategy_overrides?: Management.ConnectionProfileStrategyOverrides | undefined; } /** * Update a connection with strategy=ad */ export interface UpdateConnectionRequestContentAd extends Management.ConnectionCommon { options?: Management.ConnectionOptionsAd | undefined; } /** * Update a connection with strategy=adfs */ export interface UpdateConnectionRequestContentAdfs extends Management.ConnectionCommon { options?: Management.ConnectionOptionsAdfs | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } /** * Update a connection with strategy=amazon */ export interface UpdateConnectionRequestContentAmazon extends Management.ConnectionCommon { options?: Management.ConnectionOptionsAmazon | undefined; } /** * Update a connection with strategy=apple */ export interface UpdateConnectionRequestContentApple extends Management.ConnectionCommon { options?: Management.ConnectionOptionsApple | undefined; } /** * Update a connection with strategy=auth0 */ export interface UpdateConnectionRequestContentAuth0 extends Management.ConnectionCommon { options?: Management.ConnectionOptionsAuth0 | undefined; realms?: Management.ConnectionRealms | undefined; } /** * Update a connection with strategy=auth0-oidc */ export interface UpdateConnectionRequestContentAuth0Oidc extends Management.ConnectionCommon { options?: Management.ConnectionOptionsAuth0Oidc | undefined; } /** * Update a connection with strategy=waad */ export interface UpdateConnectionRequestContentAzureAd extends Management.ConnectionCommon { options?: Management.ConnectionOptionsAzureAd | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } /** * Update a connection with strategy=baidu */ export interface UpdateConnectionRequestContentBaidu extends Management.ConnectionCommon { options?: Management.ConnectionOptionsBaidu | undefined; } /** * Update a connection with strategy=bitbucket */ export interface UpdateConnectionRequestContentBitbucket extends Management.ConnectionCommon { options?: Management.ConnectionOptionsBitbucket | undefined; } /** * Update a connection with strategy=bitly */ export interface UpdateConnectionRequestContentBitly extends Management.ConnectionCommon { options?: Management.ConnectionOptionsBitly | undefined; } /** * Update a connection with strategy=box */ export interface UpdateConnectionRequestContentBox extends Management.ConnectionCommon, Management.ConnectionPurposes { options?: Management.ConnectionOptionsBox | undefined; } /** * Update a connection with strategy=custom */ export interface UpdateConnectionRequestContentCustom extends Management.ConnectionCommon { options?: Management.ConnectionOptionsCustom | undefined; } /** * Update a connection with strategy=daccount */ export interface UpdateConnectionRequestContentDaccount extends Management.ConnectionCommon { options?: Management.ConnectionOptionsDaccount | undefined; } /** * Update a connection with strategy=dropbox */ export interface UpdateConnectionRequestContentDropbox extends Management.ConnectionCommon { options?: Management.ConnectionOptionsDropbox | undefined; } /** * Update a connection with strategy=dwolla */ export interface UpdateConnectionRequestContentDwolla extends Management.ConnectionCommon { options?: Management.ConnectionOptionsDwolla | undefined; } /** * Update a connection with strategy=email */ export interface UpdateConnectionRequestContentEmail extends Management.ConnectionCommon { options?: Management.ConnectionOptionsEmail | undefined; } /** * Update a connection with strategy=evernote */ export interface UpdateConnectionRequestContentEvernote extends Management.ConnectionCommon { options?: Management.ConnectionOptionsEvernote | undefined; } /** * Update a connection with strategy=evernote-sandbox */ export interface UpdateConnectionRequestContentEvernoteSandbox extends Management.ConnectionCommon { options?: Management.ConnectionOptionsEvernote | undefined; } /** * Update a connection with strategy=exact */ export interface UpdateConnectionRequestContentExact extends Management.ConnectionCommon { options?: Management.ConnectionOptionsExact | undefined; } /** * Update a connection with strategy=facebook */ export interface UpdateConnectionRequestContentFacebook extends Management.ConnectionCommon { options?: Management.ConnectionOptionsFacebook | undefined; } /** * Update a connection with strategy=fitbit */ export interface UpdateConnectionRequestContentFitbit extends Management.ConnectionCommon { options?: Management.ConnectionOptionsFitbit | undefined; } /** * Update a connection with strategy=github */ export interface UpdateConnectionRequestContentGitHub extends Management.ConnectionCommon, Management.ConnectionPurposes { options?: Management.ConnectionOptionsGitHub | undefined; } /** * Update a connection with strategy=google-apps */ export interface UpdateConnectionRequestContentGoogleApps extends Management.ConnectionCommon { options?: Management.ConnectionOptionsGoogleApps | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } /** * Update a connection with strategy=google-oauth2 */ export interface UpdateConnectionRequestContentGoogleOAuth2 extends Management.ConnectionCommon, Management.ConnectionPurposes { options?: Management.ConnectionOptionsGoogleOAuth2 | undefined; } /** * Update a connection with strategy=ip */ export interface UpdateConnectionRequestContentIp extends Management.ConnectionCommon { options?: Management.ConnectionOptionsIp | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } /** * Update a connection with strategy=instagram */ export interface UpdateConnectionRequestContentInstagram extends Management.ConnectionCommon { options?: Management.ConnectionOptionsInstagram | undefined; } /** * Update a connection with strategy=line */ export interface UpdateConnectionRequestContentLine extends Management.ConnectionCommon { options?: Management.ConnectionOptionsLine | undefined; } /** * Update a connection with strategy=linkedin */ export interface UpdateConnectionRequestContentLinkedin extends Management.ConnectionCommon { options?: Management.ConnectionOptionsLinkedin | undefined; } /** * Update a connection with strategy=oauth1 */ export interface UpdateConnectionRequestContentOAuth1 extends Management.ConnectionCommon { options?: Management.ConnectionOptionsOAuth1 | undefined; } /** * Update a connection with strategy=oauth2 */ export interface UpdateConnectionRequestContentOAuth2 extends Management.ConnectionCommon, Management.ConnectionPurposes { options?: Management.ConnectionOptionsOAuth2 | undefined; } /** * Update a connection with strategy=oidc */ export interface UpdateConnectionRequestContentOidc extends Management.ConnectionCommon { options?: Management.ConnectionOptionsOidc | undefined; authentication?: Management.ConnectionAuthenticationPurpose | undefined; connected_accounts?: Management.ConnectionConnectedAccountsPurposeXaa | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } /** * Update a connection with strategy=office365 */ export interface UpdateConnectionRequestContentOffice365 extends Management.ConnectionCommon { options?: Management.ConnectionOptionsOffice365 | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } /** * Update a connection with strategy=okta */ export interface UpdateConnectionRequestContentOkta extends Management.ConnectionCommon { options?: Management.ConnectionOptionsOkta | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } /** * Update a connection with strategy=paypal */ export interface UpdateConnectionRequestContentPaypal extends Management.ConnectionCommon { options?: Management.ConnectionOptionsPaypal | undefined; } /** * Update a connection with strategy=paypal-sandbox */ export interface UpdateConnectionRequestContentPaypalSandbox extends Management.ConnectionCommon { options?: Management.ConnectionOptionsPaypal | undefined; } /** * Update a connection with strategy=pingfederate */ export interface UpdateConnectionRequestContentPingFederate extends Management.ConnectionCommon { options?: Management.ConnectionOptionsPingFederate | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } /** * Update a connection with strategy=planningcenter */ export interface UpdateConnectionRequestContentPlanningCenter extends Management.ConnectionCommon { options?: Management.ConnectionOptionsPlanningCenter | undefined; } /** * Update a connection with strategy=samlp */ export interface UpdateConnectionRequestContentSaml extends Management.ConnectionCommon { options?: Management.ConnectionOptionsSaml | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } /** * Update a connection with strategy=sms */ export interface UpdateConnectionRequestContentSms extends Management.ConnectionCommon { options?: Management.ConnectionOptionsSms | undefined; } /** * Update a connection with strategy=salesforce */ export interface UpdateConnectionRequestContentSalesforce extends Management.ConnectionCommon { options?: Management.ConnectionOptionsSalesforce | undefined; } /** * Update a connection with strategy=salesforce-community */ export interface UpdateConnectionRequestContentSalesforceCommunity extends Management.ConnectionCommon { options?: Management.ConnectionOptionsSalesforceCommunity | undefined; } /** * Update a connection with strategy=salesforce-sandbox */ export interface UpdateConnectionRequestContentSalesforceSandbox extends Management.ConnectionCommon { options?: Management.ConnectionOptionsSalesforce | undefined; } /** * Update a connection with strategy=sharepoint */ export interface UpdateConnectionRequestContentSharepoint extends Management.ConnectionCommon { options?: Management.ConnectionOptionsSharepoint | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } /** * Update a connection with strategy=shop */ export interface UpdateConnectionRequestContentShop extends Management.ConnectionCommon { options?: Management.ConnectionOptionsShop | undefined; } /** * Update a connection with strategy=shopify */ export interface UpdateConnectionRequestContentShopify extends Management.ConnectionCommon { options?: Management.ConnectionOptionsShopify | undefined; } /** * Update a connection with strategy=soundcloud */ export interface UpdateConnectionRequestContentSoundcloud extends Management.ConnectionCommon { options?: Management.ConnectionOptionsSoundcloud | undefined; } /** * Update a connection with strategy=thirtysevensignals */ export interface UpdateConnectionRequestContentThirtySevenSignals extends Management.ConnectionCommon { options?: Management.ConnectionOptionsThirtySevenSignals | undefined; } /** * Update a connection with strategy=twitter */ export interface UpdateConnectionRequestContentTwitter extends Management.ConnectionCommon { options?: Management.ConnectionOptionsTwitter | undefined; } /** * Update a connection with strategy=untappd */ export interface UpdateConnectionRequestContentUntappd extends Management.ConnectionCommon { options?: Management.ConnectionOptionsUntappd | undefined; } /** * Update a connection with strategy=vkontakte */ export interface UpdateConnectionRequestContentVkontakte extends Management.ConnectionCommon { options?: Management.ConnectionOptionsVkontakte | undefined; } /** * Update a connection with strategy=weibo */ export interface UpdateConnectionRequestContentWeibo extends Management.ConnectionCommon { options?: Management.ConnectionOptionsWeibo | undefined; } /** * Update a connection with strategy=windowslive */ export interface UpdateConnectionRequestContentWindowsLive extends Management.ConnectionCommon, Management.ConnectionPurposes { options?: Management.ConnectionOptionsWindowsLive | undefined; } /** * Update a connection with strategy=wordpress */ export interface UpdateConnectionRequestContentWordpress extends Management.ConnectionCommon { options?: Management.ConnectionOptionsWordpress | undefined; } /** * Update a connection with strategy=yahoo */ export interface UpdateConnectionRequestContentYahoo extends Management.ConnectionCommon { options?: Management.ConnectionOptionsYahoo | undefined; } /** * Update a connection with strategy=yandex */ export interface UpdateConnectionRequestContentYandex extends Management.ConnectionCommon { options?: Management.ConnectionOptionsYandex | undefined; } export interface UpdateConnectionResponseContent { /** The name of the connection */ name?: string | undefined; /** Connection name used in login screen */ display_name?: string | undefined; options?: Management.ConnectionOptions | undefined; /** The connection's identifier */ id?: string | undefined; /** The type of the connection, related to the identity provider */ strategy?: string | undefined; /** Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm. */ realms?: string[] | undefined; /** DEPRECATED property. Use the GET /connections/:id/clients endpoint to get the ids of the clients for which the connection is enabled */ enabled_clients?: string[] | undefined; /** True if the connection is domain level */ is_domain_connection?: boolean | undefined; /** Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. */ show_as_button?: boolean | undefined; metadata?: Management.ConnectionsMetadata | undefined; authentication?: Management.ConnectionAuthenticationPurpose | undefined; connected_accounts?: Management.ConnectionConnectedAccountsPurpose | undefined; } export interface UpdateCustomDomainResponseContent { /** ID of the custom domain. */ custom_domain_id: string; /** Domain name. */ domain: string; /** Whether this is a primary domain (true) or not (false). */ primary: boolean; /** Whether this is the default custom domain (true) or not (false). */ is_default?: boolean | undefined; status: Management.CustomDomainStatusFilterEnum; type: Management.CustomDomainTypeEnum; verification: Management.DomainVerification; /** The HTTP header to fetch the client's IP address */ custom_client_ip_header?: (string | null) | undefined; /** The TLS version policy */ tls_policy?: string | undefined; domain_metadata?: Management.DomainMetadata | undefined; certificate?: Management.DomainCertificate | undefined; /** Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not present, the full domain will be used. */ relying_party_identifier?: string | undefined; } export interface UpdateDefaultCanonicalDomainResponseContent { /** Domain name. */ domain: string; } export interface UpdateDefaultCustomDomainResponseContent { /** ID of the custom domain. */ custom_domain_id: string; /** Domain name. */ domain: string; /** Whether this is a primary domain (true) or not (false). */ primary: boolean; /** Whether this is the default custom domain (true) or not (false). */ is_default?: boolean | undefined; status: Management.CustomDomainStatusFilterEnum; type: Management.CustomDomainTypeEnum; /** Intermediate address. */ origin_domain_name?: string | undefined; verification?: Management.DomainVerification | undefined; /** The HTTP header to fetch the client's IP address */ custom_client_ip_header?: (string | null) | undefined; /** The TLS version policy */ tls_policy?: string | undefined; domain_metadata?: Management.DomainMetadata | undefined; certificate?: Management.DomainCertificate | undefined; /** Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not present, the full domain will be used. */ relying_party_identifier?: string | undefined; } export type UpdateDefaultDomainResponseContent = Management.UpdateDefaultCustomDomainResponseContent | Management.UpdateDefaultCanonicalDomainResponseContent; export interface UpdateDirectoryProvisioningRequestContent { /** The mapping between Auth0 and IDP user attributes */ mapping?: Management.DirectoryProvisioningMappingItem[] | undefined; /** Whether periodic automatic synchronization is enabled */ synchronize_automatically?: boolean | undefined; synchronize_groups?: Management.SynchronizeGroupsEnum | undefined; } export interface UpdateDirectoryProvisioningResponseContent { /** The connection's identifier */ connection_id: string; /** The connection's name */ connection_name: string; /** The connection's strategy */ strategy: string; /** The mapping between Auth0 and IDP user attributes */ mapping: Management.DirectoryProvisioningMappingItem[]; /** Whether periodic automatic synchronization is enabled */ synchronize_automatically: boolean; synchronize_groups?: Management.SynchronizeGroupsEnum | undefined; /** The timestamp at which the directory provisioning configuration was created */ created_at: string; /** The timestamp at which the directory provisioning configuration was last updated */ updated_at: string; /** The timestamp at which the connection was last synchronized */ last_synchronization_at?: string | undefined; /** The status of the last synchronization */ last_synchronization_status?: string | undefined; /** The error message of the last synchronization, if any */ last_synchronization_error?: string | undefined; } export interface UpdateEmailProviderResponseContent { /** Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, `ms365`, or `custom`. */ name?: string | undefined; /** Whether the provider is enabled (true) or disabled (false). */ enabled?: boolean | undefined; /** Email address to use as "from" when no other address specified. */ default_from_address?: string | undefined; credentials?: Management.EmailProviderCredentials | undefined; settings?: Management.EmailProviderSettings | undefined; } export interface UpdateEmailTemplateResponseContent { template?: Management.EmailTemplateNameEnum | undefined; /** Body of the email template. */ body?: (string | null) | undefined; /** Senders `from` email address. */ from?: (string | null) | undefined; /** URL to redirect the user to after a successful action. */ resultUrl?: (string | null) | undefined; /** Subject line of the email. */ subject?: (string | null) | undefined; /** Syntax of the template body. */ syntax?: (string | null) | undefined; /** Lifetime in seconds that the link within the email will be valid for. */ urlLifetimeInSeconds?: (number | null) | undefined; /** Whether the `reset_email` and `verify_email` templates should include the user's email address as the `email` parameter in the returnUrl (true) or whether no email address should be included in the redirect (false). Defaults to true. */ includeEmailInRedirect?: boolean | undefined; /** Whether the template is enabled (true) or disabled (false). */ enabled?: (boolean | null) | undefined; } export interface UpdateEnabledClientConnectionsRequestContentItem { /** The client_id of the client whose status will be changed. Note that the limit per PATCH request is 50 clients. */ client_id: string; /** Whether the connection is enabled or not for this client_id */ status: boolean; } export type UpdateEnabledClientConnectionsRequestContent = Management.UpdateEnabledClientConnectionsRequestContentItem[]; export type UpdateEventStreamResponseContent = Management.EventStreamWebhookResponseContent | Management.EventStreamEventBridgeResponseContent | Management.EventStreamActionResponseContent; export interface UpdateFlowResponseContent { id: string; name: string; actions?: Management.FlowAction[] | undefined; created_at: string; updated_at: string; executed_at?: string | undefined; } export interface UpdateFlowsVaultConnectionResponseContent { /** Flows Vault Connection identifier. */ id: string; /** Flows Vault Connection app identifier. */ app_id: string; /** Flows Vault Connection environment. */ environment?: string | undefined; /** Flows Vault Connection name. */ name: string; /** Flows Vault Connection custom account name. */ account_name?: string | undefined; /** Whether the Flows Vault Connection is configured. */ ready: boolean; /** The ISO 8601 formatted date when this Flows Vault Connection was created. */ created_at: string; /** The ISO 8601 formatted date when this Flows Vault Connection was updated. */ updated_at: string; /** The ISO 8601 formatted date when this Flows Vault Connection was refreshed. */ refreshed_at?: string | undefined; fingerprint: string; } /** * Flows Vault Connection configuration. */ export type UpdateFlowsVaultConnectionSetup = Management.FlowsVaultConnectioSetupApiKeyWithBaseUrl | Management.FlowsVaultConnectioSetupApiKey | Management.FlowsVaultConnectioSetupOauthApp | Management.FlowsVaultConnectioSetupBigqueryOauthJwt | Management.FlowsVaultConnectioSetupSecretApiKey | Management.FlowsVaultConnectioSetupHttpBearer | Management.FlowsVaultConnectionHttpBasicAuthSetup | Management.FlowsVaultConnectionHttpApiKeySetup | Management.FlowsVaultConnectionHttpOauthClientCredentialsSetup | Management.FlowsVaultConnectioSetupJwt | Management.FlowsVaultConnectioSetupMailjetApiKey | Management.FlowsVaultConnectioSetupToken | Management.FlowsVaultConnectioSetupWebhook | Management.FlowsVaultConnectioSetupStripeKeyPair | Management.FlowsVaultConnectioSetupOauthCode | Management.FlowsVaultConnectioSetupTwilioApiKey; export interface UpdateFormResponseContent { id: string; name: string; messages?: Management.FormMessages | undefined; languages?: Management.FormLanguages | undefined; translations?: Management.FormTranslations | undefined; nodes?: Management.FormNodeList | undefined; start?: Management.FormStartNode | undefined; ending?: Management.FormEndingNode | undefined; style?: Management.FormStyle | undefined; created_at: string; updated_at: string; embedded_at?: string | undefined; submitted_at?: string | undefined; } export interface UpdateGuardianFactorDuoSettingsResponseContent { ikey?: string | undefined; skey?: string | undefined; host?: string | undefined; } export interface UpdateGuardianFactorsProviderPushNotificationApnsResponseContent { sandbox?: boolean | undefined; bundle_id?: (string | null) | undefined; } export type UpdateGuardianFactorsProviderPushNotificationFcmResponseContent = Record; export type UpdateGuardianFactorsProviderPushNotificationFcmv1ResponseContent = Record; export interface UpdateGuardianFactorsProviderPushNotificationSnsResponseContent { aws_access_key_id?: (string | null) | undefined; aws_secret_access_key?: (string | null) | undefined; aws_region?: (string | null) | undefined; sns_apns_platform_application_arn?: (string | null) | undefined; sns_gcm_platform_application_arn?: (string | null) | undefined; } export interface UpdateHookResponseContent { /** Trigger ID */ triggerId?: string | undefined; /** ID of this hook. */ id?: string | undefined; /** Name of this hook. */ name?: string | undefined; /** Whether this hook will be executed (true) or ignored (false). */ enabled?: boolean | undefined; /** Code to be executed when this hook runs. */ script?: string | undefined; dependencies?: Management.HookDependencies | undefined; } /** * Hashmap of key-value pairs where the value must be a string. */ export type UpdateHookSecretRequestContent = Record; export type UpdateLogStreamResponseContent = Management.LogStreamHttpResponseSchema | Management.LogStreamEventBridgeResponseSchema | Management.LogStreamEventGridResponseSchema | Management.LogStreamDatadogResponseSchema | Management.LogStreamSplunkResponseSchema | Management.LogStreamSumoResponseSchema | Management.LogStreamSegmentResponseSchema | Management.LogStreamMixpanelResponseSchema; export interface UpdateNetworkAclResponseContent { id?: string | undefined; description?: string | undefined; active?: boolean | undefined; priority?: number | undefined; rule?: Management.NetworkAclRule | undefined; /** The timestamp when the Network ACL Configuration was created */ created_at?: string | undefined; /** The timestamp when the Network ACL Configuration was last updated */ updated_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface UpdateOrganizationAllConnectionResponseContent { /** Name of the connection in the scope of this organization. */ organization_connection_name?: string | undefined; /** 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. */ assign_membership_on_login?: boolean | undefined; /** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */ show_as_button?: boolean | undefined; /** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */ is_signup_enabled?: boolean | undefined; organization_access_level?: Management.OrganizationAccessLevelEnum | undefined; /** Whether the connection is enabled for the organization. */ is_enabled?: boolean | undefined; /** Connection identifier. */ connection_id: string; connection?: Management.OrganizationConnectionInformation | undefined; } export interface UpdateOrganizationConnectionResponseContent { /** ID of the connection. */ connection_id?: string | undefined; /** 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. */ assign_membership_on_login?: boolean | undefined; /** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */ show_as_button?: boolean | undefined; /** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */ is_signup_enabled?: boolean | undefined; connection?: Management.OrganizationConnectionInformation | undefined; } export interface UpdateOrganizationDiscoveryDomainResponseContent { /** Organization discovery domain identifier. */ id: string; /** The domain name to associate with the organization e.g. acme.com. */ domain: string; status: Management.OrganizationDiscoveryDomainStatus; /** Indicates whether this domain should be used for organization discovery. */ use_for_organization_discovery?: boolean | undefined; /** A unique token generated for the discovery domain. This must be placed in a DNS TXT record at the location specified by the verification_host field to prove domain ownership. */ verification_txt: string; /** The full domain where the TXT record should be added. */ verification_host: string; } export interface UpdateOrganizationResponseContent { /** Organization identifier. */ id?: string | undefined; /** The name of this organization. */ name?: string | undefined; /** Friendly name of this organization. */ display_name?: string | undefined; branding?: Management.OrganizationBranding | undefined; metadata?: Management.OrganizationMetadata | undefined; token_quota?: Management.TokenQuota | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface UpdatePhoneTemplateResponseContent { id: string; channel?: string | undefined; customizable?: boolean | undefined; tenant?: string | undefined; content: Management.PhoneTemplateContent; type: Management.PhoneTemplateNotificationTypeEnum; /** Whether the template is enabled (false) or disabled (true). */ disabled: boolean; } export interface UpdateRefreshTokenResponseContent { /** The ID of the refresh token */ id?: string | undefined; /** ID of the user which can be used when interacting with other APIs. */ user_id?: string | undefined; created_at?: Management.RefreshTokenDate | undefined; idle_expires_at?: Management.RefreshTokenDate | undefined; expires_at?: Management.RefreshTokenDate | undefined; device?: Management.RefreshTokenDevice | undefined; /** ID of the client application granted with this refresh token */ client_id?: string | undefined; session_id?: ((Management.RefreshTokenSessionId | undefined) | null) | undefined; /** True if the token is a rotating refresh token */ rotating?: boolean | undefined; /** A list of the resource server IDs associated to this refresh-token and their granted scopes */ resource_servers?: Management.RefreshTokenResourceServer[] | undefined; refresh_token_metadata?: ((Management.RefreshTokenMetadata | undefined) | null) | undefined; last_exchanged_at?: Management.RefreshTokenDate | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface UpdateResourceServerResponseContent { /** ID of the API (resource server). */ id?: string | undefined; /** Friendly name for this resource server. Can not contain `<` or `>` characters. */ name?: string | undefined; /** Whether this is an Auth0 system API (true) or a custom API (false). */ is_system?: boolean | undefined; /** Unique identifier for the API used as the audience parameter on authorization calls. Can not be changed once set. */ identifier?: string | undefined; /** List of permissions (scopes) that this API uses. */ scopes?: Management.ResourceServerScope[] | undefined; signing_alg?: Management.SigningAlgorithmEnum | undefined; /** Secret used to sign tokens when using symmetric algorithms (HS256). */ signing_secret?: string | undefined; /** Whether refresh tokens can be issued for this API (true) or not (false). */ allow_offline_access?: boolean | undefined; /** Whether Online Refresh Tokens can be issued for this API (true) or not (false). */ allow_online_access?: boolean | undefined; /** Whether to skip user consent for applications flagged as first party (true) or not (false). */ skip_consent_for_verifiable_first_party_clients?: boolean | undefined; /** Expiration value (in seconds) for access tokens issued for this API from the token endpoint. */ token_lifetime?: number | undefined; /** Expiration value (in seconds) for access tokens issued for this API via Implicit or Hybrid Flows. Cannot be greater than the `token_lifetime` value. */ token_lifetime_for_web?: number | undefined; /** Whether authorization polices are enforced (true) or unenforced (false). */ enforce_policies?: boolean | undefined; token_dialect?: Management.ResourceServerTokenDialectResponseEnum | undefined; token_encryption?: (Management.ResourceServerTokenEncryption | null) | undefined; consent_policy?: (Management.ResourceServerConsentPolicyEnum | null) | undefined; authorization_details?: (unknown[] | null) | undefined; proof_of_possession?: (Management.ResourceServerProofOfPossession | null) | undefined; subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization | undefined; /** The client ID of the client that this resource server is linked to */ client_id?: string | undefined; } export interface UpdateRiskAssessmentsSettingsNewDeviceResponseContent { /** Length of time to remember devices for, in days. */ remember_for: number; } export interface UpdateRiskAssessmentsSettingsResponseContent { /** Whether or not risk assessment is enabled. */ enabled: boolean; } export interface UpdateRoleResponseContent { /** ID for this role. */ id?: string | undefined; /** Name of this role. */ name?: string | undefined; /** Description of this role. */ description?: string | undefined; } export interface UpdateRuleResponseContent { /** Name of this rule. */ name?: string | undefined; /** ID of this rule. */ id?: string | undefined; /** Whether the rule is enabled (true), or disabled (false). */ enabled?: boolean | undefined; /** Code to be executed when this rule runs. */ script?: string | undefined; /** Order that this rule should execute in relative to other rules. Lower-valued rules execute first. */ order?: number | undefined; /** Execution stage of this rule. Can be `login_success`, `login_failure`, or `pre_authorize`. */ stage?: string | undefined; } export interface UpdateScimConfigurationResponseContent { /** The connection's identifier */ connection_id: string; /** The connection's name */ connection_name: string; /** The connection's strategy */ strategy: string; /** The tenant's name */ tenant_name: string; /** User ID attribute for generating unique user ids */ user_id_attribute: string; /** The mapping between auth0 and SCIM */ mapping: Management.ScimMappingItem[]; /** The ISO 8601 date and time the SCIM configuration was created at */ created_at: string; /** The ISO 8601 date and time the SCIM configuration was last updated on */ updated_on: string; } export interface UpdateSelfServiceProfileResponseContent { /** The unique ID of the self-service Profile. */ id?: string | undefined; /** The name of the self-service Profile. */ name?: string | undefined; /** The description of the self-service Profile. */ description?: string | undefined; /** List of attributes to be mapped that will be shown to the user during the SS-SSO flow. */ user_attributes?: Management.SelfServiceProfileUserAttribute[] | undefined; /** The time when this self-service Profile was created. */ created_at?: string | undefined; /** The time when this self-service Profile was updated. */ updated_at?: string | undefined; branding?: Management.SelfServiceProfileBrandingProperties | undefined; /** List of IdP strategies that will be shown to users during the Self-Service SSO flow. Possible values: [`oidc`, `samlp`, `waad`, `google-apps`, `adfs`, `okta`, `auth0-samlp`, `okta-samlp`, `keycloak-samlp`, `pingfederate`] */ allowed_strategies?: Management.SelfServiceProfileAllowedStrategyEnum[] | undefined; /** ID of the user-attribute-profile to associate with this self-service profile. */ user_attribute_profile_id?: string | undefined; } export interface UpdateSessionResponseContent { /** The ID of the session */ id?: string | undefined; /** ID of the user which can be used when interacting with other APIs. */ user_id?: string | undefined; created_at?: Management.SessionDate | undefined; updated_at?: Management.SessionDate | undefined; authenticated_at?: Management.SessionDate | undefined; idle_expires_at?: Management.SessionDate | undefined; expires_at?: Management.SessionDate | undefined; last_interacted_at?: Management.SessionDate | undefined; device?: Management.SessionDeviceMetadata | undefined; /** List of client details for the session */ clients?: Management.SessionClientMetadata[] | undefined; authentication?: Management.SessionAuthenticationSignals | undefined; cookie?: Management.SessionCookieMetadata | undefined; session_metadata?: ((Management.SessionMetadata | undefined) | null) | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface UpdateSettingsResponseContent { universal_login_experience?: Management.UniversalLoginExperienceEnum | undefined; /** Whether identifier first is enabled or not */ identifier_first?: boolean | undefined; /** Use WebAuthn with Device Biometrics as the first authentication factor */ webauthn_platform_first_factor?: boolean | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface UpdateSuspiciousIpThrottlingSettingsResponseContent { /** Whether or not suspicious IP throttling attack protections are active. */ enabled?: boolean | undefined; /** * Action to take when a suspicious IP throttling threshold is violated. * Possible values: block, admin_notification. */ shields?: Management.SuspiciousIpThrottlingShieldsEnum[] | undefined; allowlist?: Management.SuspiciousIpThrottlingAllowlist | undefined; stage?: Management.SuspiciousIpThrottlingStage | undefined; } export interface UpdateTenantSettingsResponseContent { change_password?: (Management.TenantSettingsPasswordPage | null) | undefined; guardian_mfa_page?: (Management.TenantSettingsGuardianPage | null) | undefined; /** Default audience for API authorization. */ default_audience?: string | undefined; /** Name of connection used for password grants at the `/token`endpoint. The following connection types are supported: LDAP, AD, Database Connections, Passwordless, Windows Azure Active Directory, ADFS. */ default_directory?: string | undefined; error_page?: (Management.TenantSettingsErrorPage | null) | undefined; device_flow?: (Management.TenantSettingsDeviceFlow | null) | undefined; default_token_quota?: (Management.DefaultTokenQuota | null) | undefined; flags?: Management.TenantSettingsFlags | undefined; /** Friendly name for this tenant. */ friendly_name?: string | undefined; /** URL of logo to be shown for this tenant (recommended size: 150x150) */ picture_url?: string | undefined; /** End-user support email address. */ support_email?: string | undefined; /** End-user support URL. */ support_url?: string | undefined; /** URLs that are valid to redirect to after logout from Auth0. */ allowed_logout_urls?: string[] | undefined; /** Number of hours a session will stay valid. */ session_lifetime?: number | undefined; /** Number of hours for which a session can be inactive before the user must log in again. */ idle_session_lifetime?: number | undefined; /** Number of hours an ephemeral (non-persistent) session will stay valid. */ ephemeral_session_lifetime?: number | undefined; /** Number of hours for which an ephemeral (non-persistent) session can be inactive before the user must log in again. */ idle_ephemeral_session_lifetime?: number | undefined; /** Selected sandbox version for the extensibility environment. */ sandbox_version?: string | undefined; /** Selected sandbox version for rules and hooks extensibility. */ legacy_sandbox_version?: string | undefined; /** Available sandbox versions for the extensibility environment. */ sandbox_versions_available?: string[] | undefined; /** The default absolute redirection uri, must be https */ default_redirection_uri?: string | undefined; /** Supported locales for the user interface. */ enabled_locales?: Management.SupportedLocales[] | undefined; session_cookie?: (Management.SessionCookieSchema | null) | undefined; sessions?: (Management.TenantSettingsSessions | null) | undefined; oidc_logout?: Management.TenantOidcLogoutSettings | undefined; /** Whether to accept an organization name instead of an ID on auth endpoints */ allow_organization_name_in_authentication_api?: boolean | undefined; /** Whether to enable flexible factors for MFA in the PostLogin action */ customize_mfa_in_postlogin_action?: boolean | undefined; /** Supported ACR values */ acr_values_supported?: (string[] | null) | undefined; mtls?: (Management.TenantSettingsMtls | null) | undefined; /** Enables the use of Pushed Authorization Requests */ pushed_authorization_requests_supported?: boolean | undefined; /** Supports iss parameter in authorization responses */ authorization_response_iss_parameter_supported?: (boolean | null) | undefined; /** * Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as `myapp://`, or `localhost`). * If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps. * See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information. */ skip_non_verifiable_callback_uri_confirmation_prompt?: (boolean | null) | undefined; resource_parameter_profile?: Management.TenantSettingsResourceParameterProfile | undefined; /** Whether the authorization server supports retrieving client metadata from a client_id URL. */ client_id_metadata_document_supported?: boolean | undefined; /** Whether Phone Consolidated Experience is enabled for this tenant. */ phone_consolidated_experience?: boolean | undefined; /** Whether Auth0 Guide (AI-powered assistance) is enabled for this tenant. */ enable_ai_guide?: boolean | undefined; dynamic_client_registration_security_mode?: Management.TenantSettingsDynamicClientRegistrationSecurityMode | undefined; } export interface UpdateTokenQuota { client_credentials: Management.TokenQuotaClientCredentials; } export type UpdateUniversalLoginTemplateRequestContent = string | { template: string; }; export interface UpdateUserAttributeProfileResponseContent { id?: Management.UserAttributeProfileId | undefined; name?: Management.UserAttributeProfileName | undefined; user_id?: Management.UserAttributeProfileUserId | undefined; user_attributes?: Management.UserAttributeProfileUserAttributes | undefined; } /** * The successfully created authentication method. */ export interface UpdateUserAuthenticationMethodResponseContent { /** The ID of the newly created authentication method (automatically generated by the application) */ id?: string | undefined; type: Management.CreatedAuthenticationMethodTypeEnum; /** A human-readable label to identify the authentication method. */ name?: string | undefined; /** Base32 encoded secret for TOTP generation */ totp_secret?: string | undefined; /** Applies to phone authentication methods only. The destination phone number used to send verification codes via text and voice. */ phone_number?: string | undefined; /** Applies to email authentication methods only. The email address used to send verification messages. */ email?: string | undefined; authentication_methods?: Management.UserAuthenticationMethodProperties[] | undefined; preferred_authentication_method?: Management.PreferredAuthenticationMethodEnum | undefined; /** Applies to webauthn authentication methods only. The id of the credential. */ key_id?: string | undefined; /** Applies to webauthn authentication methods only. The public key. */ public_key?: string | undefined; /** Applies to passkey authentication methods only. Authenticator Attestation Globally Unique Identifier. */ aaguid?: string | undefined; /** Applies to webauthn authentication methods only. The relying party identifier. */ relying_party_identifier?: string | undefined; /** Authentication method creation date */ created_at?: string | undefined; } export interface UpdateUserResponseContent { /** ID of the user which can be used when interacting with other APIs. */ user_id?: string | undefined; /** Email address of this user. */ email?: string | undefined; /** Whether this email address is verified (true) or unverified (false). */ email_verified?: boolean | undefined; /** Username of this user. */ username?: string | undefined; /** Phone number for this user. Follows the E.164 recommendation. */ phone_number?: string | undefined; /** Whether this phone number has been verified (true) or not (false). */ phone_verified?: boolean | undefined; created_at?: Management.UserDateSchema | undefined; updated_at?: Management.UserDateSchema | undefined; /** Array of user identity objects when accounts are linked. */ identities?: Management.UserIdentitySchema[] | undefined; app_metadata?: Management.UserAppMetadataSchema | undefined; user_metadata?: Management.UserMetadataSchema | undefined; /** URL to picture, photo, or avatar of this user. */ picture?: string | undefined; /** Name of this user. */ name?: string | undefined; /** Preferred nickname or alias of this user. */ nickname?: string | undefined; /** List of multi-factor authentication providers with which this user has enrolled. */ multifactor?: string[] | undefined; /** Last IP address from which this user logged in. */ last_ip?: string | undefined; last_login?: Management.UserDateSchema | undefined; /** Total number of logins this user has performed. */ logins_count?: number | undefined; /** Whether this user was blocked by an administrator (true) or is not (false). */ blocked?: boolean | undefined; /** Given name/first name/forename of this user. */ given_name?: string | undefined; /** Family name/last name/surname of this user. */ family_name?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface UpdateVerifiableCredentialTemplateResponseContent { /** The id of the template. */ id?: string | undefined; /** The name of the template. */ name?: string | undefined; /** The type of the template. */ type?: string | undefined; /** The dialect of the template. */ dialect?: string | undefined; presentation?: Management.MdlPresentationRequest | undefined; /** The custom certificate authority. */ custom_certificate_authority?: (string | null) | undefined; /** The well-known trusted issuers, comma separated. */ well_known_trusted_issuers?: (string | null) | undefined; /** The date and time the template was created. */ created_at?: string | undefined; /** The date and time the template was created. */ updated_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } /** * User metadata to which this user has read-only access. */ export type UserAppMetadataSchema = Record; export interface UserAttributeProfile { id?: Management.UserAttributeProfileId | undefined; name?: Management.UserAttributeProfileName | undefined; user_id?: Management.UserAttributeProfileUserId | undefined; user_attributes?: Management.UserAttributeProfileUserAttributes | undefined; } /** * User Attribute Profile identifier. */ export type UserAttributeProfileId = string; /** * The name of the user attribute profile. */ export type UserAttributeProfileName = string; /** * OIDC mapping for this attribute */ export interface UserAttributeProfileOidcMapping { /** OIDC mapping field */ mapping: string; /** Display name for the OIDC mapping */ display_name?: string | undefined; } export type UserAttributeProfilePatchUserId = (Management.UserAttributeProfileUserId | null) | undefined; /** * SAML mapping override for this strategy */ export type UserAttributeProfileSamlMapping = string[]; /** * Strategy-specific overrides for this attribute */ export interface UserAttributeProfileStrategyOverrides { pingfederate?: Management.UserAttributeProfileStrategyOverridesMapping | undefined; ad?: Management.UserAttributeProfileStrategyOverridesMapping | undefined; adfs?: Management.UserAttributeProfileStrategyOverridesMapping | undefined; waad?: Management.UserAttributeProfileStrategyOverridesMapping | undefined; "google-apps"?: Management.UserAttributeProfileStrategyOverridesMapping | undefined; okta?: Management.UserAttributeProfileStrategyOverridesMapping | undefined; oidc?: Management.UserAttributeProfileStrategyOverridesMapping | undefined; samlp?: Management.UserAttributeProfileStrategyOverridesMapping | undefined; } export interface UserAttributeProfileStrategyOverridesMapping { /** OIDC mapping override for this strategy */ oidc_mapping?: Management.UserAttributeProfileOidcMapping | undefined; saml_mapping?: Management.UserAttributeProfileSamlMapping | undefined; /** SCIM mapping override for this strategy */ scim_mapping?: string | undefined; } /** * Strategy-specific overrides for user ID */ export interface UserAttributeProfileStrategyOverridesUserId { pingfederate?: Management.UserAttributeProfileStrategyOverridesUserIdMapping | undefined; ad?: Management.UserAttributeProfileStrategyOverridesUserIdMapping | undefined; adfs?: Management.UserAttributeProfileStrategyOverridesUserIdMapping | undefined; waad?: Management.UserAttributeProfileStrategyOverridesUserIdMapping | undefined; "google-apps"?: Management.UserAttributeProfileStrategyOverridesUserIdMapping | undefined; okta?: Management.UserAttributeProfileStrategyOverridesUserIdMapping | undefined; oidc?: Management.UserAttributeProfileStrategyOverridesUserIdMapping | undefined; samlp?: Management.UserAttributeProfileStrategyOverridesUserIdMapping | undefined; } export interface UserAttributeProfileStrategyOverridesUserIdMapping { oidc_mapping?: Management.UserAttributeProfileUserIdOidcStrategyOverrideMapping | undefined; saml_mapping?: Management.UserAttributeProfileSamlMapping | undefined; /** SCIM mapping override for this strategy */ scim_mapping?: string | undefined; } /** * The structure of the template, which can be used as the payload for creating or updating a User Attribute Profile. */ export interface UserAttributeProfileTemplate { name?: Management.UserAttributeProfileName | undefined; user_id?: Management.UserAttributeProfileUserId | undefined; user_attributes?: Management.UserAttributeProfileUserAttributes | undefined; } export interface UserAttributeProfileTemplateItem { /** The id of the template. */ id?: string | undefined; /** The user-friendly name of the template displayed in the UI. */ display_name?: string | undefined; template?: Management.UserAttributeProfileTemplate | undefined; } export interface UserAttributeProfileUserAttributeAdditionalProperties { /** Description of this attribute */ description: string; /** Display label for this attribute */ label: string; /** Whether this attribute is required in the profile */ profile_required: boolean; /** Auth0 mapping for this attribute */ auth0_mapping: string; oidc_mapping?: Management.UserAttributeProfileOidcMapping | undefined; /** SAML mapping for this attribute */ saml_mapping?: Management.UserAttributeProfileSamlMapping | undefined; /** SCIM mapping for this attribute */ scim_mapping?: string | undefined; strategy_overrides?: Management.UserAttributeProfileStrategyOverrides | undefined; } /** * User attributes configuration map. Keys are attribute names, values are the mapping configuration for each attribute. */ export type UserAttributeProfileUserAttributes = Record; /** * User ID mapping configuration */ export interface UserAttributeProfileUserId { oidc_mapping?: Management.UserAttributeProfileUserIdOidcMappingEnum | undefined; saml_mapping?: Management.UserAttributeProfileUserIdSamlMapping | undefined; /** SCIM mapping for user ID */ scim_mapping?: string | undefined; strategy_overrides?: Management.UserAttributeProfileStrategyOverridesUserId | undefined; } /** OIDC mapping for user ID */ export declare const UserAttributeProfileUserIdOidcMappingEnum: { readonly Sub: "sub"; }; export type UserAttributeProfileUserIdOidcMappingEnum = (typeof UserAttributeProfileUserIdOidcMappingEnum)[keyof typeof UserAttributeProfileUserIdOidcMappingEnum]; /** OIDC mapping override for this strategy */ export declare const UserAttributeProfileUserIdOidcStrategyOverrideMapping: { readonly Sub: "sub"; readonly Oid: "oid"; readonly Email: "email"; }; export type UserAttributeProfileUserIdOidcStrategyOverrideMapping = (typeof UserAttributeProfileUserIdOidcStrategyOverrideMapping)[keyof typeof UserAttributeProfileUserIdOidcStrategyOverrideMapping]; /** * SAML mapping for user ID */ export type UserAttributeProfileUserIdSamlMapping = string[]; export interface UserAuthenticationMethod { /** The ID of the authentication method (auto generated) */ id: string; type: Management.AuthenticationMethodTypeEnum; /** The authentication method status */ confirmed?: boolean | undefined; /** A human-readable label to identify the authentication method */ name?: string | undefined; authentication_methods?: Management.UserAuthenticationMethodProperties[] | undefined; preferred_authentication_method?: Management.PreferredAuthenticationMethodEnum | undefined; /** The ID of a linked authentication method. Linked authentication methods will be deleted together. */ link_id?: string | undefined; /** Applies to phone authentication methods only. The destination phone number used to send verification codes via text and voice. */ phone_number?: string | undefined; /** Applies to email and email-verification authentication methods only. The email address used to send verification messages. */ email?: string | undefined; /** Applies to webauthn authentication methods only. The ID of the generated credential. */ key_id?: string | undefined; /** Applies to webauthn authentication methods only. The public key. */ public_key?: string | undefined; /** Authenticator creation date */ created_at: string; /** Enrollment date */ enrolled_at?: string | undefined; /** Last authentication */ last_auth_at?: string | undefined; /** Applies to passkeys only. The kind of device the credential is stored on as defined by backup eligibility. "single_device" credentials cannot be backed up and synced to another device, "multi_device" credentials can be backed up if enabled by the end-user. */ credential_device_type?: string | undefined; /** Applies to passkeys only. Whether the credential was backed up. */ credential_backed_up?: boolean | undefined; /** Applies to passkeys only. The ID of the user identity linked with the authentication method. */ identity_user_id?: string | undefined; /** Applies to passkeys only. The user-agent of the browser used to create the passkey. */ user_agent?: string | undefined; /** Applies to passkey authentication methods only. Authenticator Attestation Globally Unique Identifier. */ aaguid?: string | undefined; /** Applies to webauthn/passkey authentication methods only. The credential's relying party identifier. */ relying_party_identifier?: string | undefined; } export interface UserAuthenticationMethodProperties { type?: Management.UserAuthenticationMethodPropertiesEnum | undefined; id?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export declare const UserAuthenticationMethodPropertiesEnum: { readonly Totp: "totp"; readonly Push: "push"; readonly Sms: "sms"; readonly Voice: "voice"; }; export type UserAuthenticationMethodPropertiesEnum = (typeof UserAuthenticationMethodPropertiesEnum)[keyof typeof UserAuthenticationMethodPropertiesEnum]; export interface UserBlockIdentifier { /** Identifier (should be any of an `email`, `username`, or `phone_number`) */ identifier?: string | undefined; /** IP Address */ ip?: string | undefined; /** Connection identifier */ connection?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export type UserDateSchema = /** * Date and time when this user was created (ISO_8601 format). */ string /** * Date and time when this user was created (ISO_8601 format). */ | Record; /** Authentication method for this enrollment. Can be `authenticator`, `guardian`, `sms`, `webauthn-roaming`, or `webauthn-platform`. */ export declare const UserEnrollmentAuthMethodEnum: { readonly Authenticator: "authenticator"; readonly Guardian: "guardian"; readonly Sms: "sms"; readonly WebauthnPlatform: "webauthn-platform"; readonly WebauthnRoaming: "webauthn-roaming"; }; export type UserEnrollmentAuthMethodEnum = (typeof UserEnrollmentAuthMethodEnum)[keyof typeof UserEnrollmentAuthMethodEnum]; /** Status of this enrollment. Can be `pending` or `confirmed`. */ export declare const UserEnrollmentStatusEnum: { readonly Pending: "pending"; readonly Confirmed: "confirmed"; }; export type UserEnrollmentStatusEnum = (typeof UserEnrollmentStatusEnum)[keyof typeof UserEnrollmentStatusEnum]; export interface UserGrant { /** ID of the grant. */ id?: string | undefined; /** ID of the client. */ clientID?: string | undefined; /** ID of the user. */ user_id?: string | undefined; /** Audience of the grant. */ audience?: string | undefined; /** Scopes included in this grant. */ scope?: string[] | undefined; } export interface UserGroupsResponseSchema extends Management.Group { /** Timestamp of when the group membership was added. */ membership_created_at?: string | undefined; } /** * user_id of the secondary user account being linked. */ export type UserId = string | number; export interface UserIdentity { /** Connection name of this identity. */ connection: string; /** user_id of this identity. */ user_id: Management.UserId; /** Type of identity provider. */ provider: string; profileData?: Management.UserProfileData | undefined; /** Whether the identity provider is a social provider (true) or not (false). */ isSocial?: boolean | undefined; /** IDP access token returned if scope `read:user_idp_tokens` is defined. */ access_token?: string | undefined; /** IDP access token secret returned only if `scope read:user_idp_tokens` is defined. */ access_token_secret?: string | undefined; /** IDP refresh token returned only if scope `read:user_idp_tokens` is defined. */ refresh_token?: string | undefined; } /** The type of identity provider */ export declare const UserIdentityProviderEnum: { readonly Ad: "ad"; readonly Adfs: "adfs"; readonly Amazon: "amazon"; readonly Apple: "apple"; readonly Dropbox: "dropbox"; readonly Bitbucket: "bitbucket"; readonly Auth0Oidc: "auth0-oidc"; readonly Auth0: "auth0"; readonly Baidu: "baidu"; readonly Bitly: "bitly"; readonly Box: "box"; readonly Custom: "custom"; readonly Daccount: "daccount"; readonly Dwolla: "dwolla"; readonly Email: "email"; readonly EvernoteSandbox: "evernote-sandbox"; readonly Evernote: "evernote"; readonly Exact: "exact"; readonly Facebook: "facebook"; readonly Fitbit: "fitbit"; readonly Github: "github"; readonly GoogleApps: "google-apps"; readonly GoogleOauth2: "google-oauth2"; readonly Instagram: "instagram"; readonly Ip: "ip"; readonly Line: "line"; readonly Linkedin: "linkedin"; readonly Oauth1: "oauth1"; readonly Oauth2: "oauth2"; readonly Office365: "office365"; readonly Oidc: "oidc"; readonly Okta: "okta"; readonly Paypal: "paypal"; readonly PaypalSandbox: "paypal-sandbox"; readonly Pingfederate: "pingfederate"; readonly Planningcenter: "planningcenter"; readonly SalesforceCommunity: "salesforce-community"; readonly SalesforceSandbox: "salesforce-sandbox"; readonly Salesforce: "salesforce"; readonly Samlp: "samlp"; readonly Sharepoint: "sharepoint"; readonly Shopify: "shopify"; readonly Shop: "shop"; readonly Sms: "sms"; readonly Soundcloud: "soundcloud"; readonly Thirtysevensignals: "thirtysevensignals"; readonly Twitter: "twitter"; readonly Untappd: "untappd"; readonly Vkontakte: "vkontakte"; readonly Waad: "waad"; readonly Weibo: "weibo"; readonly Windowslive: "windowslive"; readonly Wordpress: "wordpress"; readonly Yahoo: "yahoo"; readonly Yandex: "yandex"; }; export type UserIdentityProviderEnum = (typeof UserIdentityProviderEnum)[keyof typeof UserIdentityProviderEnum]; export interface UserIdentitySchema { /** Name of the connection containing this identity. */ connection?: string | undefined; /** Unique identifier of the user user for this identity. */ user_id?: string | undefined; provider?: Management.UserIdentityProviderEnum | undefined; /** Whether this identity is from a social provider (true) or not (false). */ isSocial?: boolean | undefined; /** IDP access token returned only if scope read:user_idp_tokens is defined. */ access_token?: string | undefined; /** IDP access token secret returned only if scope read:user_idp_tokens is defined. */ access_token_secret?: string | undefined; /** IDP refresh token returned only if scope read:user_idp_tokens is defined. */ refresh_token?: string | undefined; profileData?: Management.UserProfileData | undefined; } export interface UserListLogOffsetPaginatedResponseContent { start?: number | undefined; limit?: number | undefined; length?: number | undefined; total?: number | undefined; logs?: Management.Log[] | undefined; } /** * Data related to the user that does not affect the application's core functionality. */ export type UserMetadata = Record; /** * User metadata to which this user has read/write access. */ export type UserMetadataSchema = Record; /** The multi-factor provider. Supported values 'duo' or 'google-authenticator' */ export declare const UserMultifactorProviderEnum: { readonly Duo: "duo"; readonly GoogleAuthenticator: "google-authenticator"; }; export type UserMultifactorProviderEnum = (typeof UserMultifactorProviderEnum)[keyof typeof UserMultifactorProviderEnum]; export interface UserPermissionSchema { /** Resource server (API) identifier that this permission is for. */ resource_server_identifier?: string | undefined; /** Name of this permission. */ permission_name?: string | undefined; /** Resource server (API) name this permission is for. */ resource_server_name?: string | undefined; /** Description of this permission. */ description?: string | undefined; } export interface UserProfileData { /** Email address of this user. */ email?: string | undefined; /** Whether this email address is verified (true) or unverified (false). */ email_verified?: boolean | undefined; /** Name of this user. */ name?: string | undefined; /** Username of this user. */ username?: string | undefined; /** Given name/first name/forename of this user. */ given_name?: string | undefined; /** Phone number for this user. */ phone_number?: string | undefined; /** Whether this phone number is verified (true) or unverified (false). */ phone_verified?: boolean | undefined; /** Family name/last name/surname of this user. */ family_name?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface UserResponseSchema { /** ID of the user which can be used when interacting with other APIs. */ user_id?: string | undefined; /** Email address of this user. */ email?: string | undefined; /** Whether this email address is verified (true) or unverified (false). */ email_verified?: boolean | undefined; /** Username of this user. */ username?: string | undefined; /** Phone number for this user. Follows the E.164 recommendation. */ phone_number?: string | undefined; /** Whether this phone number has been verified (true) or not (false). */ phone_verified?: boolean | undefined; created_at?: Management.UserDateSchema | undefined; updated_at?: Management.UserDateSchema | undefined; /** Array of user identity objects when accounts are linked. */ identities?: Management.UserIdentitySchema[] | undefined; app_metadata?: Management.UserAppMetadataSchema | undefined; user_metadata?: Management.UserMetadataSchema | undefined; /** URL to picture, photo, or avatar of this user. */ picture?: string | undefined; /** Name of this user. */ name?: string | undefined; /** Preferred nickname or alias of this user. */ nickname?: string | undefined; /** List of multi-factor authentication providers with which this user has enrolled. */ multifactor?: string[] | undefined; /** Last IP address from which this user logged in. */ last_ip?: string | undefined; last_login?: Management.UserDateSchema | undefined; /** Total number of logins this user has performed. */ logins_count?: number | undefined; /** Whether this user was blocked by an administrator (true) or is not (false). */ blocked?: boolean | undefined; /** Given name/first name/forename of this user. */ given_name?: string | undefined; /** Family name/last name/surname of this user. */ family_name?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface UsernameAllowedTypes { email?: boolean | undefined; phone_number?: boolean | undefined; } /** * Configuration for the username attribute for users. */ export interface UsernameAttribute { identifier?: Management.ConnectionAttributeIdentifier | undefined; /** Determines if property should be required for users */ profile_required?: boolean | undefined; signup?: Management.SignupSchema | undefined; validation?: Management.UsernameValidation | undefined; } export interface UsernameValidation { /** Minimum allowed length */ min_length?: number | undefined; /** Maximum allowed length */ max_length?: number | undefined; allowed_types?: Management.UsernameAllowedTypes | undefined; } export interface UsersEnrollment { /** ID of this enrollment. */ id?: string | undefined; status?: Management.UserEnrollmentStatusEnum | undefined; /** Type of enrollment. */ type?: string | undefined; /** Name of enrollment (usually phone number). */ name?: string | undefined; /** Device identifier (usually phone identifier) of this enrollment. */ identifier?: string | undefined; /** Phone number for this enrollment. */ phone_number?: string | undefined; auth_method?: Management.UserEnrollmentAuthMethodEnum | undefined; /** Start date and time of this enrollment. */ enrolled_at?: string | undefined; /** Last authentication date and time of this enrollment. */ last_auth?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export interface VerifiableCredentialTemplateResponse { /** The id of the template. */ id?: string | undefined; /** The name of the template. */ name?: string | undefined; /** The type of the template. */ type?: string | undefined; /** The dialect of the template. */ dialect?: string | undefined; presentation?: Management.MdlPresentationRequest | undefined; /** The custom certificate authority. */ custom_certificate_authority?: (string | null) | undefined; /** The well-known trusted issuers, comma separated. */ well_known_trusted_issuers?: (string | null) | undefined; /** The date and time the template was created. */ created_at?: string | undefined; /** The date and time the template was created. */ updated_at?: string | undefined; /** Accepts any additional properties */ [key: string]: any; } export declare const VerificationMethodEnum: { readonly Link: "link"; readonly Otp: "otp"; }; export type VerificationMethodEnum = (typeof VerificationMethodEnum)[keyof typeof VerificationMethodEnum]; export interface VerifyCustomDomainResponseContent { /** ID of the custom domain. */ custom_domain_id: string; /** Domain name. */ domain: string; /** Whether this is a primary domain (true) or not (false). */ primary: boolean; status: Management.CustomDomainStatusFilterEnum; type: Management.CustomDomainTypeEnum; /** CNAME API key header. */ cname_api_key?: string | undefined; /** Intermediate address. */ origin_domain_name?: string | undefined; verification?: Management.DomainVerification | undefined; /** The HTTP header to fetch the client's IP address */ custom_client_ip_header?: (string | null) | undefined; /** The TLS version policy */ tls_policy?: string | undefined; domain_metadata?: Management.DomainMetadata | undefined; certificate?: Management.DomainCertificate | undefined; } export interface VerifyEmailTicketResponseContent { /** URL representing the ticket. */ ticket: string; /** Accepts any additional properties */ [key: string]: any; } export interface X509CertificateCredential { credential_type: Management.X509CertificateCredentialTypeEnum; /** Friendly name for a credential. */ name?: string | undefined; /** PEM-formatted X509 certificate. Must be JSON escaped. */ pem: string; } export declare const X509CertificateCredentialTypeEnum: { readonly X509Cert: "x509_cert"; }; export type X509CertificateCredentialTypeEnum = (typeof X509CertificateCredentialTypeEnum)[keyof typeof X509CertificateCredentialTypeEnum];