README.md

@frnd/capacitor-ory-auth

Capacitor plugin for Ory Identity Platform

Install

npm install @frnd/capacitor-ory-auth
npx cap sync

API

• initialize(...)
• session()
• signIn(...)
• verify(...)
• logIn(...)
• logOut()
• Interfaces

initialize(...)

initialize(options?: OryAuthOptions | undefined) => void

Param	Type
options	OryAuthOptions

---

session()

session() => Promise<unknown>

Returns: Promise<unknown>

---

signIn(...)

signIn(options: SignInOptions) => Promise<SignInResult>

Param	Type
options	SignInOptions

Returns: Promise<SignInResult>

---

verify(...)

verify(options: VerifyOptions) => Promise<unknown>

Param	Type
options	VerifyOptions

Returns: Promise<unknown>

---

logIn(...)

logIn(options: LogInOptions) => Promise<unknown>

Param	Type
options	LogInOptions

Returns: Promise<unknown>

---

logOut()

logOut() => Promise<unknown>

Returns: Promise<unknown>

---

Interfaces

OryAuthOptions

Prop	Type
basePath	string
withCredentials	boolean
timeout	number

SignInResult

Prop	Type
verificationFlowId	string

SignInOptions

Prop	Type
password	string
traits	{ email: string; }

VerifyOptions

Prop	Type
id	string
code	string
email	string

LogInOptions

Prop	Type
identifier	string
password	string