Skip to content

Commit

Permalink
Merge branch 'main' into nick/sidebar-reorganization
Browse files Browse the repository at this point in the history
  • Loading branch information
NWylynko committed Jan 15, 2025
2 parents 3077fec + d48f66d commit fab59eb
Show file tree
Hide file tree
Showing 20 changed files with 66 additions and 65 deletions.
2 changes: 1 addition & 1 deletion docs/authentication/enterprise-connections/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The following IdPs are supported: Google Workspace and Microsoft Entra ID. For _

Clerk prevents users linked to deprovisioned accounts in the OpenID provider from accessing the app.

Within 10 minutes of a user being removed from the OpenID provider (e.g. [suspendeded](https://support.google.com/a/answer/33312?hl=en) or [deleted](https://support.google.com/a/answer/33314?hl=en) via Google Workspace, or [deleted](https://learn.microsoft.com/en-us/entra/fundamentals/how-to-create-delete-users#delete-a-user) via Microsoft Entra), Clerk will recognize that the user has been deprovisioned and will revoke that user's existing sessions.
Before creating a new session token for an EASIE user, Clerk verifies whether the user has been deprovisioned from their OpenID provider (e.g., [suspended](https://support.google.com/a/answer/33312?hl=en) or [deleted](https://support.google.com/a/answer/33314?hl=en) in Google Workspace, or [deleted](https://learn.microsoft.com/en-us/entra/fundamentals/how-to-create-delete-users#delete-a-user) in Microsoft Entra). This verification process might involve a delay of up to 10 minutes. If deprovisioning is detected, Clerk revokes that user's existing sessions and responds to any requests for a new session token with a `401 Unauthorized` error.

It is ultimately the app's responsibility to handle this unauthenticated state and display something appropriate to the user. For example, Next.js apps using [`auth.protect()`](/docs/references/nextjs/auth#auth-protect) will automatically redirect the user to the sign-in page.

Expand Down
4 changes: 3 additions & 1 deletion docs/authentication/social-connections/hubspot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,15 @@ To make the setup process easier, it's recommended to keep two browser tabs open
1. In the **App Info** tab, complete the form. The **Public app name** is required.
1. Select the **Auth** tab.
1. In the **Redirect URLs** section, paste the **Redirect URI** value you saved from the Clerk Dashboard.
1. In the **Scopes** section, select **Add new scope**.
1. Enable the **crm.objects.owners.read** scope and select **Update**.
1. Select **Create app**. You'll be redirected back to the **App Info** tab.
1. Select the **Auth** tab.
1. Save the **Client ID** and **Client Secret** values somewhere secure.

### Set the Client ID and Client Secret in the Clerk Dashboard

<Include src="_partials/authentication/set-client-id-and-client-secret" />
<Include src="_partials/authentication/set-client-id-secret" />

### Test your connection

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/xero.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open

### Set the Client ID and Client Secret in the Clerk Dashboard

<Include src="_partials/authentication/set-client-id-and-client-secret" />
<Include src="_partials/authentication/set-client-id-secret" />

### Test your connection

Expand Down
7 changes: 3 additions & 4 deletions docs/components/authentication/sign-in.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ All props are optional.
- `routing`
- `'hash' | 'path' | 'virtual'`

The routing strategy for your pages.<br />Defaults to `'path'` in Next.js and Remix applications. Defaults to `hash` for all other SDK's.
The [routing](/docs/how-clerk-works/routing) strategy for your pages.<br />Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React.

---

Expand Down Expand Up @@ -127,7 +127,7 @@ The following example includes basic implementation of the `<SignIn />` componen
```jsx {{ filename: '/src/sign-in/[[...index]].tsx' }}
import { SignIn } from '@clerk/clerk-react'

const SignInPage = () => <SignIn path="/sign-in" />
const SignInPage = () => <SignIn />

export default SignInPage
```
Expand All @@ -140,7 +140,6 @@ The following example includes basic implementation of the `<SignIn />` componen
export default function SignInPage() {
return (
<div style={{ border: '2px solid blue', padding: '2rem' }}>
<h1>Sign In route</h1>
<SignIn />
</div>
)
Expand All @@ -154,7 +153,7 @@ The following example includes basic implementation of the `<SignIn />` componen
import { SignIn } from '@clerk/astro/components'
---
<SignIn path="/sign-in" />
<SignIn />
```
</Tab>

Expand Down
7 changes: 3 additions & 4 deletions docs/components/authentication/sign-up.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ All props are optional.
- `routing`
- `'hash' | 'path' | 'virtual'`

The routing strategy for your pages. <br />Defaults to `'path'` in Next.js and Remix applications. Defaults to `hash` for all other SDK's.
The [routing](/docs/how-clerk-works/routing) strategy for your pages. <br />Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React.

---

Expand Down Expand Up @@ -120,7 +120,7 @@ The following example includes basic implementation of the `<SignUp />` componen
```jsx {{ filename: '/src/sign-up/[[...index]].tsx' }}
import { SignUp } from '@clerk/clerk-react'

const SignUpPage = () => <SignUp path="/sign-up" />
const SignUpPage = () => <SignUp />

export default SignUpPage
```
Expand All @@ -133,7 +133,6 @@ The following example includes basic implementation of the `<SignUp />` componen
export default function SignUpPage() {
return (
<div style={{ border: '2px solid blue', padding: '2rem' }}>
<h1>Sign Up route</h1>
<SignUp />
</div>
)
Expand All @@ -147,7 +146,7 @@ The following example includes basic implementation of the `<SignUp />` componen
import { SignUp } from '@clerk/astro/components'
---
<SignUp path="/sign-up" />
<SignUp />
```
</Tab>

Expand Down
11 changes: 7 additions & 4 deletions docs/components/control/redirect-to-createorganization.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: '`<RedirectToCreateOrganization />`'
title: '`<RedirectToCreateOrganization />` (Deprecated)'
description: The <RedirectToCreateOrganization /> component will navigate to the user profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
---

> [!WARNING]
> This feature is deprecated. Please use the [`redirectToCreateOrganization()` method](/docs/references/javascript/clerk/redirect-methods#redirect-to-create-organization) instead.
The `<RedirectToCreateOrganization />` component will navigate to the create organization flow which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.

## Usage
Expand All @@ -19,7 +22,7 @@ The `<RedirectToCreateOrganization />` component will navigate to the create org
<SignedIn>
<RedirectToCreateOrganization />
</SignedIn>
<SignedOut>Sign In</SignedOut>
<SignedOut>You need to sign in to create an organization.</SignedOut>
</ClerkProvider>
)
}
Expand All @@ -43,7 +46,7 @@ The `<RedirectToCreateOrganization />` component will navigate to the create org
<SignedIn>
<RedirectToCreateOrganization />
</SignedIn>
<SignedOut>Sign In</SignedOut>
<SignedOut>You need to sign in to create an organization.</SignedOut>
</ClerkProvider>
)
}
Expand All @@ -61,7 +64,7 @@ The `<RedirectToCreateOrganization />` component will navigate to the create org
<RedirectToCreateOrganization />
</SignedIn>
<SignedOut>
<p>Sign in </p>
<p>You need to sign in to create an organization.</p>
</SignedOut>
</div>
)
Expand Down
11 changes: 7 additions & 4 deletions docs/components/control/redirect-to-organizationprofile.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: <code>\<RedirectTo<wbr />OrganizationProfile /></code>
title: '`<RedirectToOrganizationProfile />` (Deprecated)'
description: The <RedirectToOrganizationProfile /> component will navigate to the organization profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
---

> [!WARNING]
> This feature is deprecated. Please use the [`redirectToOrganizationProfile()` method](/docs/references/javascript/clerk/redirect-methods#redirect-to-organization-profile) instead.
The `<RedirectToOrganizationProfile />` component will navigate to the organization profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.

## Usage
Expand All @@ -19,7 +22,7 @@ The `<RedirectToOrganizationProfile />` component will navigate to the organizat
<SignedIn>
<RedirectToOrganizationProfile />
</SignedIn>
<SignedOut>Sign In</SignedOut>
<SignedOut>You need to sign in to view your organization profile.</SignedOut>
</ClerkProvider>
)
}
Expand All @@ -43,7 +46,7 @@ The `<RedirectToOrganizationProfile />` component will navigate to the organizat
<SignedIn>
<RedirectToOrganizationProfile />
</SignedIn>
<SignedOut>Sign In</SignedOut>
<SignedOut>You need to sign in to view your organization profile.</SignedOut>
</ClerkProvider>
)
}
Expand All @@ -61,7 +64,7 @@ The `<RedirectToOrganizationProfile />` component will navigate to the organizat
<RedirectToOrganizationProfile />
</SignedIn>
<SignedOut>
<p>Sign in </p>
<p>You need to sign in to view your organization profile.</p>
</SignedOut>
</div>
)
Expand Down
11 changes: 7 additions & 4 deletions docs/components/control/redirect-to-userprofile.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: '`<RedirectToUserProfile />`'
title: '`<RedirectToUserProfile />` (Deprecated)'
description: The <RedirectToUserProfile /> component will navigate to the user profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
---

