You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: admin/changing-your-email-password.mdx
+7-3Lines changed: 7 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: "Changing your email or password in Checkly"
3
3
description: "Learn how to change your email address or password in your Checkly account"
4
-
sidebarTitle: "Changing Your Email"
4
+
sidebarTitle: "Changing Email or Password"
5
5
---
6
6
7
7
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:
20
20
5. Optionally, remove your "old" user from the account.
21
21
22
22
<Warning>
23
-
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.
23
+
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.
24
24
</Warning>
25
25
26
26
## Changing your password
@@ -37,4 +37,8 @@ To change your password, follow these steps:
37
37
4. Click the **Forgot password?** link.
38
38
5. Follow the instructions to reset your password.
39
39
40
-
After successfully resetting your password, you can log in with your new password.
40
+
After successfully resetting your password, you can log in with your new password.
41
+
42
+
<Note>
43
+
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).
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/).
34
-
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).
33
+
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).
34
+
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).
35
35
36
36
## Service API keys
37
37
38
38
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.
39
39
40
-
<Info>
40
+
<Note>
41
41
Service API keys are available on the [Enterprise plan](https://www.checklyhq.com/pricing/) only
42
-
</Info>
42
+
</Note>
43
43
44
44
Service API keys allow you to set a role access level on the key itself, e.g. "read only", "admin" etc.
Copy file name to clipboardExpand all lines: admin/team-management/adding-team-members.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: "Learn how to invite team members to join your Checkly account and
4
4
sidebarTitle: "Adding Team Members"
5
5
---
6
6
7
-
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).
7
+
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).
title: "Using Microsoft Azure AD for Single Sign-on in Checkly"
3
-
description: "Learn how to configure Microsoft Azure AD SSO integration with Checkly"
4
-
sidebarTitle: "MS Active Directory"
2
+
title: "Using Microsoft Entra ID for Single Sign-on in Checkly"
3
+
description: "This page illustrates the standard procedure to follow in order to get started with Microsoft Entra ID SSO (formerly Azure AD) on Checkly. "
4
+
sidebarTitle: "Microsoft Entra ID"
5
5
---
6
6
7
-
This page illustrates the standard procedure to follow in order to get started with Microsoft Azure AD SSO on Checkly.
8
-
9
7
## Initial SSO configuration
10
8
11
9
Setting up SSO for your organisation starts with providing [Checkly Support](mailto:support@checklyhq.com) with the following information:
@@ -23,5 +21,5 @@ After configuration has taken place on Checkly's side, you will receive confirma
23
21
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.
24
22
25
23
<Info>
26
-
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.
24
+
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.
Copy file name to clipboardExpand all lines: admin/team-management/overview.mdx
+6-14Lines changed: 6 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ sidebarTitle: "Overview"
6
6
7
7
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.
8
8
9
-
## Team Roles
9
+
## Team Member Roles
10
10
11
11
When inviting a team member to join your account you can assign one of four roles that all have different access patterns.
12
12
@@ -33,7 +33,7 @@ Roles are staggered, so any role higher up the totem pole has all the rights of
33
33
34
34
Learn how to invite new users to your account and manage their access levels.
35
35
36
-
[Learn more about adding team members](admin/team-management/adding-team-members)
36
+
[Learn more about adding team members](/admin/team-management/adding-team-members)
37
37
38
38
### Transferring Ownership
39
39
@@ -45,37 +45,29 @@ If you have the **Owner** role, you can transfer the ownership to another team m
45
45
46
46
Manage your login credentials and account information securely.
47
47
48
-
[Learn about changing your email or password](admin/changing-your-email-password)
48
+
[Learn about changing your email or password](/admin/changing-your-email-password)
49
49
50
50
## Security
51
51
52
52
### Multi-Factor Authentication
53
53
54
54
Add an extra layer of security to your account with MFA using authenticator apps.
55
55
56
-
[Set up multi-factor authentication](admin/team-management/multi-factor-authentication)
56
+
[Set up multi-factor authentication](/admin/team-management/multi-factor-authentication)
57
57
58
58
### Single Sign-On (SSO)
59
59
60
60
For enterprise customers, Checkly supports SSO integration with your existing identity provider.
61
61
62
-
[Learn about SSO options](admin/team-management/single-sign-on)
description: "Overview of Single Sign-On (SSO) options available in Checkly for enterprise security"
4
-
sidebarTitle: "Single Sign-On"
4
+
sidebarTitle: "Overview"
5
5
---
6
6
7
7
Single Sign-On (SSO) enables businesses to secure employee access across a variety of third-party services. Currently, Checkly supports the following SSO protocols:
description: 'Wait for a check session to finish and get final results'
5
+
---
6
+
7
+
## Overview
8
+
9
+
Call this endpoint to await the completion of a check session. A successful response will be returned once the check session reaches its final state (i.e. when it passes or fails).
10
+
11
+
If the check session takes a long time to complete, the endpoint will return a timeout error code (see `maxWaitSeconds` parameter below).
12
+
13
+
You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using *curl*, its `--retry` option is suitable.
14
+
15
+
The successful response of this endpoint is equivalent to the `GET /v1/check-sessions/{checkSessionId}` endpoint's response for a completed check session.
Retrieves a check session. Results may be incomplete if the session is still in progress.
10
+
11
+
Results for all finished check runs are included, with one result per run location. Each result contains enough data to quickly determine success or failure.
12
+
13
+
For detailed information on a specific result, use the `GET /v1/check-results/{checkId}/{checkResultId}` endpoint.
0 commit comments