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
{{ message }}
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: synthetics/test-config/auth.rst
+16-12Lines changed: 16 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,8 +37,9 @@ Basic authentication through HTML login forms
37
37
.. meta::
38
38
:description: Basic authentication allows your tests to send a username and password to a login form on a target test page.
39
39
40
+
.. note::
41
+
This authentication method applies to browser tests only.
40
42
41
-
.. note:: This authentication method applies to browser tests only.
42
43
43
44
If your test target provides an HTML form for entering username and password, configure your browser test as follows.
44
45
@@ -90,8 +91,8 @@ Basic authentication through HTTP headers
90
91
.. meta::
91
92
:description: Basic authentication allows your tests to send a username and password through HTTP headers.
92
93
93
-
94
-
.. note::This authentication method applies to browser tests only.
94
+
.. note::
95
+
This authentication method applies to browser tests only.
95
96
96
97
If your test target expects login credentials to be included in an HTTP header, configure your browser test as follows.
97
98
@@ -136,8 +137,8 @@ Basic authentication through API request headers
136
137
.. meta::
137
138
:description: Basic authentication allows your tests to send a username and password through API request headers.
138
139
139
-
140
-
.. note::This authentication method applies to API tests only. The steps below are for targets that support “Basic auth”, in other words, API methods like ``curl -G https://api.twilio.com/2010-04-01/Accounts.json -u <YOUR_ACCOUNT_SID>:<YOUR_AUTH_TOKEN>``. You can modify these steps for targets that support a Bearer token.
140
+
.. note::
141
+
This authentication method applies to API tests only. The steps below are for targets that support “Basic auth”, in other words, API methods like ``curl -G https://api.twilio.com/2010-04-01/Accounts.json -u <YOUR_ACCOUNT_SID>:<YOUR_AUTH_TOKEN>``. You can modify these steps for targets that support a Bearer token.
141
142
142
143
If your test target expects login credentials to be included in an an API request header, configure your browser test as follows.
143
144
@@ -180,8 +181,8 @@ Multifactor authentication through SMS
180
181
.. meta::
181
182
:description: Multifactor authentication allows your test to authenticate to a target page by sending it a code it receives through SMS.
182
183
183
-
184
-
.. note::This authentication method applies to browser tests only.
184
+
.. note::
185
+
This authentication method applies to browser tests only.
185
186
186
187
If your test target sends a one time passcode (OTP) through SMS for multifactor authentication, your browser test must retrieve the OTP from the SMS message and enter it into the input field on the target's page. To do this, configure your browser test as follows.
187
188
@@ -213,7 +214,8 @@ Some services may not be accessible during Synthetics tests due to violations of
213
214
214
215
#. Add a step of type :guilabel:`Save return value from JavaScript`, and in the code field, paste the following JavaScript. This script retrieves data from a specified URL using ``XMLHttpRequest`` and extracts the OTP from that data. You configure your test to save this OTP in a global variable named ``otp``.
215
216
216
-
.. note:: In the script, set the variable url to the URL of your own virtual phone number's SMS service.
217
+
.. note::
218
+
In the script, set the variable url to the URL of your own virtual phone number's SMS service.
217
219
218
220
.. code-block:: javascript
219
221
@@ -273,8 +275,8 @@ Multifactor authentication through email
273
275
.. meta::
274
276
:description: Multifactor authentication allows your test to authenticate to a target page by sending it a code it receives through email.
275
277
276
-
277
-
.. note::This authentication method applies to browser tests only.
278
+
.. note::
279
+
This authentication method applies to browser tests only.
278
280
279
281
If your test target sends a one-time passcode (OTP) through email for multifactor authentication, your browser test must retrieve the OTP from the email message and enter it into the input field on the target's page. To do this, configure your browser test as follows.
280
282
@@ -299,9 +301,11 @@ Your email service must be accessible through an API. Some services may not be a
299
301
300
302
#. Add a step of type :guilabel:`Save return value from JavaScript`, and in the code field, paste the following JavaScript. This script retrieves data from a specified URL using ``XMLHttpRequest`` and extracts the OTP from that data. You configure your test to save this OTP in a custom variable named ``otp``.
301
303
302
-
.. note:: In the script, set the variable url to the URL of your own email inbox API endpoint.
304
+
.. note::
305
+
In the script, set the variable url to the URL of your own email inbox API endpoint.
303
306
304
-
.. note:: If you are utilizing the Nylas service, you can locate unread emails by searching for specific text in the subject line or other parameters. For more information, please refer to the :new-page:`Nylas API documentation for messages <https://developer.nylas.com/docs/api/v3/ecc/?redirect=api#get-/v3/grants/-grant_id-/messages>`.
307
+
.. note::
308
+
If you are utilizing the Nylas service, you can locate unread emails by searching for specific text in the subject line or other parameters. For more information, please refer to the :new-page:`Nylas API documentation for messages <https://developer.nylas.com/docs/api/v3/ecc/?redirect=api#get-/v3/grants/-grant_id-/messages>`.
0 commit comments