> [!WARNING]
> This feature is deprecated. Please use the [`redirectToUserProfile()` method](/docs/references/javascript/clerk/redirect-methods#redirect-to-user-profile) instead.
The `<RedirectToUserProfile />` component will navigate to the Account Portal User Profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.

To find your User Profile URL:
Expand All @@ -24,7 +27,7 @@ To find your User Profile URL:
<SignedIn>
<RedirectToUserProfile />
</SignedIn>
<SignedOut>Sign In</SignedOut>
<SignedOut>You need to sign in to view your user profile.</SignedOut>
</ClerkProvider>
)
}
Expand All @@ -43,7 +46,7 @@ To find your User Profile URL:
<SignedIn>
<RedirectToUserProfile />
</SignedIn>
<SignedOut>Sign In</SignedOut>
<SignedOut>You need to sign in to view your user profile.</SignedOut>
</ClerkProvider>
)
}
Expand All @@ -61,7 +64,7 @@ To find your User Profile URL:
<RedirectToUserProfile />
</SignedIn>
<SignedOut>
<p>Sign in </p>
<p>You need to sign in to view your user profile.</p>
</SignedOut>
</div>
)
Expand Down
6 changes: 3 additions & 3 deletions docs/components/organization/create-organization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ All props are optional.
- `routing`
- `'hash' | 'path' | 'virtual'`

