Skip to main content

Module: Types

Enumerations​

Classes​

Interfaces​

Enumeration Members​

SSOChallenge​

• SSOChallenge: 5

Type Aliases​

Attestation​

Ƭ Attestation: { challenge_type: "nonce" } & NonceAttestation | { challenge_type: "otp" } & OTPAttestation | { challenge_type: "password_reset" } & PasswordResetAttestation | { challenge_type: "password_set" } & PasswordSetAttestation | { challenge_type: "password_verify" } & PasswordVerifyAttestation | { challenge_type: "totp_register" } & TOTPRegisterAttestation | { challenge_type: "totp_verify" } & TOTPVerifyAttestation | { challenge_type: "webauthn_create" } & WebAuthnCreateAttestation | { challenge_type: "webauthn_get" } & WebAuthnGetAttestation

Export

BaseEvent​

Ƭ BaseEvent: Object

Type declaration​

NameType
namestring

BrowserAnalyticsOptions​

Ƭ BrowserAnalyticsOptions: Object

Type declaration​

NameType
sdkSlashID
user?BaseUser

BucketName​

Ƭ BucketName: keyof typeof DefaultBucketName | string

BucketOptions​

Ƭ BucketOptions: Object

Type declaration​

NameType
bucketNameBucketName
userBaseUser

Challenge​

Ƭ Challenge: ProxyChallenge | NonceChallenge | WebAuthnGetChallenge | WebAuthnCreateChallenge | OIDCChallenge | UICustomizationChallenge

ChallengeListInner​

Ƭ ChallengeListInner: { type: "nonce" } & NonceChallenge | { type: "oidc" } & OIDCChallenge | { type: "otp" } & OTPChallenge | { type: "password_reset" } & PasswordResetChallenge | { type: "password_set" } & PasswordSetChallenge | { type: "password_verify" } & PasswordVerifyChallenge | { type: "proxy" } & ProxyChallenge | { type: "saml" } & SAMLChallenge | { type: "totp_register" } & TOTPRegisterChallenge | { type: "totp_verify" } & TOTPVerifyChallenge | { type: "ui_customization" } & UICustomizationChallenge | { type: "webauthn_create" } & WebAuthnCreateChallenge | { type: "webauthn_get" } & WebAuthnGetChallenge

Export

ChallengeProcessorOptions​

Ƭ ChallengeProcessorOptions: Object

Type declaration​

NameTypeDescription
environment?SlashIDEnvironmentThe environment to use for the SlashID API.
fetchApi?Configuration["fetchApi"]HTTP client that implements the Fetch API
origin?stringThe origin of the request. Used to identify the origin of the request when sending requests to the SlashID API. If allowed domains are configured in the SlashID API, the origin must be one of the allowed domains. Otherwise, use the default value as is.

ChallengeSSR​

Ƭ ChallengeSSR: NonceChallenge | ProxyChallenge

ChallengeType​

Ƭ ChallengeType: typeof ChallengeType[keyof typeof ChallengeType]

ClientGeneratedErrorSlug​

Ƭ ClientGeneratedErrorSlug: typeof CLIENT_GENERATED_ERROR_SLUGS[number]

ClientSideErrorEvent​

Ƭ ClientSideErrorEvent: FlowErrorMetadata & { errorText: "client_side_error" }

An unexpected client side error occurred within the SDK, potentially interrupting authentication.

CredentialType​

Ƭ CredentialType: typeof CredentialType[keyof typeof CredentialType]

CustomEnvironment​

Ƭ CustomEnvironment: Object

SlashID custom environment name. Values must be provided for baseURL and sdkURL.

Type declaration​

NameType
baseURLstring
sdkURLstring

ErrorName​

Ƭ ErrorName: typeof ERROR_NAMES[keyof typeof ERROR_NAMES]

EventHandler​

Ƭ EventHandler<T>: (event: T) => void

Type parameters​

NameType
Textends BaseEvent

Type declaration​

▸ (event): void

Parameters​
NameType
eventT
Returns​

void

EventMeta​

Ƭ EventMeta: Object

Type declaration​

NameType
access"private" | "public"
authFlowId?string
recoveryFlowId?string

EventName​

Ƭ EventName: typeof EventName[keyof typeof EventName]

EventPostRequestEventData​

