Skip to main content

SSO Types

The types on this page describe the SSO values accepted by Clerk SDK methods.

Import these types from your SDK's public /types entry point using a type-only import. For example, with the Next.js SDK:

import type {
  OAuthProvider,
  OAuthStrategy,
  CustomOAuthStrategy,
  EnterpriseSSOStrategy,
} from '@clerk/nextjs/types'

See the Clerk types overview for the entry point for each SDK.

OAuthStrategy

A type that represents the OAuth strategy for a given provider.

For example, when creating a SignIn or SignUp, you can pass the strategy option to specify the OAuth strategy to use.

type OAuthStrategy = `oauth_${OAuthProvider}` | CustomOAuthStrategy

OAuthProvider

A type that represents the provider portion of an OAuth strategy. For example, the provider is 'google', while the corresponding OAuthStrategy is 'oauth_google'.

type OAuthProvider =
  | 'facebook'
  | 'google'
  | 'hubspot'
  | 'github'
  | 'tiktok'
  | 'gitlab'
  | 'discord'
  | 'twitter'
  | 'twitch'
  | 'linkedin'
  | 'linkedin_oidc'
  | 'dropbox'
  | 'atlassian'
  | 'bitbucket'
  | 'microsoft'
  | 'notion'
  | 'apple'
  | 'line'
  | 'instagram'
  | 'coinbase'
  | 'spotify'
  | 'xero'
  | 'box'
  | 'slack'
  | 'linear'
  | 'x'
  | 'enstall'
  | 'huggingface'
  | 'vercel'
  | `custom_${string}`

CustomOAuthStrategy

A type that represents a custom OAuth strategy.

type CustomOAuthStrategy = `oauth_custom_${string}`

EnterpriseSSOStrategy

A type that represents an Enterprise SSO strategy.

type EnterpriseSSOStrategy = `enterprise_sso`

Feedback

What did you think of this content?

Last updated on