ConnectedAccount

Reference for ConnectedAccount types for OAuth connections.

OAuthConnection represents an OAuth connection to an external provider (like Google, GitHub, etc.) that is linked to a user. You can use connected accounts to access the user’s data on those platforms, such as reading Google Drive files or sending emails via Gmail.

For a guide on how to use connected accounts, see the Connected Accounts guide.

On this page:

• Connection
• OAuthConnection

Connection

Basic information about a connected account. This is the base type that OAuthConnection extends.

Table of Contents

Properties

---

OAuthConnection

Extends Connection with methods to retrieve OAuth access tokens. Get it with:

• user.getConnectedAccount({ provider, providerAccountId })
• user.useConnectedAccount({ provider, providerAccountId }) (React hook)
• user.listConnectedAccounts()
• user.useConnectedAccounts() (React hook)
• user.getOrLinkConnectedAccount(provider)
• user.useOrLinkConnectedAccount(provider) (React hook)

Table of Contents

Methods

For practical usage instructions, see the Connected Accounts guide.