Ƭ EventPostRequestEventData: { event_name: "AuthenticationFailed_v1" } & SDKEventAuthenticationFailedV1 | { event_name: "AuthenticationSucceeded_v1" } & SDKEventAuthenticationSucceededV1 | { event_name: "PersonIdentified_v1" } & SDKEventPersonIdentifiedV1 | { event_name: "PersonLoggedOut_v1" } & SDKEventPersonLoggedOutV1 | { event_name: "SlashIDSDKLoaded_v1" } & SDKEventSlashIDSDKLoadedV1 | { event_name: "VirtualPageLoaded_v1" } & SDKEventVirtualPageLoadedV1

Export

Events​

Ƭ Events: PublicReadEvents & PublicWriteEvents

EventsWithNamesMap​

Ƭ EventsWithNamesMap: { [K in keyof NamesToEventsMap]: Object }

ExportedCredential​

Ƭ ExportedCredential: { type: "password" } & ExportedPasswordCredential | { type: "public-key" } & ExportedPublicKeyCredential | { type: "totp" } & ExportedTOTPCredential

Export

FactorMethod​

Ƭ FactorMethod: typeof FactorMethod[keyof typeof FactorMethod]

FactorMethodValues​

Ƭ FactorMethodValues: `${Exclude<FactorMethod, "api" | "anonymous" | "direct_id" | "impersonate">}`

FactorOptions​

Ƭ FactorOptions: { method: "email_link" } & EmailLinkMethodOptions | { method: "oidc" } & OIDCMethodOptions | { method: "otp_via_email" } & OTPViaEmailMethodOptions | { method: "otp_via_sms" } & OTPViaSMSMethodOptions | { method: "password" } & PasswordMethodOptions | { method: "saml" } & SAMLMethodOptions | { method: "sms_link" } & SMSLinkMethodOptions | { method: "totp" } & TOTPMethodOptions | { method: "webauthn" } & WebAuthnMethodOptions

Export

FactorTypeHelper​

Ƭ FactorTypeHelper<T>: { [K in keyof T]: Object }

Type parameters​

Name
T

FlowCancelled​

Ƭ FlowCancelled: void

This events can be emitted while the flow is processing the challenges to cancel it.

FlowErrorMetadata​

Ƭ FlowErrorMetadata: Object

Type declaration​

NameType
authenticationFactor?Factor
challengeId?string
failureDetail?string
handle?PersonHandle
previousToken?string

GDPRConsentLevel​

Ƭ GDPRConsentLevel: typeof GDPRConsentLevel[keyof typeof GDPRConsentLevel]

GDPRConsentLevels​

Ƭ GDPRConsentLevels: Object

Type declaration​

NameType
consentLevelsGDPRConsentLevel[]

HTTPBody​

Ƭ HTTPBody: Json | FormData | URLSearchParams

HTTPHeaders​

Ƭ HTTPHeaders: Object

Index signature​

▪ [key: string]: string

HTTPMethod​

Ƭ HTTPMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"

HTTPQuery​

Ƭ HTTPQuery: Object

Index signature​

▪ [key: string]: string | number | null | boolean | (string | number | null | boolean)[] | Set<string | number | null | boolean> | HTTPQuery

HTTPRequestInit​

Ƭ HTTPRequestInit: Object

Type declaration​

NameType
body?HTTPBody
credentials?RequestCredentials
headers?HTTPHeaders
methodHTTPMethod

Handler​

Ƭ Handler<T>: (event: T) => void

Type parameters​

NameType
Tunknown

Type declaration​

▸ (event): void

Parameters​
NameType
eventT
Returns​

void

IdFlowFailedEvent​

Ƭ IdFlowFailedEvent: FlowErrorMetadata & { errorText: ClientGeneratedErrorSlug }

IdFlowStartedEvent​

Ƭ IdFlowStartedEvent: Object

Type declaration​

NameType
authenticationFactor?Factor

IdFlowSucceededEvent​

Ƭ IdFlowSucceededEvent: Object

This event is emitted when the .id method resolves successfully.

Type declaration​

NameType
authenticationFactor?Factor
handle?PersonHandle
tokenUserTokenText

IncorrectPasswordSubmittedEvent​

Ƭ IncorrectPasswordSubmittedEvent: FlowErrorMetadata

