auth0
Version:
Auth0 Node.js SDK for the Management API v2.
1,522 lines (1,521 loc) • 85.6 kB
JavaScript
// This file was auto-generated by Fern from our API Definition.
export const OauthScope = {
/**
* Read Actions */
ReadActions: "read:actions",
/**
* Create Actions */
CreateActions: "create:actions",
/**
* Delete Actions */
DeleteActions: "delete:actions",
/**
* Update Actions */
UpdateActions: "update:actions",
/**
* Read Anomaly Blocks */
ReadAnomalyBlocks: "read:anomaly_blocks",
/**
* Delete Anomaly Blocks */
DeleteAnomalyBlocks: "delete:anomaly_blocks",
/**
* Read Shields */
ReadShields: "read:shields",
/**
* Create Shields */
CreateShields: "create:shields",
/**
* Update Shields */
UpdateShields: "update:shields",
/**
* Read Attack Protection */
ReadAttackProtection: "read:attack_protection",
/**
* Update Attack Protection */
UpdateAttackProtection: "update:attack_protection",
/**
* Read Branding */
ReadBranding: "read:branding",
/**
* Update Branding */
UpdateBranding: "update:branding",
/**
* Read Phone Providers */
ReadPhoneProviders: "read:phone_providers",
/**
* Create Phone Providers */
CreatePhoneProviders: "create:phone_providers",
/**
* Update Phone Providers */
UpdatePhoneProviders: "update:phone_providers",
/**
* Delete Phone Providers */
DeletePhoneProviders: "delete:phone_providers",
/**
* Read Phone Templates */
ReadPhoneTemplates: "read:phone_templates",
/**
* Create Phone Templates */
CreatePhoneTemplates: "create:phone_templates",
/**
* Update Phone Templates */
UpdatePhoneTemplates: "update:phone_templates",
/**
* Delete Phone Templates */
DeletePhoneTemplates: "delete:phone_templates",
/**
* Delete Branding */
DeleteBranding: "delete:branding",
/**
* Read Client Grants */
ReadClientGrants: "read:client_grants",
/**
* Create Client Grants */
CreateClientGrants: "create:client_grants",
/**
* Update Client Grants */
UpdateClientGrants: "update:client_grants",
/**
* Delete Client Grants */
DeleteClientGrants: "delete:client_grants",
/**
* Read Organization Client Grants */
ReadOrganizationClientGrants: "read:organization_client_grants",
/**
* Read Clients */
ReadClients: "read:clients",
/**
* Read Client Keys */
ReadClientKeys: "read:client_keys",
/**
* Read Client Credentials */
ReadClientCredentials: "read:client_credentials",
/**
* Read Client Summary */
ReadClientSummary: "read:client_summary",
/**
* Create Clients */
CreateClients: "create:clients",
/**
* Create Client Credentials */
CreateClientCredentials: "create:client_credentials",
/**
* Update Client Credentials */
UpdateClientCredentials: "update:client_credentials",
/**
* Delete Client Credentials */
DeleteClientCredentials: "delete:client_credentials",
/**
* Update Clients */
UpdateClients: "update:clients",
/**
* Update Client Keys */
UpdateClientKeys: "update:client_keys",
/**
* Update Client Token Vault Privileged Access */
UpdateClientTokenVaultPrivilegedAccess: "update:client_token_vault_privileged_access",
/**
* Delete Clients */
DeleteClients: "delete:clients",
/**
* Read Connections */
ReadConnections: "read:connections",
/**
* Read Connection Profiles */
ReadConnectionProfiles: "read:connection_profiles",
/**
* Create Connection Profiles */
CreateConnectionProfiles: "create:connection_profiles",
/**
* Update Connection Profiles */
UpdateConnectionProfiles: "update:connection_profiles",
/**
* Delete Connection Profiles */
DeleteConnectionProfiles: "delete:connection_profiles",
/**
* Create Connections */
CreateConnections: "create:connections",
/**
* Update Connections */
UpdateConnections: "update:connections",
/**
* Delete Connections */
DeleteConnections: "delete:connections",
/**
* Read Directory Provisionings */
ReadDirectoryProvisionings: "read:directory_provisionings",
/**
* Create Directory Provisionings */
CreateDirectoryProvisionings: "create:directory_provisionings",
/**
* Update Directory Provisionings */
UpdateDirectoryProvisionings: "update:directory_provisionings",
/**
* Delete Directory Provisionings */
DeleteDirectoryProvisionings: "delete:directory_provisionings",
/**
* Read Users */
ReadUsers: "read:users",
/**
* Read Connections Keys */
ReadConnectionsKeys: "read:connections_keys",
/**
* Create Connections Keys */
CreateConnectionsKeys: "create:connections_keys",
/**
* Update Connections Keys */
UpdateConnectionsKeys: "update:connections_keys",
/**
* Read Scim Config */
ReadScimConfig: "read:scim_config",
/**
* Create Scim Config */
CreateScimConfig: "create:scim_config",
/**
* Update Scim Config */
UpdateScimConfig: "update:scim_config",
/**
* Delete Scim Config */
DeleteScimConfig: "delete:scim_config",
/**
* Read Scim Token */
ReadScimToken: "read:scim_token",
/**
* Create Scim Token */
CreateScimToken: "create:scim_token",
/**
* Delete Scim Token */
DeleteScimToken: "delete:scim_token",
/**
* Delete Users */
DeleteUsers: "delete:users",
/**
* Read Custom Domains */
ReadCustomDomains: "read:custom_domains",
/**
* Create Custom Domains */
CreateCustomDomains: "create:custom_domains",
/**
* Update Custom Domains */
UpdateCustomDomains: "update:custom_domains",
/**
* Delete Custom Domains */
DeleteCustomDomains: "delete:custom_domains",
/**
* Read Device Credentials */
ReadDeviceCredentials: "read:device_credentials",
/**
* Create Current User Device Credentials */
CreateCurrentUserDeviceCredentials: "create:current_user_device_credentials",
/**
* Delete Device Credentials */
DeleteDeviceCredentials: "delete:device_credentials",
/**
* Delete Current User Device Credentials */
DeleteCurrentUserDeviceCredentials: "delete:current_user_device_credentials",
/**
* Update Device Codes */
UpdateDeviceCodes: "update:device_codes",
/**
* Read Device Codes */
ReadDeviceCodes: "read:device_codes",
/**
* Create Test Email Dispatch */
CreateTestEmailDispatch: "create:test_email_dispatch",
/**
* Create Email Templates */
CreateEmailTemplates: "create:email_templates",
/**
* Read Email Templates */
ReadEmailTemplates: "read:email_templates",
/**
* Update Email Templates */
UpdateEmailTemplates: "update:email_templates",
/**
* Read Email Provider */
ReadEmailProvider: "read:email_provider",
/**
* Create Email Provider */
CreateEmailProvider: "create:email_provider",
/**
* Update Email Provider */
UpdateEmailProvider: "update:email_provider",
/**
* Delete Email Provider */
DeleteEmailProvider: "delete:email_provider",
/**
* Read Entitlements */
ReadEntitlements: "read:entitlements",
/**
* Read Event Streams */
ReadEventStreams: "read:event_streams",
/**
* Create Event Streams */
CreateEventStreams: "create:event_streams",
/**
* Update Event Streams */
UpdateEventStreams: "update:event_streams",
/**
* Delete Event Streams */
DeleteEventStreams: "delete:event_streams",
/**
* Read Event Deliveries */
ReadEventDeliveries: "read:event_deliveries",
/**
* Update Event Deliveries */
UpdateEventDeliveries: "update:event_deliveries",
/**
* Read Events */
ReadEvents: "read:events",
/**
* Read Extensions */
ReadExtensions: "read:extensions",
/**
* Read Flows */
ReadFlows: "read:flows",
/**
* Create Flows */
CreateFlows: "create:flows",
/**
* Read Flows Vault Connections */
ReadFlowsVaultConnections: "read:flows_vault_connections",
/**
* Create Flows Vault Connections */
CreateFlowsVaultConnections: "create:flows_vault_connections",
/**
* Update Flows Vault Connections */
UpdateFlowsVaultConnections: "update:flows_vault_connections",
/**
* Delete Flows Vault Connections */
DeleteFlowsVaultConnections: "delete:flows_vault_connections",
/**
* Read Flows Executions */
ReadFlowsExecutions: "read:flows_executions",
/**
* Delete Flows Executions */
DeleteFlowsExecutions: "delete:flows_executions",
/**
* Update Flows */
UpdateFlows: "update:flows",
/**
* Delete Flows */
DeleteFlows: "delete:flows",
/**
* Read Forms */
ReadForms: "read:forms",
/**
* Create Forms */
CreateForms: "create:forms",
/**
* Update Forms */
UpdateForms: "update:forms",
/**
* Delete Forms */
DeleteForms: "delete:forms",
/**
* Read Grants */
ReadGrants: "read:grants",
/**
* Delete Grants */
DeleteGrants: "delete:grants",
/**
* Read Groups */
ReadGroups: "read:groups",
/**
* Read Group Members */
ReadGroupMembers: "read:group_members",
/**
* Create Guardian Enrollment Tickets */
CreateGuardianEnrollmentTickets: "create:guardian_enrollment_tickets",
/**
* Read Guardian Enrollments */
ReadGuardianEnrollments: "read:guardian_enrollments",
/**
* Delete Guardian Enrollments */
DeleteGuardianEnrollments: "delete:guardian_enrollments",
/**
* Read Guardian Factors */
ReadGuardianFactors: "read:guardian_factors",
/**
* Update Guardian Factors */
UpdateGuardianFactors: "update:guardian_factors",
/**
* Read Mfa Policies */
ReadMfaPolicies: "read:mfa_policies",
/**
* Update Mfa Policies */
UpdateMfaPolicies: "update:mfa_policies",
/**
* Read Hooks */
ReadHooks: "read:hooks",
/**
* Create Hooks */
CreateHooks: "create:hooks",
/**
* Update Hooks */
UpdateHooks: "update:hooks",
/**
* Delete Hooks */
DeleteHooks: "delete:hooks",
/**
* Read Insights */
ReadInsights: "read:insights",
/**
* Read Stats */
ReadStats: "read:stats",
/**
* Read Integrations */
ReadIntegrations: "read:integrations",
/**
* Create Integrations */
CreateIntegrations: "create:integrations",
/**
* Update Integrations */
UpdateIntegrations: "update:integrations",
/**
* Delete Integrations */
DeleteIntegrations: "delete:integrations",
/**
* Create Users */
CreateUsers: "create:users",
/**
* Update Users */
UpdateUsers: "update:users",
/**
* Read Custom Signing Keys */
ReadCustomSigningKeys: "read:custom_signing_keys",
/**
* Create Custom Signing Keys */
CreateCustomSigningKeys: "create:custom_signing_keys",
/**
* Update Custom Signing Keys */
UpdateCustomSigningKeys: "update:custom_signing_keys",
/**
* Delete Custom Signing Keys */
DeleteCustomSigningKeys: "delete:custom_signing_keys",
/**
* Read Encryption Keys */
ReadEncryptionKeys: "read:encryption_keys",
/**
* Create Encryption Keys */
CreateEncryptionKeys: "create:encryption_keys",
/**
* Update Encryption Keys */
UpdateEncryptionKeys: "update:encryption_keys",
/**
* Delete Encryption Keys */
DeleteEncryptionKeys: "delete:encryption_keys",
/**
* Read Signing Keys */
ReadSigningKeys: "read:signing_keys",
/**
* Create Signing Keys */
CreateSigningKeys: "create:signing_keys",
/**
* Update Signing Keys */
UpdateSigningKeys: "update:signing_keys",
/**
* Read Log Streams */
ReadLogStreams: "read:log_streams",
/**
* Create Log Streams */
CreateLogStreams: "create:log_streams",
/**
* Update Log Streams */
UpdateLogStreams: "update:log_streams",
/**
* Delete Log Streams */
DeleteLogStreams: "delete:log_streams",
/**
* Read Logs */
ReadLogs: "read:logs",
/**
* Read Logs Users */
ReadLogsUsers: "read:logs_users",
/**
* Read Tenant Settings */
ReadTenantSettings: "read:tenant_settings",
/**
* Update Tenant Settings */
UpdateTenantSettings: "update:tenant_settings",
/**
* Read Network Acls */
ReadNetworkAcls: "read:network_acls",
/**
* Create Network Acls */
CreateNetworkAcls: "create:network_acls",
/**
* Update Network Acls */
UpdateNetworkAcls: "update:network_acls",
/**
* Delete Network Acls */
DeleteNetworkAcls: "delete:network_acls",
/**
* Read Organizations */
ReadOrganizations: "read:organizations",
/**
* Read Organizations Summary */
ReadOrganizationsSummary: "read:organizations_summary",
/**
* Create Organizations */
CreateOrganizations: "create:organizations",
/**
* Create Organization Connections */
CreateOrganizationConnections: "create:organization_connections",
/**
* Update Organizations */
UpdateOrganizations: "update:organizations",
/**
* Delete Organizations */
DeleteOrganizations: "delete:organizations",
/**
* Create Organization Client Grants */
CreateOrganizationClientGrants: "create:organization_client_grants",
/**
* Delete Organization Client Grants */
DeleteOrganizationClientGrants: "delete:organization_client_grants",
/**
* Read Organization Connections */
ReadOrganizationConnections: "read:organization_connections",
/**
* Update Organization Connections */
UpdateOrganizationConnections: "update:organization_connections",
/**
* Delete Organization Connections */
DeleteOrganizationConnections: "delete:organization_connections",
/**
* Read Organization Discovery Domains */
ReadOrganizationDiscoveryDomains: "read:organization_discovery_domains",
/**
* Create Organization Discovery Domains */
CreateOrganizationDiscoveryDomains: "create:organization_discovery_domains",
/**
* Update Organization Discovery Domains */
UpdateOrganizationDiscoveryDomains: "update:organization_discovery_domains",
/**
* Delete Organization Discovery Domains */
DeleteOrganizationDiscoveryDomains: "delete:organization_discovery_domains",
/**
* Read Organization Invitations */
ReadOrganizationInvitations: "read:organization_invitations",
/**
* Create Organization Invitations */
CreateOrganizationInvitations: "create:organization_invitations",
/**
* Delete Organization Invitations */
DeleteOrganizationInvitations: "delete:organization_invitations",
/**
* Read Organization Members */
ReadOrganizationMembers: "read:organization_members",
/**
* Create Organization Members */
CreateOrganizationMembers: "create:organization_members",
/**
* Delete Organization Members */
DeleteOrganizationMembers: "delete:organization_members",
/**
* Read Organization Member Roles */
ReadOrganizationMemberRoles: "read:organization_member_roles",
/**
* Create Organization Member Roles */
CreateOrganizationMemberRoles: "create:organization_member_roles",
/**
* Delete Organization Member Roles */
DeleteOrganizationMemberRoles: "delete:organization_member_roles",
/**
* Read Prompts */
ReadPrompts: "read:prompts",
/**
* Update Prompts */
UpdatePrompts: "update:prompts",
/**
* Read Resource Servers */
ReadResourceServers: "read:resource_servers",
/**
* Update Resource Servers */
UpdateResourceServers: "update:resource_servers",
/**
* Read Refresh Tokens */
ReadRefreshTokens: "read:refresh_tokens",
/**
* Delete Refresh Tokens */
DeleteRefreshTokens: "delete:refresh_tokens",
/**
* Create Resource Servers */
CreateResourceServers: "create:resource_servers",
/**
* Delete Resource Servers */
DeleteResourceServers: "delete:resource_servers",
/**
* Read Roles */
ReadRoles: "read:roles",
/**
* Create Roles */
CreateRoles: "create:roles",
/**
* Update Roles */
UpdateRoles: "update:roles",
/**
* Delete Roles */
DeleteRoles: "delete:roles",
/**
* Read Role Members */
ReadRoleMembers: "read:role_members",
/**
* Create Role Members */
CreateRoleMembers: "create:role_members",
/**
* Read Rules */
ReadRules: "read:rules",
/**
* Create Rules */
CreateRules: "create:rules",
/**
* Update Rules */
UpdateRules: "update:rules",
/**
* Read Rules Configs */
ReadRulesConfigs: "read:rules_configs",
/**
* Update Rules Configs */
UpdateRulesConfigs: "update:rules_configs",
/**
* Delete Rules Configs */
DeleteRulesConfigs: "delete:rules_configs",
/**
* Delete Rules */
DeleteRules: "delete:rules",
/**
* Read Security Metrics */
ReadSecurityMetrics: "read:security_metrics",
/**
* Read Self Service Profiles */
ReadSelfServiceProfiles: "read:self_service_profiles",
/**
* Create Self Service Profiles */
CreateSelfServiceProfiles: "create:self_service_profiles",
/**
* Update Self Service Profiles */
UpdateSelfServiceProfiles: "update:self_service_profiles",
/**
* Delete Self Service Profiles */
DeleteSelfServiceProfiles: "delete:self_service_profiles",
/**
* Read Self Service Profile Custom Texts */
ReadSelfServiceProfileCustomTexts: "read:self_service_profile_custom_texts",
/**
* Update Self Service Profile Custom Texts */
UpdateSelfServiceProfileCustomTexts: "update:self_service_profile_custom_texts",
/**
* Create Sso Access Tickets */
CreateSsoAccessTickets: "create:sso_access_tickets",
/**
* Delete Sso Access Tickets */
DeleteSsoAccessTickets: "delete:sso_access_tickets",
/**
* Read Sessions */
ReadSessions: "read:sessions",
/**
* Update Sessions */
UpdateSessions: "update:sessions",
/**
* Delete Sessions */
DeleteSessions: "delete:sessions",
/**
* Delete Tenants */
DeleteTenants: "delete:tenants",
/**
* Run Checks */
RunChecks: "run:checks",
/**
* Read Checks */
ReadChecks: "read:checks",
/**
* Read Tenant Feature Flags */
ReadTenantFeatureFlags: "read:tenant_feature_flags",
/**
* Read Tenant Invitations */
ReadTenantInvitations: "read:tenant_invitations",
/**
* Create Tenant Invitations */
CreateTenantInvitations: "create:tenant_invitations",
/**
* Update Tenant Invitations */
UpdateTenantInvitations: "update:tenant_invitations",
/**
* Delete Tenant Invitations */
DeleteTenantInvitations: "delete:tenant_invitations",
/**
* Read Tenant Members */
ReadTenantMembers: "read:tenant_members",
/**
* Update Tenant Members */
UpdateTenantMembers: "update:tenant_members",
/**
* Delete Tenant Members */
DeleteTenantMembers: "delete:tenant_members",
/**
* Read Owners */
ReadOwners: "read:owners",
/**
* Delete Owners */
DeleteOwners: "delete:owners",
/**
* Create User Tickets */
CreateUserTickets: "create:user_tickets",
/**
* Read Token Exchange Profiles */
ReadTokenExchangeProfiles: "read:token_exchange_profiles",
/**
* Create Token Exchange Profiles */
CreateTokenExchangeProfiles: "create:token_exchange_profiles",
/**
* Update Token Exchange Profiles */
UpdateTokenExchangeProfiles: "update:token_exchange_profiles",
/**
* Delete Token Exchange Profiles */
DeleteTokenExchangeProfiles: "delete:token_exchange_profiles",
/**
* Read Entity Counts */
ReadEntityCounts: "read:entity_counts",
/**
* Read User Attribute Profiles */
ReadUserAttributeProfiles: "read:user_attribute_profiles",
/**
* Create User Attribute Profiles */
CreateUserAttributeProfiles: "create:user_attribute_profiles",
/**
* Update User Attribute Profiles */
UpdateUserAttributeProfiles: "update:user_attribute_profiles",
/**
* Delete User Attribute Profiles */
DeleteUserAttributeProfiles: "delete:user_attribute_profiles",
/**
* Read User Idp Tokens */
ReadUserIdpTokens: "read:user_idp_tokens",
/**
* Read Current User */
ReadCurrentUser: "read:current_user",
/**
* Update Users App Metadata */
UpdateUsersAppMetadata: "update:users_app_metadata",
/**
* Update Current User Metadata */
UpdateCurrentUserMetadata: "update:current_user_metadata",
/**
* Delete Current User */
DeleteCurrentUser: "delete:current_user",
/**
* Read User Application Passwords */
ReadUserApplicationPasswords: "read:user_application_passwords",
/**
* Create User Application Passwords */
CreateUserApplicationPasswords: "create:user_application_passwords",
/**
* Delete User Application Passwords */
DeleteUserApplicationPasswords: "delete:user_application_passwords",
/**
* Read Authentication Methods */
ReadAuthenticationMethods: "read:authentication_methods",
/**
* Update Authentication Methods */
UpdateAuthenticationMethods: "update:authentication_methods",
/**
* Create Authentication Methods */
CreateAuthenticationMethods: "create:authentication_methods",
/**
* Delete Authentication Methods */
DeleteAuthenticationMethods: "delete:authentication_methods",
/**
* Read Federated Connections Tokens */
ReadFederatedConnectionsTokens: "read:federated_connections_tokens",
/**
* Delete Federated Connections Tokens */
DeleteFederatedConnectionsTokens: "delete:federated_connections_tokens",
/**
* Update Current User Identities */
UpdateCurrentUserIdentities: "update:current_user_identities",
/**
* Delete Role Members */
DeleteRoleMembers: "delete:role_members",
/**
* Read Vdcs Templates */
ReadVdcsTemplates: "read:vdcs_templates",
/**
* Create Vdcs Templates */
CreateVdcsTemplates: "create:vdcs_templates",
/**
* Update Vdcs Templates */
UpdateVdcsTemplates: "update:vdcs_templates",
/**
* Delete Vdcs Templates */
DeleteVdcsTemplates: "delete:vdcs_templates",
};
/** How the action is being referred to: `action_id` or `action_name`. */
export const ActionBindingRefTypeEnum = {
BindingId: "binding_id",
ActionId: "action_id",
ActionName: "action_name",
};
/** 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 const ActionBindingTypeEnum = {
TriggerBound: "trigger-bound",
EntityBound: "entity-bound",
};
/** The build status of this action. */
export const ActionBuildStatusEnum = {
Pending: "pending",
Building: "building",
Packaged: "packaged",
Built: "built",
Retrying: "retrying",
Failed: "failed",
};
/** The overall status of an execution. */
export const ActionExecutionStatusEnum = {
Unspecified: "unspecified",
Pending: "pending",
Final: "final",
Partial: "partial",
Canceled: "canceled",
Suspended: "suspended",
};
/** The build status of this specific version. */
export const ActionVersionBuildStatusEnum = {
Pending: "pending",
Building: "building",
Packaged: "packaged",
Built: "built",
Retrying: "retrying",
Failed: "failed",
};
/** Static context values */
export const AculContextEnum = {
BrandingSettings: "branding.settings",
BrandingThemesDefault: "branding.themes.default",
ClientLogoUri: "client.logo_uri",
ClientDescription: "client.description",
OrganizationDisplayName: "organization.display_name",
OrganizationBranding: "organization.branding",
ScreenTexts: "screen.texts",
TenantName: "tenant.name",
TenantFriendlyName: "tenant.friendly_name",
TenantLogoUrl: "tenant.logo_url",
TenantEnabledLocales: "tenant.enabled_locales",
UntrustedDataSubmittedFormData: "untrusted_data.submitted_form_data",
UntrustedDataAuthorizationParamsLoginHint: "untrusted_data.authorization_params.login_hint",
UntrustedDataAuthorizationParamsScreenHint: "untrusted_data.authorization_params.screen_hint",
UntrustedDataAuthorizationParamsUiLocales: "untrusted_data.authorization_params.ui_locales",
UserOrganizations: "user.organizations",
TransactionCustomDomainDomain: "transaction.custom_domain.domain",
};
/** Type of match to apply */
export const AculMatchTypeEnum = {
IncludesAny: "includes_any",
ExcludesAny: "excludes_any",
};
/** Rendering mode to filter by */
export const AculRenderingModeEnum = {
Advanced: "advanced",
Standard: "standard",
};
export const AsyncApprovalNotificationsChannelsEnum = {
GuardianPush: "guardian-push",
Email: "email",
};
/** The id of the active provider for the CAPTCHA. */
export const AttackProtectionCaptchaProviderId = {
Arkose: "arkose",
AuthChallenge: "auth_challenge",
FriendlyCaptcha: "friendly_captcha",
Hcaptcha: "hcaptcha",
RecaptchaV2: "recaptcha_v2",
RecaptchaEnterprise: "recaptcha_enterprise",
SimpleCaptcha: "simple_captcha",
};
export const AuthenticationMethodTypeEnum = {
RecoveryCode: "recovery-code",
Totp: "totp",
Push: "push",
Phone: "phone",
Email: "email",
EmailVerification: "email-verification",
WebauthnRoaming: "webauthn-roaming",
WebauthnPlatform: "webauthn-platform",
Guardian: "guardian",
Passkey: "passkey",
Password: "password",
};
export const AuthenticationTypeEnum = {
Phone: "phone",
Email: "email",
Totp: "totp",
};
/** The policy that defines how often to show CAPTCHA */
export const BotDetectionChallengePolicyPasswordFlowEnum = {
Never: "never",
WhenRisky: "when_risky",
Always: "always",
};
/** The policy that defines how often to show CAPTCHA */
export const BotDetectionChallengePolicyPasswordResetFlowEnum = {
Never: "never",
WhenRisky: "when_risky",
Always: "always",
};
/** The policy that defines how often to show CAPTCHA */
export const BotDetectionChallengePolicyPasswordlessFlowEnum = {
Never: "never",
WhenRisky: "when_risky",
Always: "always",
};
/** The level of bot detection sensitivity */
export const BotDetectionLevelEnum = {
Low: "low",
Medium: "medium",
High: "high",
};
/** Buttons style */
export const BrandingThemeBordersButtonsStyleEnum = {
Pill: "pill",
Rounded: "rounded",
Sharp: "sharp",
};
/** Inputs style */
export const BrandingThemeBordersInputsStyleEnum = {
Pill: "pill",
Rounded: "rounded",
Sharp: "sharp",
};
/** Captcha Widget Theme */
export const BrandingThemeColorsCaptchaWidgetThemeEnum = {
Auto: "auto",
Dark: "dark",
Light: "light",
};
/** Links style */
export const BrandingThemeFontLinksStyleEnum = {
Normal: "normal",
Underlined: "underlined",
};
/** Page Layout */
export const BrandingThemePageBackgroundPageLayoutEnum = {
Center: "center",
Left: "left",
Right: "right",
};
/** Header text alignment */
export const BrandingThemeWidgetHeaderTextAlignmentEnum = {
Center: "center",
Left: "left",
Right: "right",
};
/** Logo position */
export const BrandingThemeWidgetLogoPositionEnum = {
Center: "center",
Left: "left",
None: "none",
Right: "right",
};
/** Social buttons layout */
export const BrandingThemeWidgetSocialButtonsLayoutEnum = {
Bottom: "bottom",
Top: "top",
};
export const BreachedPasswordDetectionAdminNotificationFrequencyEnum = {
Immediately: "immediately",
Daily: "daily",
Weekly: "weekly",
Monthly: "monthly",
};
/**
* The subscription level for breached password detection methods. Use "enhanced" to enable Credential Guard.
* Possible values: <code>standard</code>, <code>enhanced</code>.
*/
export const BreachedPasswordDetectionMethodEnum = {
Standard: "standard",
Enhanced: "enhanced",
};
export const BreachedPasswordDetectionPreChangePasswordShieldsEnum = {
Block: "block",
AdminNotification: "admin_notification",
};
export const BreachedPasswordDetectionPreUserRegistrationShieldsEnum = {
Block: "block",
AdminNotification: "admin_notification",
};
export const BreachedPasswordDetectionShieldsEnum = {
Block: "block",
UserNotification: "user_notification",
AdminNotification: "admin_notification",
};
/** The type of application this client represents */
export const ClientAppTypeEnum = {
Native: "native",
Spa: "spa",
RegularWeb: "regular_web",
NonInteractive: "non_interactive",
ResourceServer: "resource_server",
ExpressConfiguration: "express_configuration",
Rms: "rms",
Box: "box",
Cloudbees: "cloudbees",
Concur: "concur",
Dropbox: "dropbox",
Mscrm: "mscrm",
Echosign: "echosign",
Egnyte: "egnyte",
Newrelic: "newrelic",
Office365: "office365",
Salesforce: "salesforce",
Sentry: "sentry",
Sharepoint: "sharepoint",
Slack: "slack",
Springcm: "springcm",
Zendesk: "zendesk",
Zoom: "zoom",
SsoIntegration: "sso_integration",
Oag: "oag",
};
/** Defines the compliance level for this client, which may restrict it's capabilities */
export const ClientComplianceLevelEnum = {
None: "none",
Fapi1AdvPkjPar: "fapi1_adv_pkj_par",
Fapi1AdvMtlsPar: "fapi1_adv_mtls_par",
Fapi2SpPkjMtls: "fapi2_sp_pkj_mtls",
Fapi2SpMtlsMtls: "fapi2_sp_mtls_mtls",
};
/** Algorithm which will be used with the credential. Supported algorithms: RS256,RS384,PS256 */
export const ClientCredentialAlgorithmEnum = {
Rs256: "RS256",
Rs384: "RS384",
Ps256: "PS256",
};
/** The type of credential. */
export const ClientCredentialTypeEnum = {
PublicKey: "public_key",
CertSubjectDn: "cert_subject_dn",
X509Cert: "x509_cert",
};
/** Controls how organizations may be used with this grant */
export const ClientGrantOrganizationNullableUsageEnum = {
Deny: "deny",
Allow: "allow",
Require: "require",
};
/** Defines whether organizations can be used with client credentials exchanges for this grant. */
export const ClientGrantOrganizationUsageEnum = {
Deny: "deny",
Allow: "allow",
Require: "require",
};
/** The type of application access the client grant allows. Use of this field is subject to the applicable Free Trial terms in Okta’s <a href="https://www.okta.com/legal/"> Master Subscription Agreement.</a> */
export const ClientGrantSubjectTypeEnum = {
Client: "client",
User: "user",
};
/** The `selected_initiators` property contains the list of initiators to be enabled for the given application. */
export const ClientOidcBackchannelLogoutInitiatorsEnum = {
RpLogout: "rp-logout",
IdpLogout: "idp-logout",
PasswordChanged: "password-changed",
SessionExpired: "session-expired",
SessionRevoked: "session-revoked",
AccountDeleted: "account-deleted",
EmailIdentifierChanged: "email-identifier-changed",
MfaPhoneUnenrolled: "mfa-phone-unenrolled",
AccountDeactivated: "account-deactivated",
};
/** 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 const ClientOidcBackchannelLogoutInitiatorsModeEnum = {
Custom: "custom",
All: "all",
};
/** 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 const ClientOrganizationDiscoveryEnum = {
Email: "email",
OrganizationName: "organization_name",
};
/** 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 const ClientOrganizationRequireBehaviorEnum = {
NoPrompt: "no_prompt",
PreLoginPrompt: "pre_login_prompt",
PostLoginPrompt: "post_login_prompt",
};
/** 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 const ClientOrganizationRequireBehaviorPatchEnum = {
NoPrompt: "no_prompt",
PreLoginPrompt: "pre_login_prompt",
PostLoginPrompt: "post_login_prompt",
};
/** Defines how to proceed during an authentication transaction with regards an organization. Can be `deny` (default), `allow` or `require`. */
export const ClientOrganizationUsageEnum = {
Deny: "deny",
Allow: "allow",
Require: "require",
};
/** Defines how to proceed during an authentication transaction with regards an organization. Can be `deny` (default), `allow` or `require`. */
export const ClientOrganizationUsagePatchEnum = {
Deny: "deny",
Allow: "allow",
Require: "require",
};
export const ClientSessionTransferAllowedAuthenticationMethodsEnum = {
Cookie: "cookie",
Query: "query",
};
/** 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 'null', device binding is not enforced. Usually configured in the web application. */
export const ClientSessionTransferDeviceBindingEnum = {
Ip: "ip",
Asn: "asn",
None: "none",
};
/** 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 const ClientTokenEndpointAuthMethodEnum = {
None: "none",
ClientSecretPost: "client_secret_post",
ClientSecretBasic: "client_secret_basic",
};
/** 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 const ClientTokenEndpointAuthMethodOrNullEnum = {
None: "none",
ClientSecretPost: "client_secret_post",
ClientSecretBasic: "client_secret_basic",
};
/** PKCE configuration. */
export const ConnectionConnectionSettingsPkceEnum = {
Auto: "auto",
S256: "S256",
Plain: "plain",
Disabled: "disabled",
};
/** Algorithm allowed to verify the ID tokens. */
export const ConnectionIdTokenSignedResponseAlgEnum = {
Rs256: "RS256",
Rs512: "RS512",
Ps256: "PS256",
Es256: "ES256",
};
/** Order of precedence for attribute types */
export const ConnectionIdentifierPrecedenceEnum = {
Email: "email",
PhoneNumber: "phone_number",
Username: "username",
};
/** Identity API version to use */
export const ConnectionIdentityApiEnumAzureAd = {
MicrosoftIdentityPlatformV20: "microsoft-identity-platform-v2.0",
AzureActiveDirectoryV10: "azure-active-directory-v1.0",
};
/** The identity provider identifier for the connection */
export const ConnectionIdentityProviderEnum = {
Ad: "ad",
Adfs: "adfs",
Amazon: "amazon",
Apple: "apple",
Dropbox: "dropbox",
Bitbucket: "bitbucket",
Aol: "aol",
Auth0Oidc: "auth0-oidc",
Auth0: "auth0",
Baidu: "baidu",
Bitly: "bitly",
Box: "box",
Custom: "custom",
Daccount: "daccount",
Dwolla: "dwolla",
Email: "email",
EvernoteSandbox: "evernote-sandbox",
Evernote: "evernote",
Exact: "exact",
Facebook: "facebook",
Fitbit: "fitbit",
Flickr: "flickr",
Github: "github",
GoogleApps: "google-apps",
GoogleOauth2: "google-oauth2",
Instagram: "instagram",
Ip: "ip",
Line: "line",
Linkedin: "linkedin",
Miicard: "miicard",
Oauth1: "oauth1",
Oauth2: "oauth2",
Office365: "office365",
Oidc: "oidc",
Okta: "okta",
Paypal: "paypal",
PaypalSandbox: "paypal-sandbox",
Pingfederate: "pingfederate",
Planningcenter: "planningcenter",
Renren: "renren",
SalesforceCommunity: "salesforce-community",
SalesforceSandbox: "salesforce-sandbox",
Salesforce: "salesforce",
Samlp: "samlp",
Sharepoint: "sharepoint",
Shopify: "shopify",
Shop: "shop",
Sms: "sms",
Soundcloud: "soundcloud",
ThecitySandbox: "thecity-sandbox",
Thecity: "thecity",
Thirtysevensignals: "thirtysevensignals",
Twitter: "twitter",
Untappd: "untappd",
Vkontakte: "vkontakte",
Waad: "waad",
Weibo: "weibo",
Windowslive: "windowslive",
Wordpress: "wordpress",
Yahoo: "yahoo",
Yammer: "yammer",
Yandex: "yandex",
};
/** Signing key use, whether for encryption or signing */
export const ConnectionKeyUseEnum = {
Encryption: "encryption",
Signing: "signing",
};
/** Method used to map incoming claims when strategy=oidc. */
export const ConnectionMappingModeEnumOidc = {
BindAll: "bind_all",
UseMap: "use_map",
};
/** Method used to map incoming claims when strategy=okta. */
export const ConnectionMappingModeEnumOkta = {
BasicProfile: "basic_profile",
UseMap: "use_map",
};
/** Controls the UI used to challenge the user for their passkey. */
export const ConnectionPasskeyChallengeUiEnum = {
Both: "both",
Autofill: "autofill",
Button: "button",
};
/** Password strength level */
export const ConnectionPasswordPolicyEnum = {
None: "none",
Low: "low",
Fair: "fair",
Good: "good",
Excellent: "excellent",
};
/** Indicates if membership should be assigned on login. */
export const ConnectionProfileOrganizationAssignMembershipOnLoginEnum = {
None: "none",
Optional: "optional",
Required: "required",
};
/** Indicates if the organization should be shown as a button. */
export const ConnectionProfileOrganizationShowAsButtonEnum = {
None: "none",
Optional: "optional",
Required: "required",
};
/** 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 const ConnectionSetUserRootAttributesEnum = {
OnEachLogin: "on_each_login",
OnFirstLogin: "on_first_login",
NeverOnLogin: "never_on_login",
};
/** Choose how Auth0 sets the email_verified field in the user profile. */
export const ConnectionShouldTrustEmailVerifiedConnectionEnum = {
NeverSetEmailsAsVerified: "never_set_emails_as_verified",
AlwaysSetEmailsAsVerified: "always_set_emails_as_verified",
};
export const ConnectionStrategyEnum = {
Ad: "ad",
Adfs: "adfs",
Amazon: "amazon",
Apple: "apple",
Dropbox: "dropbox",
Bitbucket: "bitbucket",
Aol: "aol",
Auth0Oidc: "auth0-oidc",
Auth0: "auth0",
Baidu: "baidu",
Bitly: "bitly",
Box: "box",
Custom: "custom",
Daccount: "daccount",
Dwolla: "dwolla",
Email: "email",
EvernoteSandbox: "evernote-sandbox",
Evernote: "evernote",
Exact: "exact",
Facebook: "facebook",
Fitbit: "fitbit",
Flickr: "flickr",
Github: "github",
GoogleApps: "google-apps",
GoogleOauth2: "google-oauth2",
Instagram: "instagram",
Ip: "ip",
Line: "line",
Linkedin: "linkedin",
Miicard: "miicard",
Oauth1: "oauth1",
Oauth2: "oauth2",
Office365: "office365",
Oidc: "oidc",
Okta: "okta",
Paypal: "paypal",
PaypalSandbox: "paypal-sandbox",
Pingfederate: "pingfederate",
Planningcenter: "planningcenter",
Renren: "renren",
SalesforceCommunity: "salesforce-community",
SalesforceSandbox: "salesforce-sandbox",
Salesforce: "salesforce",
Samlp: "samlp",
Sharepoint: "sharepoint",
Shopify: "shopify",
Shop: "shop",
Sms: "sms",
Soundcloud: "soundcloud",
ThecitySandbox: "thecity-sandbox",
Thecity: "thecity",
Thirtysevensignals: "thirtysevensignals",
Twitter: "twitter",
Untappd: "untappd",
Vkontakte: "vkontakte",
Waad: "waad",
Weibo: "weibo",
Windowslive: "windowslive",
Wordpress: "wordpress",
Yahoo: "yahoo",
Yammer: "yammer",
Yandex: "yandex",
Auth0Adldap: "auth0-adldap",
};
/** Requested Client Authentication method for the Token Endpoint. */
export const ConnectionTokenEndpointAuthMethodEnum = {
ClientSecretPost: "client_secret_post",
PrivateKeyJwt: "private_key_jwt",
};
/** Algorithm used to sign client_assertions. */
export const ConnectionTokenEndpointAuthSigningAlgEnum = {
Es256: "ES256",
Ps256: "PS256",
Rs256: "RS256",
Rs512: "RS512",
};
/** Connection type */
export const ConnectionTypeEnumOidc = {
BackChannel: "back_channel",
FrontChannel: "front_channel",
};
export const ConnectionUpstreamAliasEnum = {
AcrValues: "acr_values",
Audience: "audience",
ClientId: "client_id",
Display: "display",
IdTokenHint: "id_token_hint",
LoginHint: "login_hint",
MaxAge: "max_age",
Prompt: "prompt",
Resource: "resource",
ResponseMode: "response_mode",
ResponseType: "response_type",
UiLocales: "ui_locales",
};
/** User ID attribute to use. Only applies when waad_protocol=openid-connect */
export const ConnectionUseridAttributeEnumAzureAd = {
Oid: "oid",
Sub: "sub",
};
/** Available WAAD protocols */
export const ConnectionWaadProtocolEnumAzureAd = {
WsFederation: "ws-federation",
OpenidConnect: "openid-connect",
};
/** Type of the encryption key to be created. */
export const CreateEncryptionKeyType = {
CustomerProvidedRootKey: "customer-provided-root-key",
TenantEncryptionKey: "tenant-encryption-key",
};
export const CreatedAuthenticationMethodTypeEnum = {
Phone: "phone",
Email: "email",
Totp: "totp",
WebauthnRoaming: "webauthn-roaming",
};
export const CreatedUserAuthenticationMethodTypeEnum = {
Phone: "phone",
Email: "email",
Totp: "totp",
WebauthnRoaming: "webauthn-roaming",
Passkey: "passkey",
};
/** The HTTP header to fetch the client's IP address */
export const CustomDomainCustomClientIpHeaderEnum = {
TrueClientIp: "true-client-ip",
CfConnectingIp: "cf-connecting-ip",
XForwardedFor: "x-forwarded-for",
XAzureClientip: "x-azure-clientip",
Empty: "",
};
/** Custom domain provisioning type. Must be `auth0_managed_certs` or `self_managed_certs`. */
export const CustomDomainProvisioningTypeEnum = {
Auth0ManagedCerts: "auth0_managed_certs",
SelfManagedCerts: "self_managed_certs",
};
/** Custom domain configuration status. Can be `failed`, `pending_verification`, or `ready`. */
export const CustomDomainStatusFilterEnum = {
PendingVerification: "pending_verification",
Ready: "ready",
Failed: "failed",
};
/** Custom domain provisioning type. Can be `auth0_managed_certs` or `self_managed_certs`. */
export const CustomDomainTypeEnum = {
Auth0ManagedCerts: "auth0_managed_certs",
SelfManagedCerts: "self_managed_certs",
};
export const CustomProviderDeliveryMethodEnum = {
Text: "text",
Voice: "voice",
};
/** Key algorithm */
export const CustomSigningKeyAlgorithmEnum = {
Rs256: "RS256",
Rs384: "RS384",
Rs512: "RS512",
Es256: "ES256",
Es384: "ES384",
Es512: "ES512",
Ps256: "PS256",
Ps384: "PS384",
Ps512: "PS512",
};
/** Curve */
export const CustomSigningKeyCurveEnum = {
P256: "P-256",
P384: "P-384",
P521: "P-521",
};
/** Key type */
export const CustomSigningKeyTypeEnum = {
Ec: "EC",
Rsa: "RSA",
};
/** 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 const DeviceCredentialTypeEnum = {
PublicKey: "public_key",
RefreshToken: "refresh_token",
RotatingRefreshToken: "rotating_refresh_token",
};
/** The Certificate Authority issued the certificate. */
export const DomainCertificateAuthorityEnum = {
Letsencrypt: "letsencrypt",
Googletrust: "googletrust",
};
/** The provisioning status of the certificate. */
export const DomainCertificateStatusEnum = {
Provisioning: "provisioning",
ProvisioningFailed: "provisioning_failed",
Provisioned: "provisioned",
RenewingFailed: "renewing_failed",
};
/** Domain verification method. */
export const DomainVerificationMethodNameEnum = {
Cname: "cname",
Txt: "txt",
};
/** The DNS record verification status. This field is relevant only for Custom Domains with Auth0-Managed Certificates. */
export const DomainVerificationStatusEnum = {
Verified: "verified",
Pending: "pending",
Failed: "failed",
};
/** Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, `ms365`, or `custom`. */
export const EmailProviderNameEnum = {
Mailgun: "mailgun",
Mandrill: "mandrill",
Sendgrid: "sendgrid",
Ses: "ses",
Sparkpost: "sparkpost",
Smtp: "smtp",
AzureCs: "azure_cs",
Ms365: "ms365",
Custom: "custom",
};
/** 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 const EmailTemplateNameEnum = {
VerifyEmail: "verify_email",
VerifyEmailByCode: "verify_email_by_code",
ResetEmail: "reset_email",
ResetEmailByCode: "reset_email_by_code",
WelcomeEmail: "welcome_email",
BlockedAccount: "blocked_account",
StolenCredentials: "stolen_credentials",
EnrollmentEmail: "enrollment_email",
MfaOobCode: "mfa_oob_code",
UserInvitation: "user_invitation",
ChangePassword: "change_password",
PasswordReset: "password_reset",
AsyncApproval: "async_approval",
};
/** Enum for enabled features. */
export const EnabledFeaturesEnum = {
Scim: "scim",
UniversalLogout: "universal_logout",
};
/** Key state */
export const EncryptionKeyState = {
PreActivation: "pre-activation",
Active: "active",
Deactivated: "deactivated",
Destroyed: "destroyed",
};
/** Key type */
export const EncryptionKeyType = {
CustomerProvidedRootKey: "customer-provided-root-key",
EnvironmentRootKey: "environment-root-key",
TenantMasterKey: "tenant-master-key",
TenantEncryptionKey: "tenant-encryption-key",
};
/** Type of event */
export const EventStreamDeliveryEventTypeEnum = {
UserCreated: "user.created",
UserDeleted: "user.deleted",
UserUpdated: "user.updated",
OrganizationCreated: "organization.created",
OrganizationUpdated: "organization.updated",
OrganizationDeleted: "organization.deleted",
OrganizationMemberAdded: "organization.member.added",
OrganizationMemberDeleted: "organization.member.deleted",
OrganizationMemberRoleAssigned: "organization.member.role.assigned",
OrganizationMemberRoleDeleted: "organization.member.role.deleted",
OrganizationConnectionAdded: "organization.connection.added",
OrganizationConnectionUpdated: "organization.connection.updated",
OrganizationConnectionRemoved: "organization.connection.removed",
GroupCreated: "group.created",
GroupUpdated: "group.updated",
GroupDeleted: "group.deleted",
GroupMemberAdded: "group.member.added",
GroupMemberDeleted: "group.member.deleted",
};
/** AWS Region for EventBridge destination. */
export const EventStreamEventBridgeAwsRegionEnum = {
AfSouth1: "af-south-1",
ApEast1: "ap-east-1",
ApEast2: "ap-east-2",
ApNortheast1: "ap-northeast-1",
ApNortheast2: "ap-northeast-2",
ApNortheast3: "ap-northeast-3",
ApSouth1: "ap-south-1",
ApSouth2: "ap-south-2",
ApSoutheast1: "ap-southeast-1",
ApSoutheast2: "ap-southeast-2",
ApSoutheast3: "ap-southeast-3",
ApSoutheast4: "ap-southeast-4",
ApSoutheast5: "ap-southeast-5",
ApSoutheast6: "ap-southeast-6",
ApSoutheast7: "ap-southeast-7",
CaCentral1: "ca-central-1",
CaWest1: "ca-west-1",
EuCentral1: "eu-central-1",
EuCentral2: "eu-central-2",
EuNorth1: "eu-north-1",
EuSouth1: "eu-south-1",