The routing strategy for your pages. <br />Defaults to `'path'` in Next.js and Remix applications. Defaults to `hash` for all other SDK's.
The [routing](/docs/how-clerk-works/routing) strategy for your pages. <br />Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React.

---

Expand Down Expand Up @@ -80,7 +80,7 @@ The following example includes a basic implementation of the `<CreateOrganizatio
import { CreateOrganization } from '@clerk/clerk-react'

export default function CreateOrganizationPage() {
return <CreateOrganization path="/create-organization" />
return <CreateOrganization />
}
```
</Tab>
Expand All @@ -101,7 +101,7 @@ The following example includes a basic implementation of the `<CreateOrganizatio
import { CreateOrganization } from '@clerk/astro/components'
---
<CreateOrganization path="/create-organization" />
<CreateOrganization />
```
</Tab>

Expand Down
6 changes: 3 additions & 3 deletions docs/components/organization/organization-profile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ All props are optional.
- `routing`
- `'hash' | 'path' | 'virtual'`

The routing strategy for your pages. <br />Defaults to `'path'` in Next.js and Remix applications. Defaults to `hash` for all other SDK's.
The [routing](/docs/how-clerk-works/routing) strategy for your pages. <br />Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React.

---

Expand Down Expand Up @@ -77,7 +77,7 @@ All props are optional.
import { OrganizationProfile } from '@clerk/clerk-react'

export default function OrganizationProfilePage() {
return <OrganizationProfile path="/organization-profile" />
return <OrganizationProfile />
}
```
</Tab>
Expand All @@ -98,7 +98,7 @@ All props are optional.
import { OrganizationProfile } from '@clerk/astro/components'
---
<OrganizationProfile path="/organization-profile" />
<OrganizationProfile />
```
</Tab>

Expand Down
12 changes: 6 additions & 6 deletions docs/components/user/user-profile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ All props are optional.
- `routing`
- `'hash' | 'path' | 'virtual'`

The routing strategy for your pages.<br />Defaults to `'path'` in Next.js and Remix applications. Defaults to `hash` for all other SDK's.
The [routing](/docs/how-clerk-works/routing) strategy for your pages.<br />Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React.

---

Expand Down Expand Up @@ -63,15 +63,15 @@ All props are optional.
```jsx {{ filename: 'app/user-profile/[[...user-profile]]/page.tsx' }}
import { UserProfile } from '@clerk/nextjs'

const UserProfilePage = () => <UserProfile path="/user-profile" />
const UserProfilePage = () => <UserProfile />

export default UserProfilePage
```