This event is emitted when the submitted password does not match the password stored for the given handle.

InitOverrideFunction​

Ƭ InitOverrideFunction: (requestContext: { context: RequestOpts ; init: HTTPRequestInit }) => Promise<RequestInit>

Type declaration​

▸ (requestContext): Promise<RequestInit>

Parameters​
NameType
requestContextObject
requestContext.contextRequestOpts
requestContext.initHTTPRequestInit
Returns​

Promise<RequestInit>

InternalEvents​

Ƭ InternalEvents: Object

Type declaration​

NameType
popupFailedPopupFailedEvent

InvalidPasswordSubmittedEvent​

Ƭ InvalidPasswordSubmittedEvent: FlowErrorMetadata & { failedRules: ValidationRule[] }

This event is emitted when the submitted password does not meet the validation rules.

Json​

Ƭ Json: any

JsonArray​

Ƭ JsonArray: JsonValue[] | readonly JsonValue[]

JsonObject​

Ƭ JsonObject: { [Key in string]: JsonValue } & { [Key in string]?: JsonValue }

JsonPrimitive​

Ƭ JsonPrimitive: string | number | boolean | null

JsonValue​

Ƭ JsonValue: JsonPrimitive | JsonObject | JsonArray

LogInWithOAuthParams​

Ƭ LogInWithOAuthParams: Object

Type declaration​

NameType
clientIdstring
redirectUristring

MessageEventPayload​

Ƭ MessageEventPayload: WebAuthnCreateRequestMessage | WebAuthnGetRequestMessage | PingRequestMessage | SSOChallengeMessage | PingRequestMessage

Middleware​

Ƭ Middleware<T>: (event: T, cancel: () => void) => T | void

Type parameters​

NameType
Textends BaseEvent

Type declaration​

▸ (event, cancel): T | void

Parameters​
NameType
eventT
cancel() => void
Returns​

T | void

NamedEvents​

Ƭ NamedEvents: EventsWithNamesMap[keyof EventsWithNamesMap]

NamesToEventsMap​

Ƭ NamesToEventsMap: Events & InternalEvents & PrivateEvents

OAuthFlowFailedEvent​

Ƭ OAuthFlowFailedEvent: Omit<OIDCMethodOptions, "method"> & { reason: typeof OAuthFailureReason[keyof typeof OAuthFailureReason] }

This event is emitted when the OAuthFlow fails with the specified reason

OAuthFlowStartedEvent​

Ƭ OAuthFlowStartedEvent: Omit<OIDCMethodOptions, "method">

This event is emitted once the OAuth flow in the popup UX mode was started

OAuthProvider​

Ƭ OAuthProvider: typeof OAuthProvider[keyof typeof OAuthProvider]

OIDCGroupsOptions​

Ƭ OIDCGroupsOptions: typeof OIDCGroupsOptions[keyof typeof OIDCGroupsOptions]

OIDCUXMode​

Ƭ OIDCUXMode: typeof OIDCUXMode[keyof typeof OIDCUXMode]

OtpCodeSentEvent​

Ƭ OtpCodeSentEvent: void

This event is emitted once the OTP code is sent.

OtpCodeSubmittedEvent​

Ƭ OtpCodeSubmittedEvent: string

This event should be emitted when the end user enters the OTP code they received. Event payload is a string containing the OTP code.

OtpIncorrectCodeSubmittedEvent​

Ƭ OtpIncorrectCodeSubmittedEvent: Object

This event is emitted if the submitted OTP code is incorrect.

Type declaration​

NameType
challengeIdstring
factorFactor

OtpSmsSentEvent​

Ƭ OtpSmsSentEvent: void

This event is emitted once the OTP code is sent via SMS.

Deprecated

please use OtpCodeSentEvent instead.

PasswordResetReadyEvent​

Ƭ PasswordResetReadyEvent: void

This event is emitted once the SDK is ready to accept a new password as part of the password recovery flow.

PasswordSetReadyEvent​

Ƭ PasswordSetReadyEvent: void

This event is emitted once the SDK is ready to accept a new password. It means the handle has been verified.

PasswordSubmittedEvent​

Ƭ PasswordSubmittedEvent: string

This event needs to be emitted when the end user enters their password.

PasswordValidationRuleName​

