Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Unauthorized sign-in #1668

Merged
merged 34 commits into from
Dec 5, 2024
Merged

feat: Unauthorized sign-in #1668

merged 34 commits into from
Dec 5, 2024

Conversation

gkats
Copy link
Member

@gkats gkats commented Oct 30, 2024

Explanation:

We're launching a new feature that detects sign-ins from unrecognized devices and sends a notification to the users.

This PR:

  • Added a section under Security for unauthorized sign-ins.
  • Added the unauthorized sign-in page in the Account Portal docs.

@gkats gkats requested a review from a team as a code owner October 30, 2024 13:47
Copy link

Hey, here’s your docs preview: https://clerk.com/docs/pr/1668

@gkats gkats requested a review from victoriaxyz November 1, 2024 06:37
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Show resolved Hide resolved
@gkats gkats requested a review from victoriaxyz November 1, 2024 16:33
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
@alexisintech alexisintech marked this pull request as draft November 4, 2024 17:37
@alexisintech
Copy link
Member

converting to draft until the feature is ready for release, and then we can revisit this pr and make the necessary updates!

gkats and others added 16 commits December 3, 2024 06:47
Added a section under Security for unauthorized sign-ins.
Added the unauthorized sign-in page in the Account Portal docs.
Format the new docs page with prettier.
Until we get the new Emails redesign page in the dashboard, we'll keep
the configuration section to the minimum required.
The template name has changed in the dashboard.
@gkats gkats marked this pull request as ready for review December 3, 2024 04:54
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
docs/security/unauthorized-sign-in.mdx Outdated Show resolved Hide resolved
@@ -52,6 +52,12 @@ The user profile page hosts the prebuilt [`<UserProfile />`](/docs/components/us

Redirect your authenticated users to their user profile page using the [`<RedirectToUserProfile />`](/docs/components/control/redirect-to-userprofile) control component.

### Unauthorized sign-in

The unauthorized sign-in page doesn't host any prebuilt Clerk component. It displays a UI confirming that a session from an unrecognized device was successfully revoked. For more information, see the [Unauthorized sign-in](/docs/security/unauthorized-sign-in) feature.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The unauthorized sign-in page doesn't host any prebuilt Clerk component. It displays a UI confirming that a session from an unrecognized device was successfully revoked. For more information, see the [Unauthorized sign-in](/docs/security/unauthorized-sign-in) feature.
The unauthorized sign-in page doesn't host any prebuilt Clerk component. It displays a UI confirming that a session from an unrecognized device was successfully revoked. For more information, see the [Unauthorized sign-in](/docs/security/unauthorized-sign-in) guide.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure this is a guide? I see it more as a page which explains what the feature is about.

Would it be confusing the page with the rest of the "Guides"?

image

Copy link
Member

@alexisintech alexisintech Dec 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

firstly, I'd say to update this suggestion with the original suggestion that accidentally didn't get applied:

Suggested change
The unauthorized sign-in page doesn't host any prebuilt Clerk component. It displays a UI confirming that a session from an unrecognized device was successfully revoked. For more information, see the [Unauthorized sign-in](/docs/security/unauthorized-sign-in) feature.
The unauthorized sign-in page displays a UI confirming that a session from an unrecognized device was successfully revoked. For more information, refer to [the guide.](/docs/security/unauthorized-sign-in)

secondly, I'd call this a reference guide - it's kind of in the middle, but it's more so a reference for the "unauthorized sign in" feature, so we can call it a reference! this would update the suggestion to read:

Suggested change
The unauthorized sign-in page doesn't host any prebuilt Clerk component. It displays a UI confirming that a session from an unrecognized device was successfully revoked. For more information, see the [Unauthorized sign-in](/docs/security/unauthorized-sign-in) feature.
The unauthorized sign-in page displays a UI confirming that a session from an unrecognized device was successfully revoked. For more information, see [the reference](/docs/security/unauthorized-sign-in).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i've applied the changes here c36db71

Copy link
Contributor

@victoriaxyz victoriaxyz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good!

@gkats gkats requested a review from victoriaxyz December 4, 2024 05:52
@gkats
Copy link
Member Author

gkats commented Dec 4, 2024

Hi @victoriaxyz, thanks for the review.

I think I applied most of the feedback. Could you please take another look?

When a sign-in attempt is made from an unfamiliar device, Clerk notifies the account owner by email with details about the newly created session. The account owner can immediately revoke the session if it's recognized as unauthorized.

The email notification users receive for unauthorized sign-ins varies depending on the instance's configuration and the application's billing plan.
When a sign-in attempt is made from an unfamiliar device, Clerk notifies the account owner by email with details about the newly created session. The email notification varies depending on the instance's configuration and the application's billing plan.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've removed "The account owner can immediately revoke the session if it's recognized as unauthorized." as this is only available for certain supported instances. So now, we can combine the first and third sentence, and it flows very nicely.

Copy link
Member

@alexisintech alexisintech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These look good! We reaaaally appreciate you getting these in early for us to start working on, long before the feature was to be released.
Thank you for taking in Victoria's and I's suggestions, I know they can seem like a lot and we appreciate your collaboration ❤️

@gkats gkats merged commit 5a326be into main Dec 5, 2024
4 checks passed
@gkats gkats deleted the user-766-docs branch December 5, 2024 17:29
alexisintech added a commit that referenced this pull request Dec 6, 2024
Co-authored-by: victoria <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
royanger pushed a commit that referenced this pull request Dec 16, 2024
Co-authored-by: victoria <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants