Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit fc00b07

Browse files
author
ada
committed
Fixed syntax of directives?
1 parent 4894580 commit fc00b07

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

synthetics/test-config/auth.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Basic authentication through HTML login forms
3838
:description: Basic authentication allows your tests to send a username and password to a login form on a target test page.
3939

4040

41-
.. :note:: This authentication method applies to browser tests only.
41+
.. note:: This authentication method applies to browser tests only.
4242

4343
If your test target provides an HTML form for entering username and password, configure your browser test as follows.
4444

@@ -91,7 +91,7 @@ Basic authentication through HTTP headers
9191
:description: Basic authentication allows your tests to send a username and password through HTTP headers.
9292

9393

94-
.. :note:: This authentication method applies to browser tests only.
94+
.. note:: This authentication method applies to browser tests only.
9595

9696
If your test target expects login credentials to be included in an HTTP header, configure your browser test as follows.
9797

@@ -137,8 +137,7 @@ Basic authentication through API request headers
137137
:description: Basic authentication allows your tests to send a username and password through API request headers.
138138

139139

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

143142
If your test target expects login credentials to be included in an an API request header, configure your browser test as follows.
144143

@@ -182,7 +181,7 @@ Multifactor authentication through SMS
182181
:description: Multifactor authentication allows your test to authenticate to a target page by sending it a code it receives through SMS.
183182

184183

185-
.. :note:: This authentication method applies to browser tests only.
184+
.. note:: This authentication method applies to browser tests only.
186185

187186
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.
188187

@@ -193,7 +192,7 @@ Prerequisites
193192
- Virtual phone number
194193

195194
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+
197196
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>`.
198197

199198
- SMS notifications
@@ -214,7 +213,7 @@ Some services may not be accessible during Synthetics tests due to violations of
214213

215214
#. 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``.
216215

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

219218
.. code-block:: javascript
220219
@@ -275,7 +274,7 @@ Multifactor authentication through email
275274
:description: Multifactor authentication allows your test to authenticate to a target page by sending it a code it receives through email.
276275

277276

278-
.. :note:: This authentication method applies to browser tests only.
277+
.. note:: This authentication method applies to browser tests only.
279278

280279
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.
281280

@@ -300,9 +299,9 @@ Your email service must be accessible through an API. Some services may not be a
300299

301300
#. 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``.
302301

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

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>`.
306305

307306
.. code-block:: javascript
308307

0 commit comments

Comments
 (0)