Ƭ PasswordValidationRuleName: typeof PasswordValidationRuleName[keyof typeof PasswordValidationRuleName]

PasswordVerifyReadyEvent​

Ƭ PasswordVerifyReadyEvent: void

This event is emitted once the SDK is ready to verify an existing password.

PatternMatchType​

Ƭ PatternMatchType: typeof PatternMatchType[keyof typeof PatternMatchType]

PersonIdentifiedEvent​

Ƭ PersonIdentifiedEvent: Object

Type declaration​

NameType
userBaseUser

PersonLoggedOutEvent​

Ƭ PersonLoggedOutEvent: Object

Type declaration​

NameType
tokenUserTokenText

PersonType​

Ƭ PersonType: typeof PersonType[keyof typeof PersonType]

PopupFailedEvent​

Ƭ PopupFailedEvent: Object

This event is emitted when the Popup UX mode fails with the specified reason

Type declaration​

NameType
reasontypeof PopupFailureReason[keyof typeof PopupFailureReason]

PostTokenRevokeSlashIDRequiredConsistencyEnum​

Ƭ PostTokenRevokeSlashIDRequiredConsistencyEnum: typeof PostTokenRevokeSlashIDRequiredConsistencyEnum[keyof typeof PostTokenRevokeSlashIDRequiredConsistencyEnum]

PrivateEvents​

Ƭ PrivateEvents: Object

We don't differentiate between read and write here because there is no clear API boundary for private events.

This event can be fired by any internal slashid source, and may be listened to by any internal slashid source. There is no concept of "them" and "us" here.

The source is never a third party.

Type declaration​

NameType
clientSideErrorClientSideErrorEvent

ProductionEnvironment​

Ƭ ProductionEnvironment: "production"

SlashID production environment name. Uses the following default values:

const baseURL = "https://api.slashid.com" const sdkURL = "https://cdn.slashid.com/sdk.html"

PublicReadEvents​

Ƭ PublicReadEvents: Object

Type declaration​

NameType
idFlowFailedIdFlowFailedEvent
idFlowStartedIdFlowStartedEvent
idFlowSucceededIdFlowSucceededEvent
incorrectPasswordSubmittedIncorrectPasswordSubmittedEvent
invalidPasswordSubmittedInvalidPasswordSubmittedEvent
oauthFlowFailedOAuthFlowFailedEvent
oauthFlowStartedOAuthFlowStartedEvent
otpCodeSentOtpCodeSentEvent
otpIncorrectCodeSubmittedOtpIncorrectCodeSubmittedEvent
otpSmsSentOtpSmsSentEvent
passwordResetReadyPasswordResetReadyEvent
passwordSetReadyPasswordSetReadyEvent
passwordVerifyReadyPasswordVerifyReadyEvent
recoveryFlowFailedRecoveryFlowFailedEvent
recoveryFlowStartedRecoveryFlowStartedEvent
recoveryFlowSucceededRecoveryFlowSucceededEvent
redirectUriDiscoveredRedirectUriDiscoveredEvent
totpCodeRequestedTotpCodeRequested
totpKeyGeneratedTotpKeyGenerated
uiCustomizationReceivedUICustomizationReceivedEvent
userAuthenticatedFromURLUserAuthenticatedFromURLEvent
webAuthnChallengeProcessedWebAuthnChallengeProcessed

PublicWriteEvents​

Ƭ PublicWriteEvents: Object

Type declaration​

NameType
flowCancelledFlowCancelled
otpCodeSubmittedOtpCodeSubmittedEvent
passwordSubmittedPasswordSubmittedEvent

RecoveryFlowFailedEvent​

Ƭ RecoveryFlowFailedEvent: FlowErrorMetadata & { errorText: ClientGeneratedErrorSlug }

RecoveryFlowStartedEvent​

Ƭ RecoveryFlowStartedEvent: Object

Type declaration​

NameType
authenticationFactorFactor
handlePersonHandle

RecoveryFlowSucceededEvent​

Ƭ RecoveryFlowSucceededEvent: Object

Type declaration​

NameType
authenticationFactorFactor
handlePersonHandle

RedirectUriDiscoveredEvent​

Ƭ RedirectUriDiscoveredEvent: Object

Type declaration​

NameType
redirectUristring

RegexValidationRule​

