Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions admin/changing-your-email-password.mdx
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -20,7 +20,7 @@ The simplest way to achieve this is to:
5. Optionally, remove your "old" user from the account.

<Warning>
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.
</Warning>

## Changing your password
Expand All @@ -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.
After successfully resetting your password, you can log in with your new password.

<Note>
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).
</Note>
12 changes: 6 additions & 6 deletions admin/creating-api-key.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

<Info>
<Note>
Service API keys are available on the [Enterprise plan](https://www.checklyhq.com/pricing/) only
</Info>
</Note>

Service API keys allow you to set a role access level on the key itself, e.g. "read only", "admin" etc.

Expand Down
2 changes: 1 addition & 1 deletion admin/team-management/adding-team-members.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 5 additions & 7 deletions admin/team-management/microsoft-azure-ad.mdx
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.

<Info>
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.
</Info>
2 changes: 1 addition & 1 deletion admin/team-management/multi-factor-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down
20 changes: 6 additions & 14 deletions admin/team-management/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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

Expand All @@ -45,37 +45,29 @@ 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

### Multi-Factor Authentication

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

<Note>
SSO is only available for Checkly's [enterprise plans](https://www.checklyhq.com/pricing/).
</Note>
[Learn about SSO options](/admin/team-management/single-sign-on)

## API Access

### Creating API Keys

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
Expand Down
8 changes: 4 additions & 4 deletions admin/team-management/single-sign-on.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
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:

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).

<Note>
SSO is only available for Checkly's [enterprise plans](/pricing/).
SSO is only available for Checkly's [enterprise plans](https://www.checklyhq.com/pricing/).
</Note>
18 changes: 11 additions & 7 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@
},

"platform/secrets",
"platform/data-storage",
"platform/variables",
{
"group": "Runtimes",
Expand All @@ -110,6 +111,7 @@
]
},
"platform/allowlisting-traffic",
"platform/ip-information",
"platform/network-diagnostic-tools",
"platform/managing-false-positives"
]
Expand All @@ -123,16 +125,18 @@
"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"
{
"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",
"admin/data-storage",
"admin/ip-information"
"admin/changing-your-email-password"
]
}

Expand Down
6 changes: 3 additions & 3 deletions admin/data-storage.mdx → platform/data-storage.mdx
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
4 changes: 2 additions & 2 deletions admin/ip-information.mdx → platform/ip-information.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: IP Information & Support
sidebarTitle: IP Support
title: IP Information & Versions
sidebarTitle: IP Information
tags: ['ip-information']
---

Expand Down