auth0

import * as Management from "../index.js"; 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"; /** * 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; /** The name of an action. */ name?: string; /** 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[]; /** True if all of an Action's contents have been deployed. */ all_changes_deployed?: boolean; /** The time when this action was created. */ created_at?: string; /** The time when this action was updated. */ updated_at?: string; /** The source code of the action. */ code?: string; /** The list of third party npm modules, and their versions, that this action depends on. */ dependencies?: Management.ActionVersionDependency[]; /** The Node runtime. For example: `node22`, defaults to `node22` */ runtime?: string; /** The list of secrets that are included in an action or a version of an action. */ secrets?: Management.ActionSecretResponse[]; deployed_version?: Management.ActionDeployedVersion; /** installed_integration_id is the fk reference to the InstalledIntegration entity. */ installed_integration_id?: string; integration?: Management.Integration; status?: Management.ActionBuildStatusEnum; /** The time when this action was built successfully. */ built_at?: string; /** True if the action should be deployed after creation. */ deploy?: boolean; /** The list of action modules and their versions used by this action. */ modules?: Management.ActionModuleReference[]; } /** * The action to which this version belongs. */ export interface ActionBase { /** The unique ID of the action. */ id?: string; /** The name of an action. */ name?: string; /** 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[]; /** True if all of an Action's contents have been deployed. */ all_changes_deployed?: boolean; /** The time when this action was created. */ created_at?: string; /** The time when this action was updated. */ updated_at?: string; } /** * Binding is the associative entity joining a trigger, and an action together. */ export interface ActionBinding { /** The unique ID of this binding. */ id?: string; trigger_id?: Management.ActionTriggerTypeEnum; /** The name of the binding. */ display_name?: string; action?: Management.Action; /** The time when the binding was created. */ created_at?: string; /** The time when the binding was updated. */ updated_at?: string; } /** * A reference to an action. An action can be referred to by ID or by Name. */ export interface ActionBindingRef { type?: Management.ActionBindingRefTypeEnum; /** The id or name of an action that is being bound to a trigger. */ value?: string; /** 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; /** The list of secrets that are included in an action or a version of an action. */ secrets?: Management.ActionSecretRequest[]; } /** 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; /** The id of the action to which this version belongs. */ action_id?: string; /** The source code of this specific version of the action. */ code?: string; /** The list of third party npm modules, and their versions, that this specific version depends on. */ dependencies?: Management.ActionVersionDependency[]; /** Indicates if this specific version is the currently one deployed. */ deployed?: boolean; /** The Node runtime. For example: `node22` */ runtime?: string; /** The list of secrets that are included in an action or a version of an action. */ secrets?: Management.ActionSecretResponse[]; status?: Management.ActionVersionBuildStatusEnum; /** The index of this version in list of versions for the action. */ number?: number; /** Any errors that occurred while the version was being built. */ errors?: Management.ActionError[]; action?: Management.ActionBase; /** The time when this version was built successfully. */ built_at?: string; /** The time when this version was created. */ created_at?: string; /** 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; /** 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[]; /** The list of action modules and their versions used by this action version. */ modules?: Management.ActionModuleReference[]; } /** * Error is a generic error with a human readable id which should be easily referenced in support tickets. */ export interface ActionError { id?: string; msg?: string; url?: string; } /** * Captures the results of a single action being executed. */ export interface ActionExecutionResult { /** The name of the action that was executed. */ action_name?: string; error?: Management.ActionError; /** The time when the action was started. */ started_at?: string; /** The time when the action finished executing. */ ended_at?: string; } /** 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; /** The name of the action. */ action_name?: string; /** The ID of the module version this action is using. */ module_version_id?: string; /** The version number of the module this action is using. */ module_version_number?: number; /** The triggers that this action supports. */ supported_triggers?: Management.ActionTrigger[]; } export interface ActionModuleDependency { /** The name of the npm dependency. */ name?: string; /** The version of the npm dependency. */ version?: string; } 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; /** The name of the module. */ name?: string; /** The source code from the module's draft version. */ code?: string; /** The npm dependencies from the module's draft version. */ dependencies?: Management.ActionModuleDependency[]; /** The secrets from the module's draft version (names and timestamps only, values never returned). */ secrets?: Management.ActionModuleSecret[]; /** The number of deployed actions using this module. */ actions_using_module_total?: number; /** Whether all draft changes have been published as a version. */ all_changes_published?: boolean; /** The version number of the latest published version. Omitted if no versions have been published. */ latest_version_number?: number; /** Timestamp when the module was created. */ created_at?: string; /** Timestamp when the module was last updated. */ updated_at?: string; } /** * Reference to a module and its version used by an action. */ export interface ActionModuleReference { /** The unique ID of the module. */ module_id?: string; /** The name of the module. */ module_name?: string; /** The ID of the specific module version. */ module_version_id?: string; /** The version number of the module. */ module_version_number?: number; } export interface ActionModuleSecret { /** The name of the secret. */ name?: string; /** The time when the secret was last updated. */ updated_at?: string; } 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; /** The ID of the parent module. */ module_id?: string; /** The sequential version number. */ version_number?: number; /** The exact source code that was published with this version. */ code?: string; /** Secrets available to this version (name and updated_at only, values never returned). */ secrets?: Management.ActionModuleSecret[]; /** Dependencies locked to this version. */ dependencies?: Management.ActionModuleDependency[]; /** The timestamp when this version was created. */ created_at?: string; } /** * 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; /** The version number. */ version_number?: number; /** The source code from this version. */ code?: string; /** The npm dependencies from this version. */ dependencies?: Management.ActionModuleDependency[]; /** The secrets from this version (names and timestamps only, values never returned). */ secrets?: Management.ActionModuleSecret[]; /** Timestamp when the version was created. */ created_at?: string; } export interface ActionSecretRequest { /** The name of the particular secret, e.g. API_KEY. */ name?: string; /** 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; /** Accepts any additional properties */ [key: string]: any; } export interface ActionSecretResponse { /** The name of the particular secret, e.g. API_KEY. */ name?: string; /** The time when the secret was last updated. */ updated_at?: string; /** Accepts any additional properties */ [key: string]: any; } export interface ActionTrigger { id: Management.ActionTriggerTypeEnum; /** The version of a trigger. v1, v2, etc. */ version?: string; /** status points to the trigger status. */ status?: string; /** runtimes supported by this trigger. */ runtimes?: string[]; /** Runtime that will be used when none is specified when creating an action. */ default_runtime?: string; /** compatible_triggers informs which other trigger supports the same event and api. */ compatible_triggers?: Management.ActionTriggerCompatibleTrigger[]; binding_policy?: Management.ActionBindingTypeEnum; } 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 type ActionTriggerTypeEnum = string; export interface ActionVersion { /** The unique id of an action version. */ id?: string; /** The id of the action to which this version belongs. */ action_id?: string; /** The source code of this specific version of the action. */ code?: string; /** The list of third party npm modules, and their versions, that this specific version depends on. */ dependencies?: Management.ActionVersionDependency[]; /** Indicates if this specific version is the currently one deployed. */ deployed?: boolean; /** The Node runtime. For example: `node22` */ runtime?: string; /** The list of secrets that are included in an action or a version of an action. */ secrets?: Management.ActionSecretResponse[]; status?: Management.ActionVersionBuildStatusEnum; /** The index of this version in list of versions for the action. */ number?: number; /** Any errors that occurred while the version was being built. */ errors?: Management.ActionError[]; action?: Management.ActionBase; /** The time when this version was built successfully. */ built_at?: string; /** The time when this version was created. */ created_at?: string; /** 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; /** 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[]; /** The list of action modules and their versions used by this action version. */ modules?: Management.ActionModuleReference[]; } /** 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; /** description is the version of the npm module, e.g. 4.17.1 */ version?: string; /** registry_url is an optional value used primarily for private npm registries. */ registry_url?: string; } /** * 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<string, unknown>; export interface AculConfigsItem { prompt: Management.PromptGroupNameEnum; screen: Management.ScreenGroupNameEnum; rendering_mode?: Management.AculRenderingModeEnum; context_configuration?: Management.AculContextConfiguration; /** Override Universal Login default head tags */ default_head_tags_disabled?: boolean | null; /** Use page template with ACUL */ use_page_template?: boolean | null; /** An array of head tags */ head_tags?: Management.AculHeadTag[]; filters?: Management.AculFilters | null; } /** * Array of screen configurations to update */ export type AculConfigs = Management.AculConfigsItem[]; /** * Context values to make available */ export type AculContextConfiguration = Management.AculContextConfigurationItem[]; 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<string, unknown>; /** * Optional filters to apply rendering rules to specific entities */ export interface AculFilters { match_type?: Management.AculMatchTypeEnum; /** Clients filter */ clients?: Management.AculClientFilter[]; /** Organizations filter */ organizations?: Management.AculOrganizationFilter[]; /** Domains filter */ domains?: Management.AculDomainFilter[]; } export interface AculHeadTag { /** Any HTML element valid for use in the head tag */ tag?: string; attributes?: Management.AculHeadTagAttributes; content?: Management.AculHeadTagContent; /** Accepts any additional properties */ [key: string]: any; } /** * Attributes of the HTML tag. See <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes"> MDN documentation</a> for valid attributes. */ export type AculHeadTagAttributes = Record<string, unknown>; /** * Text or markup between the element’s opening and closing tags. * You can use <a href="https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens">context variables</a> 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<string, unknown>; /** 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; /** 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; /** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */ show_as_button?: boolean; /** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */ is_signup_enabled?: boolean; connection?: Management.OrganizationConnectionInformation; } /** * 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<string, unknown>; 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; /** ID of the client. */ client_id?: string; /** The audience (API identifier) of this client grant */ audience?: string; /** Scopes allowed for this client grant. */ scope?: string[]; organization_usage?: Management.OrganizationUsageEnum; /** 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; } 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; /** Whether the captcha should fail open. */ fail_open?: boolean; /** The subdomain used for client requests to the Arkose captcha provider. */ client_subdomain?: string; /** The subdomain used for server-side verification requests to the Arkose captcha provider. */ verify_subdomain?: string; /** 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; /** Accepts any additional properties */ [key: string]: any; } export interface AttackProtectionCaptchaFriendlyCaptchaResponseContent { /** The site key for the Friendly Captcha provider. */ site_key?: string; /** Accepts any additional properties */ [key: string]: any; } export interface AttackProtectionCaptchaHcaptchaResponseContent { /** The site key for the hCaptcha provider. */ site_key?: string; /** 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; /** The project ID for the reCAPTCHA Enterprise provider. */ project_id?: string; /** Accepts any additional properties */ [key: string]: any; } export interface AttackProtectionCaptchaRecaptchaV2ResponseContent { /** The site key for the reCAPTCHA v2 provider. */ site_key?: string; /** Accepts any additional properties */ [key: string]: any; } export type AttackProtectionCaptchaSimpleCaptchaResponseContent = Record<string, unknown>; 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; /** The subdomain used for server-side verification requests to the Arkose captcha provider. */ verify_subdomain?: string; /** Whether the captcha should fail open. */ fail_open?: boolean; } 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 pol