Ƭ RegexValidationRule: Object

Type declaration​

NameType
matchTypeRegexPasswordValidationRule["match_type"]
nameRegexPasswordValidationRule["name"]
regexpRegExp
type"regex"

Region​

Ƭ Region: typeof Region[keyof typeof Region]

SSOChallengeMessage​

Ƭ SSOChallengeMessage: Object

Type declaration​

NameType
typeSSOChallenge
urlParamsstring

SSOChallengeParams​

Ƭ SSOChallengeParams: Object

Type declaration​

NameType
csrfTokenstring
ssoChallengeIDstring
ssoCodestring

SSOUXMode​

Ƭ SSOUXMode: typeof SSOUXMode[keyof typeof SSOUXMode]

SandboxEnvironment​

Ƭ SandboxEnvironment: "sandbox"

SlashID sandbox environment name. Uses the following default values:

const baseURL = "https://api.sandbox.slashid.com" const sdkURL = "https://cdn.sandbox.slashid.com/sdk.html"

SlashIDConfig​

Ƭ SlashIDConfig: Object

Configuration options for the SlashID SDK. Same as SlashIDOptions, but with all required options set. Does not inherit the same set of fields as SlashIDOptions because some of them are going to be removed in the next major version.

Type declaration​

NameType
analyticsEnabledboolean
baseURLstring
identityProviderInitiatedSSOEnabledboolean
oid?string
sdkURLstring

SlashIDEnvironment​

Ƭ SlashIDEnvironment: ProductionEnvironment | SandboxEnvironment | CustomEnvironment

SlashIDErrorContext​

Ƭ SlashIDErrorContext: Record<string, any> & { response?: SerialisedResponseError }

SlashIDErrorInput​

Ƭ SlashIDErrorInput: SlashIDInternalErrorInput & { name: SlashIDError["name"] }

SlashIDInternalErrorInput​

Ƭ SlashIDInternalErrorInput: Object

Type declaration​

NameType
cause?Error
context?SlashIDErrorContext
messagestring
nameErrorName

TotpCodeRequested​

Ƭ TotpCodeRequested: void

This event is emitted once the SDK is ready to verify a TOTP code.

TotpKeyGenerated​

Ƭ TotpKeyGenerated: Object

This event is emitted once the SDK is ready to register new TOTP credential.

Type declaration​

NameType
qrCodestring
recoveryCodesstring[]
uristring

UICustomization​

Ƭ UICustomization: Object

Index signature​

▪ [key: string]: any

UICustomizationReceivedEvent​

Ƭ UICustomizationReceivedEvent: Object

Type declaration​

NameType
customizationPropertiesUICustomization

UserAuthenticatedFromURLEvent​

Ƭ UserAuthenticatedFromURLEvent: Object

Type declaration​

NameType
tokenstring

UserTokenText​

Ƭ UserTokenText: string

ValidateTokenResponseInvalidityReasonEnum​

Ƭ ValidateTokenResponseInvalidityReasonEnum: typeof ValidateTokenResponseInvalidityReasonEnum[keyof typeof ValidateTokenResponseInvalidityReasonEnum]

ValidationRule​

Ƭ ValidationRule: RegexValidationRule

WebAuthnAttestation​

Ƭ WebAuthnAttestation: typeof WebAuthnAttestation[keyof typeof WebAuthnAttestation]

WebAuthnChallengeProcessed​

Ƭ WebAuthnChallengeProcessed: Object

Type declaration​

NameType
credentialIdstring

WebAuthnResidentKey​

Ƭ WebAuthnResidentKey: typeof WebAuthnResidentKey[keyof typeof WebAuthnResidentKey]

WebAuthnUserVerification​

Ƭ WebAuthnUserVerification: typeof WebAuthnUserVerification[keyof typeof WebAuthnUserVerification]

Variables​

ChallengeType​

• Const ChallengeType: Object

Export

Type declaration​

NameType
Nonce"nonce"
Oidc"oidc"
Otp"otp"
PasswordReset"password_reset"
PasswordSet"password_set"
PasswordVerify"password_verify"
Proxy"proxy"
Saml"saml"
TotpRegister"totp_register"
TotpVerify"totp_verify"
UiCustomization"ui_customization"
WebauthnCreate"webauthn_create"
WebauthnGet"webauthn_get"