```jsx {{ filename: '/pages/user-profile/[[...index]].tsx' }}
import { UserProfile } from '@clerk/nextjs'

const UserProfilePage = () => <UserProfile path="/user-profile" />
const UserProfilePage = () => <UserProfile />

export default UserProfilePage
```
Expand All @@ -82,7 +82,7 @@ All props are optional.
```jsx {{ filename: '/user-profile.tsx' }}
import { UserProfile } from '@clerk/clerk-react'

const UserProfilePage = () => <UserProfile path="/user-profile" />
const UserProfilePage = () => <UserProfile />

export default UserProfilePage
```
Expand All @@ -93,7 +93,7 @@ All props are optional.
import { UserProfile } from '@clerk/remix'

export default function UserProfilePage() {
return <UserProfile path="/user" />
return <UserProfile />
}
```
</Tab>
Expand All @@ -104,7 +104,7 @@ All props are optional.
import { UserProfile } from '@clerk/astro/components'
---
<UserProfile path="/user" />
<UserProfile />
```
</Tab>

Expand Down
6 changes: 1 addition & 5 deletions docs/customization/organization-profile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -354,10 +354,6 @@ Note that when reordering default routes, the first item in the navigation sideb
</Tab>

<Tab>
The first page in the list will always be rendered under the root path defined with the `path` prop. Its `url` prop will be ignored.

In the following example, `path` is set to `/organization-profile`, so the `<CustomPage />` is rendered under the `/organization-profile` path.

```tsx {{ filename: 'app/organization-profile/[[...organization-profile]]/page.tsx' }}
'use client'

Expand All @@ -381,7 +377,7 @@ Note that when reordering default routes, the first item in the navigation sideb
}

const OrganizationProfilePage = () => (
<OrganizationProfile path="/organization-profile" routing="path">
<OrganizationProfile>
<OrganizationProfile.Page label="Custom Page" url="custom" labelIcon={<DotIcon />}>
<CustomPage />
</OrganizationProfile.Page>
Expand Down
12 changes: 2 additions & 10 deletions docs/customization/user-profile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -438,10 +438,6 @@ Note that when reordering default routes, the first item in the navigation sideb
</Tab>

<Tab>
The first page in the list will always be rendered under the root path defined with the `path` prop. Its `url` prop will be ignored.

In the following example, `path` is set to `/user-profile`, so the `<CustomPage />` is rendered under the `/user-profile` path.

```tsx {{ filename: 'app/user-profile/[[...user-profile]]/page.tsx' }}
'use client'

Expand All @@ -465,7 +461,7 @@ Note that when reordering default routes, the first item in the navigation sideb
}

const UserProfilePage = () => (
<UserProfile path="/user-profile" routing="path">
<UserProfile>
<UserProfile.Page label="Custom Page" url="custom" labelIcon={<DotIcon />}>
<CustomPage />
</UserProfile.Page>
Expand Down Expand Up @@ -523,16 +519,12 @@ Note that when reordering default routes, the first item in the navigation sideb
</Tab>

<Tab>
The first page in the list will always be rendered under the root path defined with the `path` prop. Its `url` prop will be ignored.

In the following example, `path` is set to `/user-profile`, so the custom page is rendered under the `/user-profile` path.

```astro {{ filename: 'pages/user-profile.astro' }}
---
import { UserProfile } from '@clerk/astro/components'
---
<UserProfile path="/user-profile" routing="path">
<UserProfile>
<UserProfile.Page label="Custom Page" url="custom">
<svg
slot="label-icon"
Expand Down
2 changes: 1 addition & 1 deletion docs/deployments/clerk-environment-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ The following environment variables are deprecated but still supported to avoid
| Variable | Description |
| - | - |
| `CLERK_AFTER_SIGN_UP_URL` | Full URL or path to navigate to after successful sign up. Defaults to `/`. `CLERK_SIGN_UP_FALLBACK_URL` and `CLERK_SIGN_UP_FORCE_REDIRECT_URL` have priority and should be used instead. |
| `CLERK_AFTER_SIGN_IN_URL` | Full URL or path to navigate to after successful sign in. Defaults to `/`. `CLERK_SIGN_IN_FALLBACK_URL` and `CLERK_SIGN_IN_FORCE_REDIRECT_URL` have priority and should be used instead. |
| `CLERK_AFTER_SIGN_IN_URL` | Full URL or path to navigate to after successful sign in. Defaults to `/`. `CLERK_SIGN_IN_FALLBACK_REDIRECT_URL` and `CLERK_SIGN_IN_FORCE_REDIRECT_URL` have priority and should be used instead. |
</Tab>

<Tab>
Expand Down
Loading

0 comments on commit fab59eb

Please sign in to comment.