Skip to content

Commit

Permalink
chore: Fix useSSO link
Browse files Browse the repository at this point in the history
  • Loading branch information
LauraBeatris committed Jan 17, 2025
1 parent 1501602 commit f9621d8
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/references/expo/use-oauth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Clerk's useOAuth() hook is used to create a new OAuth flow.
The `useOAuth()` hook is used to create a new OAuth flow. It can be used in both web and native apps.

> [!WARNING]
> This feature is deprecated. Please use the [`useSSO()`](/docs/references/expo/use-sso.mdx) instead.
> This feature is deprecated. Please use the [`useSSO()`](/docs/references/expo/use-sso) instead.
## Parameters

Expand Down
13 changes: 7 additions & 6 deletions docs/references/expo/use-sso.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@ The `useSSO()` hook is used to create a new SSO flow. It can be used in both web
## Parameters

<Properties>
- `strategy?`
- `strategy`
- <code>[OAuthStrategy](/docs/references/javascript/types/sso#o-auth-strategy) | [EnterpriseSSOStrategy](/docs/references/javascript/types/sso#enterprise-sso-strategy)</code>

- `string`
Select the SSO strategy. The `enterprise_sso` value depends on the object's `identifier` value. Possible `strategy` values are:
- [`OAuthStrategy`](/docs/references/javascript/types/sso#o-auth-strategy): The user will be authenticated with their social sign-in account. [See available social providers](/docs/references/javascript/types/oauth#o-auth-provider).
- [`EnterpriseSSOStrategy`](/docs/references/javascript/types/sso#enterprise-sso-strategy): The user will be authenticated either through SAML, OIDC or EASIE, depending on the configuration of the [enterprise connection](/docs/authentication/enterprise-connections/overview) matching the identifier.
The strategy to use for authentication. The following strategies are supported:

- `oauth_<provider>`: The user will be authenticated with their social sign-in account. [See available social providers](/docs/references/javascript/types/oauth#o-auth-provider).
- `enterprise_sso`: The user will be authenticated either through SAML, EASIE or OIDC, depending on the configuration of the [enterprise connection](/docs/authentication/enterprise-connections/overview) matching the identifier.

---

Expand Down Expand Up @@ -46,7 +47,7 @@ It accepts the following parameters (`StartSSOFlowParams`):
- `unsafeMetadata?`
- [`SignUpUnsafeMetadata`](/docs/references/javascript/types/metadata#sign-up-unsafe-metadata)
Unsafe metadata to be passed to the OAuth provider.
Unsafe metadata to be passed to the SSO provider.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/references/javascript/sign-in/authenticate-with.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ function authenticateWithRedirect(params: AuthenticateWithRedirectParams): Promi

- `oauth_<provider>`: The user will be authenticated with their social sign-in account. [See available social providers](/docs/references/javascript/types/oauth#o-auth-provider).
- `saml`: The user will be authenticated with SAML. **Deprecated in favor of `enterprise_sso`.**
- `enterprise_sso`: The user will be authenticated either through SAML or OIDC, depending on the configuration of the [enterprise connection](/docs/authentication/enterprise-connections/overview) matching the identifier.
- `enterprise_sso`: The user will be authenticated either through SAML, EASIE or OIDC, depending on the configuration of the [enterprise connection](/docs/authentication/enterprise-connections/overview) matching the identifier.

---

Expand Down

0 comments on commit f9621d8

Please sign in to comment.