CredentialType​

• Const CredentialType: Object

The type of the credential

Export

Type declaration​

NameType
Password"password"
PublicKey"public-key"
Totp"totp"

DefaultBucketName​

• Const DefaultBucketName: Object

Type declaration​

NameType
end_user_no_access"end_user_no_access"
end_user_read_only"end_user_read_only"
end_user_read_write"end_user_read_write"
person_pool-end_user_no_access"person_pool-end_user_no_access"
person_pool-end_user_read_only"person_pool-end_user_read_only"
person_pool-end_user_read_write"person_pool-end_user_read_write"

ERROR_NAMES​

• Const ERROR_NAMES: Object

Type declaration​

NameType
apiResponseError"APIResponseError"
badPasskeyScopeError"BadPasskeyScopeError"
flowCancelled"FlowCancelledError"
handlePatternNotAllowed"HandlePatternNotAllowedError"
invalidActionError"InvalidActionError"
invalidAuthenticationMethodError"InvalidAuthenticationMethodError"
invalidEmailAddressFormatError"InvalidEmailAddressFormatError"
invalidPhoneNumberFormatError"InvalidPhoneNumberFormatError"
invalidSlashIDConfigurationError"InvalidSlashIDConfigurationError"
invalidSlashIDURLParamsError"InvalidSlashIDURLParamsError"
noPasswordSet"noPasswordSet"
passkeyPromptError"PasskeyPromptError"
personExistsError"PersonExistsError"
rateLimitError"RateLimitError"
recoverNonReachableHandleType"recoverNonReachableHandleType"
selfRegistrationNotAllowed"SelfRegistrationNotAllowed"
signInAwaitingApproval"SignInAwaitingApprovalError"
signUpAwaitingApproval"SignUpAwaitingApprovalError"
timeoutError"TimeoutError"
unknown"UnexpectedError"

EventName​

• Const EventName: Object

Export

Type declaration​

NameType
AnonymousPersonCreatedV1"AnonymousPersonCreated_v1"
AnonymousTokenMintedV1"AnonymousTokenMinted_v1"
AuthenticationFailedV1"AuthenticationFailed_v1"
AuthenticationSucceededV1"AuthenticationSucceeded_v1"
GateRequestCredentialFoundV1"GateRequestCredentialFound_v1"
GateRequestHandledV1"GateRequestHandled_v1"
GateServerStartedV1"GateServerStarted_v1"
GdprConsentsChangedV1"GdprConsentsChanged_v1"
MitmAttackDetectedV1"MitmAttackDetected_v1"
PasswordChangedV1"PasswordChanged_v1"
PermissionCreatedInRegionV1"PermissionCreated_InRegion_v1"
PermissionCreatedV1"PermissionCreated_v1"
PermissionDeletedInRegionV1"PermissionDeleted_InRegion_v1"
PermissionDeletedV1"PermissionDeleted_v1"
PermissionUpdatedInRegionV1"PermissionUpdated_InRegion_v1"
PermissionUpdatedV1"PermissionUpdated_v1"
PermissionsSetToPersonInRegionV1"PermissionsSetToPerson_InRegion_v1"
PermissionsSetToPersonV1"PermissionsSetToPerson_v1"
PersonCreatedV1"PersonCreated_v1"
PersonDeletedV1"PersonDeleted_v1"
PersonIdentifiedV1"PersonIdentified_v1"
PersonLoggedOutV1"PersonLoggedOut_v1"
RoleCreatedInRegionV1"RoleCreated_InRegion_v1"
RoleCreatedV1"RoleCreated_v1"
RoleDeletedInRegionV1"RoleDeleted_InRegion_v1"
RoleDeletedV1"RoleDeleted_v1"
RoleUpdatedInRegionV1"RoleUpdated_InRegion_v1"
RoleUpdatedV1"RoleUpdated_v1"
RolesSetToPersonInRegionV1"RolesSetToPerson_InRegion_v1"
RolesSetToPersonV1"RolesSetToPerson_v1"
SlashIdsdkLoadedV1"SlashIDSDKLoaded_v1"
TokenMintedV1"TokenMinted_v1"
VirtualPageLoadedV1"VirtualPageLoaded_v1"

FactorMethod​

• Const FactorMethod: Object

