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
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ Basic authentication through HTML login forms
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
40
41
-
..:note:: This authentication method applies to browser tests only.
41
+
.. note:: This authentication method applies to browser tests only.
42
42
43
43
If your test target provides an HTML form for entering username and password, configure your browser test as follows.
44
44
@@ -91,7 +91,7 @@ Basic authentication through HTTP headers
91
91
:description: Basic authentication allows your tests to send a username and password through HTTP headers.
92
92
93
93
94
-
..:note:: This authentication method applies to browser tests only.
94
+
.. note:: This authentication method applies to browser tests only.
95
95
96
96
If your test target expects login credentials to be included in an HTTP header, configure your browser test as follows.
97
97
@@ -137,8 +137,7 @@ Basic authentication through API request headers
137
137
:description: Basic authentication allows your tests to send a username and password through API request headers.
138
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>``.
141
-
You can modify these steps for targets that support a Bearer token.
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.
142
141
143
142
If your test target expects login credentials to be included in an an API request header, configure your browser test as follows.
144
143
@@ -182,7 +181,7 @@ Multifactor authentication through SMS
182
181
:description: Multifactor authentication allows your test to authenticate to a target page by sending it a code it receives through SMS.
183
182
184
183
185
-
..:note:: This authentication method applies to browser tests only.
184
+
.. note:: This authentication method applies to browser tests only.
186
185
187
186
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.
188
187
@@ -193,7 +192,7 @@ Prerequisites
193
192
- Virtual phone number
194
193
195
194
To authenticate through SMS, you must have a virtual phone number that can receive one time passcodes through SMS. Several services offer virtual phone numbers and provide SMS content through an API, such as the :new-page:`Sinch service <http://sinch.com>`. For instructions on receiving messages through this service, see :new-page:`the Sinch API <https://developers.sinch.com/docs/sms/api-reference/sms/tag/Inbounds/#tag/Inbounds/operation/ListInboundMessages>`.
196
-
195
+
197
196
Certain services, such as Twilio, may block incoming SMS messages containing OTPs. For more information regarding this issue, see Twilio's documentation on :new-page:`OTP Message Body Filtered <https://www.twilio.com/docs/api/errors/30038>`.
198
197
199
198
- SMS notifications
@@ -214,7 +213,7 @@ Some services may not be accessible during Synthetics tests due to violations of
214
213
215
214
#. 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``.
216
215
217
-
..:note:: In the script, set the variable url to the URL of your own virtual phone number's SMS service.
216
+
.. note:: In the script, set the variable url to the URL of your own virtual phone number's SMS service.
218
217
219
218
.. code-block:: javascript
220
219
@@ -275,7 +274,7 @@ Multifactor authentication through email
275
274
:description: Multifactor authentication allows your test to authenticate to a target page by sending it a code it receives through email.
276
275
277
276
278
-
..:note:: This authentication method applies to browser tests only.
277
+
.. note:: This authentication method applies to browser tests only.
279
278
280
279
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.
281
280
@@ -300,9 +299,9 @@ Your email service must be accessible through an API. Some services may not be a
300
299
301
300
#. 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``.
302
301
303
-
..:note:: In the script, set the variable url to the URL of your own email inbox API endpoint.
302
+
.. note:: In the script, set the variable url to the URL of your own email inbox API endpoint.
304
303
305
-
..: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>`.
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>`.
0 commit comments