README.md

capacitor-okta

Okta plugin

Install

npm install capacitor-okta
npx cap sync

API

• signIn(...)
• signOut()
• register(...)
• recoveryPassword(...)
• enableBiometric()
• disableBiometric()
• resetBiometric()
• getBiometricStatus()
• configure(...)
• addListener('authState', ...)
• Interfaces
• Type Aliases

signIn(...)

signIn(options?: { params?: Record<string, string> | undefined; signInInBrowser?: boolean | undefined; } | undefined) => Promise<void>

Param	Type
options	{ params?: Record<string, string>; signInInBrowser?: boolean; }

---

signOut()

signOut() => Promise<void>

---

register(...)

register(params?: Record<string, string> | undefined) => Promise<void>

Param	Type
params	Record<string, string>

---

recoveryPassword(...)

recoveryPassword(params?: Record<string, string> | undefined) => Promise<void>

Param	Type
params	Record<string, string>

---

enableBiometric()

enableBiometric() => Promise<BiometricState>

Returns: Promise<BiometricState>

---

disableBiometric()

disableBiometric() => Promise<BiometricState>

Returns: Promise<BiometricState>

---

resetBiometric()

resetBiometric() => Promise<BiometricState>

Returns: Promise<BiometricState>

---

getBiometricStatus()

getBiometricStatus() => Promise<BiometricState>

Returns: Promise<BiometricState>

---

configure(...)

configure(config: OktaConfig) => Promise<void>

Param	Type
config	OktaConfig

---

addListener('authState', ...)

addListener(eventName: 'authState', listenerFunc: (data: AuthState) => void) => PluginListenerHandle

Param	Type
eventName	'authState'
listenerFunc	(data: AuthState) => void

Returns: PluginListenerHandle

---

Interfaces

BiometricState

Prop	Type
isBiometricSupported	boolean
isBiometricEnabled	boolean

OktaConfig

Prop	Type
clientId	string
uri	string
scopes	string
endSessionUri	string
redirectUri	string

PluginListenerHandle

Prop	Type
remove	() => Promise<void>

AuthState

Prop	Type
accessToken	string

Type Aliases

Record

Construct a type with a set of properties K of type T

{ [P in K]: T; }

CHANGELOG

• 1.1.0 Capacitor 5
• 1.0.0 ... 1.0.9 Capacitor 4