From e7ab5fa1ecc450df38cc3a02c24fdb5bf29a9538 Mon Sep 17 00:00:00 2001 From: Laura Guo Date: Fri, 3 Oct 2025 11:48:57 -0400 Subject: [PATCH 1/2] fix: update team management pages and fix broken links --- admin/changing-your-email-password.mdx | 10 +++++++--- admin/creating-api-key.mdx | 12 +++++------ admin/team-management/adding-team-members.mdx | 2 +- admin/team-management/microsoft-azure-ad.mdx | 12 +++++------ .../multi-factor-authentication.mdx | 2 +- admin/team-management/overview.mdx | 20 ++++++------------- admin/team-management/single-sign-on.mdx | 6 +++--- docs.json | 12 +++++------ {admin => platform}/data-storage.mdx | 6 +++--- {admin => platform}/ip-information.mdx | 4 ++-- 10 files changed, 40 insertions(+), 46 deletions(-) rename {admin => platform}/data-storage.mdx (90%) rename {admin => platform}/ip-information.mdx (95%) diff --git a/admin/changing-your-email-password.mdx b/admin/changing-your-email-password.mdx index c6c0551..35b8d17 100644 --- a/admin/changing-your-email-password.mdx +++ b/admin/changing-your-email-password.mdx @@ -1,7 +1,7 @@ --- title: "Changing your email or password in Checkly" description: "Learn how to change your email address or password in your Checkly account" -sidebarTitle: "Changing Your Email" +sidebarTitle: "Changing Email or Password" --- Changing your email and / or password is handled differently depending on how you signed up for Checkly. Please check below for the scenario that applies to you: @@ -20,7 +20,7 @@ The simplest way to achieve this is to: 5. Optionally, remove your "old" user from the account. -This method won't work if you're on the Hobby plan or have reached your user limit. If you run into this or other issues, contact support for help. +This method won't work if you're on the Hobby plan or have reached your user limit. If you run into this or other issues, contact [support@checklyhq.com](mailto:support@checklyhq.com) for help. ## Changing your password @@ -37,4 +37,8 @@ To change your password, follow these steps: 4. Click the **Forgot password?** link. 5. Follow the instructions to reset your password. -After successfully resetting your password, you can log in with your new password. \ No newline at end of file +After successfully resetting your password, you can log in with your new password. + + + If your reset password email never arrives, this may be because you originally logged in with Google or Github. If you need help accessing your account, please reach out to [support@checklyhq.com](mailto:support@checklyhq.com). + \ No newline at end of file diff --git a/admin/creating-api-key.mdx b/admin/creating-api-key.mdx index ad5bedf..aa3d74d 100644 --- a/admin/creating-api-key.mdx +++ b/admin/creating-api-key.mdx @@ -13,8 +13,8 @@ When a user is removed from your account, that user's API keys are no longer abl **Steps to create an user API key:** -1. Go to the API keys section in the [User Settings](https://app.checklyhq.com/settings/user/). -2. Click **Create new API key**. +1. Go to the API keys section in the [User Settings](https://app.checklyhq.com/settings/user/api-keys). +2. Click **Create API key**. 3. Enter a name for the API key in the dialog box and confirm. 4. The new API key is shown and can be copied. Make sure to copy it immediately as it won't be shown again. @@ -30,16 +30,16 @@ curl -H "Authorization: Bearer my_user_api_key" -H "X-Checkly-Account: my_accoun ### Deleting a user API key -Only the user can delete an API key. To delete an API key click on the **Delete** icon in the Api Keys section of the [User Settings](https://app.checklyhq.com/settings/user/). -If you wish to revoke access of a user to an account, remove the user from the team in the [Team section of Account Settings](https://app.checklyhq.com/settings/account/team). +Only the user can delete an API key. To delete an API key click on the **Delete** icon in the Api Keys section of the [User Settings](https://app.checklyhq.com/settings/user/api-keys). +If you wish to revoke access of a user to an account, remove the user from the team in the [Members section of Account Settings](https://app.checklyhq.com/settings/account/team). ## Service API keys Service API keys are specific to one account and are not tied to a user. This means that service API keys can be used to access your account even if the user that created the API key is removed from your account. - + Service API keys are available on the [Enterprise plan](https://www.checklyhq.com/pricing/) only - + Service API keys allow you to set a role access level on the key itself, e.g. "read only", "admin" etc. diff --git a/admin/team-management/adding-team-members.mdx b/admin/team-management/adding-team-members.mdx index 8a2783e..0f59cf0 100644 --- a/admin/team-management/adding-team-members.mdx +++ b/admin/team-management/adding-team-members.mdx @@ -4,7 +4,7 @@ description: "Learn how to invite team members to join your Checkly account and sidebarTitle: "Adding Team Members" --- -You can invite team members to join your Checkly account to view and manage all checks and related settings; team members can have different [roles](platform/admin/overview). +You can invite team members to join your Checkly account to view and manage all checks and related settings; team members can have different [roles](/admin/team-management/overview). ## Inviting team members diff --git a/admin/team-management/microsoft-azure-ad.mdx b/admin/team-management/microsoft-azure-ad.mdx index 3d717db..ea03aaa 100644 --- a/admin/team-management/microsoft-azure-ad.mdx +++ b/admin/team-management/microsoft-azure-ad.mdx @@ -1,16 +1,14 @@ --- -title: "Using Microsoft Azure AD for Single Sign-on in Checkly" -description: "Learn how to configure Microsoft Azure AD SSO integration with Checkly" -sidebarTitle: "MS Active Directory" +title: "Using Microsoft Entra ID for Single Sign-on in Checkly" +description: "This page illustrates the standard procedure to follow in order to get started with Microsoft Entra ID SSO (formerly Azure AD) on Checkly. " +sidebarTitle: "Microsoft Entra ID" --- -This page illustrates the standard procedure to follow in order to get started with Microsoft Azure AD SSO on Checkly. - ## Initial SSO configuration Setting up SSO for your organisation starts with providing [Checkly Support](mailto:support@checklyhq.com) with the following information: -- Microsoft Azure AD Domain (e.g. company.com) +- Microsoft Entra ID Domain (e.g. company.com) - [Client ID](https://auth0.com/docs/connections/enterprise/azure-active-directory) - Client Secret @@ -23,5 +21,5 @@ After configuration has taken place on Checkly's side, you will receive confirma After submitting the Checkly login form, you should be redirected to your SSO login interface. Completing the login procedure will then lead you to your existing Checkly account, if you have one, or to the new account creation screen, in case you don't. -Once Microsoft Azure AD has been set up, you will still need to invite new users from your organization to your Checkly account, as they will not be added automatically. +Once Microsoft Entra ID has been set up, you will still need to invite new users from your organization to your Checkly account, as they will not be added automatically. \ No newline at end of file diff --git a/admin/team-management/multi-factor-authentication.mdx b/admin/team-management/multi-factor-authentication.mdx index 77b7d4f..dd0d7ff 100644 --- a/admin/team-management/multi-factor-authentication.mdx +++ b/admin/team-management/multi-factor-authentication.mdx @@ -14,7 +14,7 @@ Checkly supports MFA using one time passwords generated by a separate authentica - Toggle 'Enable multi-factor authentication'. - Log out of your account and log back in. - When prompted, scan the QR code using one of the supported apps: - - Authy ([Google Play](https://play.google.com/store/apps/details?id=com.authy.authy) / [App Store](https://itunes.apple.com/us/app/authy/id494168017)) + - Twilio Authy ([Google Play](https://play.google.com/store/apps/details?id=com.authy.authy) / [App Store](https://itunes.apple.com/us/app/authy/id494168017)) - Auth0 Guardian ([Google Play](https://play.google.com/store/apps/details?id=com.auth0.guardian) / [App Store](https://itunes.apple.com/us/app/auth0-guardian/id1093447833)) - Google Authenticator ([Google Play](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2) / [App Store](https://itunes.apple.com/us/app/google-authenticator/id388497605)) - Microsoft Authenticator ([Google Play](https://play.google.com/store/apps/details?id=com.azure.authenticator) / [App Store](https://itunes.apple.com/us/app/microsoft-authenticator/id983156458)) diff --git a/admin/team-management/overview.mdx b/admin/team-management/overview.mdx index 6ec597a..49891eb 100644 --- a/admin/team-management/overview.mdx +++ b/admin/team-management/overview.mdx @@ -6,7 +6,7 @@ sidebarTitle: "Overview" This section covers all aspects of administering your Checkly account, from managing team members and permissions to setting up advanced security features and API access. -## Team Roles +## Team Member Roles When inviting a team member to join your account you can assign one of four roles that all have different access patterns. @@ -33,7 +33,7 @@ Roles are staggered, so any role higher up the totem pole has all the rights of Learn how to invite new users to your account and manage their access levels. -[Learn more about adding team members](admin/team-management/adding-team-members) +[Learn more about adding team members](/admin/team-management/adding-team-members) ### Transferring Ownership @@ -45,7 +45,7 @@ If you have the **Owner** role, you can transfer the ownership to another team m Manage your login credentials and account information securely. -[Learn about changing your email or password](admin/changing-your-email-password) +[Learn about changing your email or password](/admin/changing-your-email-password) ## Security @@ -53,21 +53,13 @@ Manage your login credentials and account information securely. Add an extra layer of security to your account with MFA using authenticator apps. -[Set up multi-factor authentication](admin/team-management/multi-factor-authentication) +[Set up multi-factor authentication](/admin/team-management/multi-factor-authentication) ### Single Sign-On (SSO) For enterprise customers, Checkly supports SSO integration with your existing identity provider. -[Learn about SSO options](admin/team-management/single-sign-on) - -**Available SSO Protocols:** -- [SAML](admin/team-management/saml) - Generic SAML 2.0 integration -- [Microsoft Azure AD](admin/team-management/microsoft-azure-ad) - Direct Azure AD integration - - -SSO is only available for Checkly's [enterprise plans](https://www.checklyhq.com/pricing/). - +[Learn about SSO options](/admin/team-management/single-sign-on) ## API Access @@ -75,7 +67,7 @@ SSO is only available for Checkly's [enterprise plans](https://www.checklyhq.com Generate API keys for programmatic access to your Checkly account through the REST API and CLI. -[Learn about creating and managing API keys](admin/team-management/creating-api-key) +[Learn about creating and managing API keys](/admin/creating-api-key) **API Key Types:** - **User API Keys** - Tied to individual users with inherited permissions diff --git a/admin/team-management/single-sign-on.mdx b/admin/team-management/single-sign-on.mdx index ee23e03..8e7a15e 100644 --- a/admin/team-management/single-sign-on.mdx +++ b/admin/team-management/single-sign-on.mdx @@ -6,11 +6,11 @@ sidebarTitle: "Single Sign-On" Single Sign-On (SSO) enables businesses to secure employee access across a variety of third-party services. Currently, Checkly supports the following SSO protocols: -1. [SAML](admin/team-management/saml) -2. [Microsoft Azure AD](admin/team-management/microsoft-azure-ad) +1. [SAML](/admin/team-management/saml) +2. [Microsoft Entra ID](/admin/team-management/microsoft-azure-ad) (formerly Azure AD) If you are interested in using Checkly with a different SSO protocol, please [reach out to Support](mailto:support@checklyhq.com). -SSO is only available for Checkly's [enterprise plans](/pricing/). +SSO is only available for Checkly's [enterprise plans](https://www.checklyhq.com/pricing/). \ No newline at end of file diff --git a/docs.json b/docs.json index 2e7c261..6668a6c 100644 --- a/docs.json +++ b/docs.json @@ -100,6 +100,7 @@ }, "platform/secrets", + "platform/data-storage", "platform/variables", { "group": "Runtimes", @@ -110,6 +111,7 @@ ] }, "platform/allowlisting-traffic", + "platform/ip-information", "platform/network-diagnostic-tools", "platform/managing-false-positives" ] @@ -123,16 +125,14 @@ "pages": [ "admin/team-management/overview", "admin/team-management/adding-team-members", - "admin/team-management/microsoft-azure-ad", "admin/team-management/multi-factor-authentication", - "admin/team-management/saml", - "admin/team-management/single-sign-on" + "admin/team-management/single-sign-on", + "admin/team-management/microsoft-azure-ad", + "admin/team-management/saml" ] }, - "admin/changing-your-email-password", - "admin/data-storage", - "admin/ip-information" + "admin/changing-your-email-password" ] } diff --git a/admin/data-storage.mdx b/platform/data-storage.mdx similarity index 90% rename from admin/data-storage.mdx rename to platform/data-storage.mdx index c38b4b0..dcfae24 100644 --- a/admin/data-storage.mdx +++ b/platform/data-storage.mdx @@ -1,7 +1,7 @@ --- -title: 'How we store your data' -description: 'Learn about the data storage of Checkly' -sidebarTitle: 'Data Retention' +title: 'How we store data' +description: 'Learn about how Checkly stores check run data' +sidebarTitle: 'Data Storage' --- Every check we run generates a certain amount of data. We call these the "results". Results are made up of various parts: diff --git a/admin/ip-information.mdx b/platform/ip-information.mdx similarity index 95% rename from admin/ip-information.mdx rename to platform/ip-information.mdx index c8e08ee..b8ec34b 100644 --- a/admin/ip-information.mdx +++ b/platform/ip-information.mdx @@ -1,6 +1,6 @@ --- -title: IP Information & Support -sidebarTitle: IP Support +title: IP Information & Versions +sidebarTitle: IP Information tags: ['ip-information'] --- From 7b8a8640374d85be3cd606d65ff71bc7282d995d Mon Sep 17 00:00:00 2001 From: Laura Guo Date: Fri, 3 Oct 2025 17:18:16 -0400 Subject: [PATCH 2/2] feat: create nesting structure for SSO --- admin/team-management/single-sign-on.mdx | 2 +- docs.json | 12 ++++++++---- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/admin/team-management/single-sign-on.mdx b/admin/team-management/single-sign-on.mdx index 8e7a15e..8b947f6 100644 --- a/admin/team-management/single-sign-on.mdx +++ b/admin/team-management/single-sign-on.mdx @@ -1,7 +1,7 @@ --- title: "Single Sign-on in Checkly" description: "Overview of Single Sign-On (SSO) options available in Checkly for enterprise security" -sidebarTitle: "Single Sign-On" +sidebarTitle: "Overview" --- Single Sign-On (SSO) enables businesses to secure employee access across a variety of third-party services. Currently, Checkly supports the following SSO protocols: diff --git a/docs.json b/docs.json index 6668a6c..ed669a6 100644 --- a/docs.json +++ b/docs.json @@ -126,10 +126,14 @@ "admin/team-management/overview", "admin/team-management/adding-team-members", "admin/team-management/multi-factor-authentication", - - "admin/team-management/single-sign-on", - "admin/team-management/microsoft-azure-ad", - "admin/team-management/saml" + { + "group": "Single Sign-On", + "pages": [ + "admin/team-management/single-sign-on", + "admin/team-management/microsoft-azure-ad", + "admin/team-management/saml" + ] + } ] }, "admin/changing-your-email-password"