Skip to main content

Module: Types

Enumerations​

Classes​

Interfaces​

Type Aliases​

AnalyticsOptions​

Ƭ AnalyticsOptions: 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

ChallengeListInner​

Ƭ ChallengeListInner: { type: "nonce" } & NonceChallenge | { type: "oidc" } & OIDCChallenge | { type: "otp" } & OTPChallenge | { type: "proxy" } & ProxyChallenge | { type: "webauthn_create" } & WebAuthnCreateChallenge | { type: "webauthn_get" } & WebAuthnGetChallenge

Export

ChallengeType​

Ƭ ChallengeType: typeof ChallengeType[keyof typeof ChallengeType]

EventName​

Ƭ EventName: typeof EventName[keyof typeof EventName]

EventPostRequestEventData​

Ƭ EventPostRequestEventData: { event_name: "AuthenticationFailed_v1" } & SDKEventAuthenticationFailedV1 | { event_name: "AuthenticationSucceeded_v1" } & SDKEventAuthenticationSucceededV1 | { event_name: "VirtualPageLoaded_v1" } & SDKEventVirtualPageLoadedV1

Export

Events​

Ƭ Events: PublicReadEvents & PublicWriteEvents

FactorMethod​

Ƭ FactorMethod: typeof FactorMethod[keyof typeof FactorMethod]

FactorMethodValues​

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

FactorOptions​

Ƭ FactorOptions: OIDCMethodOptions | WebAuthnMethodOptions

Export

FactorTypeHelper​

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

Type parameters​

Name
T

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>: MittHandler<T>

Type parameters​

Name
T

IdFlowFailedEvent​

Ƭ IdFlowFailedEvent: Object

Type declaration​

NameType
authenticationFactor?Factor
errorTextstring
previousToken?UserTokenText

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

InitOverrideFunction​

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

Type declaration​

▸ (requestContext): Promise<RequestInit>

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

Promise<RequestInit>

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

OAuthFlowFailedEvent​

Ƭ OAuthFlowFailedEvent: OIDCMethodOptions & { reason: typeof OAuthFailureReason[keyof typeof OAuthFailureReason] }

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

OAuthFlowStartedEvent​

Ƭ OAuthFlowStartedEvent: OIDCMethodOptions

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]

OIDCWithExtras​

Ƭ OIDCWithExtras: Object

Type declaration​

NameType
extras{ popup?: Window ; setPopupUrl?: (url: string) => Window | null }
extras.popup?Window
extras.setPopupUrl?(url: string) => Window | null
method"oidc"
optionsOIDCMethodOptions

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: void

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

OtpSmsSentEvent​

Ƭ OtpSmsSentEvent: void

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

Deprecated

please use OtpCodeSentEvent instead.

PostAttestationRequest​

Ƭ PostAttestationRequest: { challenge_type: "nonce" } & NonceAttestation | { challenge_type: "otp" } & OTPAttestation | { challenge_type: "webauthn_create" } & WebAuthnCreateAttestation | { challenge_type: "webauthn_get" } & WebAuthnGetAttestation

Export

PublicReadEvents​

Ƭ PublicReadEvents: Object

Type declaration​

NameType
idFlowFailedIdFlowFailedEvent
idFlowStartedIdFlowStartedEvent
idFlowSucceededIdFlowSucceededEvent
oauthFlowFailedOAuthFlowFailedEvent
oauthFlowStartedOAuthFlowStartedEvent
otpCodeSentOtpCodeSentEvent
otpIncorrectCodeSubmittedOtpIncorrectCodeSubmittedEvent
otpSmsSentOtpSmsSentEvent
userAuthenticatedFromURLUserAuthenticatedFromURLEvent
webAuthnChallengeProcessedWebAuthnChallengeProcessed

PublicWriteEvents​

Ƭ PublicWriteEvents: Object

Type declaration​

NameType
otpCodeSubmittedOtpCodeSubmittedEvent

SlashIDEmitter​

Ƭ SlashIDEmitter: Emitter<Events>

UserAuthenticatedFromURLEvent​

Ƭ UserAuthenticatedFromURLEvent: Object

Type declaration​

NameType
tokenstring

UserTokenText​

Ƭ UserTokenText: string

ValidateTokenResponseInvalidityReasonEnum​

Ƭ ValidateTokenResponseInvalidityReasonEnum: typeof ValidateTokenResponseInvalidityReasonEnum[keyof typeof ValidateTokenResponseInvalidityReasonEnum]

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"
Proxy"proxy"
WebauthnCreate"webauthn_create"
WebauthnGet"webauthn_get"

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"

EventName​

• Const EventName: Object

Export

Type declaration​

NameType
AuthenticationFailedV1"AuthenticationFailed_v1"
AuthenticationSucceededV1"AuthenticationSucceeded_v1"
PersonCreatedV1"PersonCreated_v1"
PersonDeletedV1"PersonDeleted_v1"
VirtualPageLoadedV1"VirtualPageLoaded_v1"

FactorMethod​

• Const FactorMethod: Object

Allowed login factor

Export

Type declaration​

NameType
Api"api"
DirectId"direct_id"
EmailLink"email_link"
Oidc"oidc"
OtpViaEmail"otp_via_email"
OtpViaSms"otp_via_sms"
SmsLink"sms_link"
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
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"

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"