Allowed login factor

Export

Type declaration​

NameType
Anonymous"anonymous"
Api"api"
DirectId"direct_id"
EmailLink"email_link"
Impersonate"impersonate"
Oidc"oidc"
OtpViaEmail"otp_via_email"
OtpViaSms"otp_via_sms"
Password"password"
Saml"saml"
SmsLink"sms_link"
Totp"totp"
Webauthn"webauthn"

GDPRConsentLevel​

• Const GDPRConsentLevel: Object

Export

Type declaration​

NameType
Analytics"analytics"
Marketing"marketing"
Necessary"necessary"
None"none"
Retargeting"retargeting"
Tracking"tracking"

OAuthFailureReason​

• Const OAuthFailureReason: Object

Type declaration​

NameType
BadOAuthURL"Bad OAuth sign in URL"
PopupBlocked"Popup blocked"

OAuthProvider​

• Const OAuthProvider: Object

Export

Type declaration​

NameType
Apple"apple"
Azuread"azuread"
Bitbucket"bitbucket"
Facebook"facebook"
Github"github"
Gitlab"gitlab"
Google"google"
Line"line"
Okta"okta"

OIDCGroupsOptions​

• Const OIDCGroupsOptions: Object

Determines whether the OIDC call should fetch groups data.

Export

Type declaration​

NameType
False"false"
True"true"

OIDCUXMode​

• Const OIDCUXMode: Object

Determines how the OIDC login page is presented to the user; defaults to popup.

Export

Type declaration​

NameType
Popup"popup"
Redirect"redirect"

PasswordValidationRuleName​

• Const PasswordValidationRuleName: Object

Export

Type declaration​

NameType
AdminVariants"admin_variants"
AlphanumericSequences1"alphanumeric_sequences_1"
AlphanumericSequences2"alphanumeric_sequences_2"
CommonPasswordXkcd"common_password_xkcd"
Length"length"
NumericSequencesAscending"numeric_sequences_ascending"
NumericSequencesDescending"numeric_sequences_descending"
NumericSubsequencesAscending"numeric_subsequences_ascending"
NumericSubsequencesDescending"numeric_subsequences_descending"
PasswordVariants"password_variants"
UserVariants"user_variants"

PatternMatchType​

• Const PatternMatchType: Object

Export

Type declaration​

NameType
Match"must_match"
NotMatch"must_not_match"

PersonType​

• Const PersonType: Object

Export

Type declaration​

NameType
Anonymous"anonymous"
Regular"regular"

PopupFailureReason​

• Const PopupFailureReason: Object

Type declaration​

NameType
BadAuthURL"Bad authentication URL"
PopupBlocked"Popup blocked"

PostTokenRevokeSlashIDRequiredConsistencyEnum​

• Const PostTokenRevokeSlashIDRequiredConsistencyEnum: Object

Export

Type declaration​

NameType
AllRegions"all_regions"
LocalRegion"local_region"

Region​

• Const Region: Object

Export

Type declaration​

NameType
AsiaJapan"asia-japan"
AustraliaSydney"australia-sydney"
EuropeBelgium"europe-belgium"
EuropeEngland"europe-england"
UsIowa"us-iowa"

SSOUXMode​

• Const SSOUXMode: Object

Determines how the SSO login page is presented to the user; defaults to popup.

Export

Type declaration​

NameType
Popup"popup"
Redirect"redirect"

ValidateTokenResponseInvalidityReasonEnum​

• Const ValidateTokenResponseInvalidityReasonEnum: Object

Export

Type declaration​

NameType
Expired"expired"
InvalidIssuer"invalid_issuer"
InvalidTokenContent"invalid_token_content"
NotEnoughFactors"not_enough_factors"
PersonNotActive"person_not_active"

WebAuthnAttestation​

• Const WebAuthnAttestation: Object

Export

Type declaration​

NameType
Direct"direct"
Indirect"indirect"
None"none"

WebAuthnResidentKey​

• Const WebAuthnResidentKey: Object

Export

Type declaration​

NameType
Discouraged"discouraged"
Preferred"preferred"
Required"required"

WebAuthnUserVerification​

• Const WebAuthnUserVerification: Object

Export

Type declaration​

NameType
Discouraged"discouraged"
Preferred"preferred"
Required"required"