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

Commit c99dd08

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

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

synthetics/test-config/auth.rst

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

40+
.. note::
41+
This authentication method applies to browser tests only.
4042

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

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

@@ -90,8 +91,8 @@ Basic authentication through HTTP headers
9091
.. meta::
9192
:description: Basic authentication allows your tests to send a username and password through HTTP headers.
9293

93-
94-
.. note:: This authentication method applies to browser tests only.
94+
.. note::
95+
This authentication method applies to browser tests only.
9596

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

@@ -136,8 +137,8 @@ Basic authentication through API request headers
136137
.. meta::
137138
:description: Basic authentication allows your tests to send a username and password through API request headers.
138139

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

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

@@ -180,8 +181,8 @@ Multifactor authentication through SMS
180181
.. meta::
181182
:description: Multifactor authentication allows your test to authenticate to a target page by sending it a code it receives through SMS.
182183

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

186187
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.
187188

@@ -213,7 +214,8 @@ Some services may not be accessible during Synthetics tests due to violations of
213214

214215
#. 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``.
215216

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

218220
.. code-block:: javascript
219221
@@ -273,8 +275,8 @@ Multifactor authentication through email
273275
.. meta::
274276
:description: Multifactor authentication allows your test to authenticate to a target page by sending it a code it receives through email.
275277

276-
277-
.. note:: This authentication method applies to browser tests only.
278+
.. note::
279+
This authentication method applies to browser tests only.
278280

279281
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.
280282

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

300302
#. 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``.
301303

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

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

306310
.. code-block:: javascript
307311

0 commit comments

Comments
 (0)