> For the complete documentation index, see [llms.txt](https://docs.specsolutions.eu/specsync/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.specsolutions.eu/specsync/reference/configuration/configuration-remote.md).

# remote

This configuration section contains settings for accessing the test cases on the remote Azure DevOps server.

The following example shows the most common options within this section.

```javascript
{
  ...
  "remote": {
    "projectUrl": "https://specsyncdemo.visualstudio.com/MyCalculator",
    "user": "myuser",
    "password": "%MYPWD%",
    "testSuite": {
      "name": "BDD Scenarios",
      "testPlan": "My Plan"
    }
  },
  ...
}
```

## Settings

{% hint style="info" %}
The remote settings of the Azure DevOps project can also be specified in the knownRemotes section of one of the parent configuration file or in the user-specific configuration file. Check [Hierarchical configuration files](/specsync/features/general-features/hierarchical-configuration-files.md) for details.
{% endhint %}

| Setting                                | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Default                                                |
| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| `projectUrl`                           | The full URL of the Azure DevOps or VSTS project (including project collection name if necessary). Must not include project team name: for multi-team projects the root project URL has to be specified. See [What is my Azure DevOps project URL](/specsync/important-concepts/what-is-my-server-url.md) for details.                                                                                                                                                                                    | mandatory                                              |
| `authenticationMethod`                 | The authentication method to be used for connecting to the remote server. Possible values: `Interactive`, `UserNamePassword`, `PAT`, `ServicePrincipal`                                                                                                                                                                                                                                                                                                                                                   | automatically detect `UserNamePassword` or `PAT`       |
| `user`                                 | The Azure DevOps user name or [personal access token](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=vsts) (PAT) to be used for authentication. For `ServicePrincipal` authentication method the application ID is specified here. It may contain environment variables in `...{env:ENV_VAR}...` form. See [Azure DevOps authentication options](/specsync/features/general-features/server-authentication-options.md) for details. | interactive prompt                                     |
| `password`                             | The password to be used for authentication. For `ServicePrincipal` authentication method the client secret is specified here. It may contain environment variables in `...{env:ENV_VAR}...` form. See [Azure DevOps authentication options](/specsync/features/general-features/server-authentication-options.md) for details.                                                                                                                                                                            | interactive prompt                                     |
| `tenantId`                             | Only for `ServicePrincipal` authentication method: specify the Microsoft Entra Tenant ID.                                                                                                                                                                                                                                                                                                                                                                                                                 | Mandatory for `ServicePrincipal` authentication method |
| `authenticationCertificateThumbprint`  | Only for `ServicePrincipal` authentication method: specify the thumbprint of the client certificate to be used for authentication. The certificate has to be saved to the Personal certificate store.                                                                                                                                                                                                                                                                                                     | client secret (`password`) is used                     |
| `securityProtocol`                     | The security protocol to be used for the remote connection (`Ssl3`, `Tls`, `Tls11`, `Tls12`).                                                                                                                                                                                                                                                                                                                                                                                                             | system default                                         |
| `ignoreCertificateErrorsForThumbprint` | The thumbprint of the server certificate that should be treated as trusted. It is recommended to install trusted certificates on the operating system instead of using this setting. See related [Troubleshooting entry](/specsync/contact/troubleshooting.md#authentication-ssl-error-the-remote-certificate-is-invalid-according-to-the-validation-procedure-when-connecting-to-an-azure-devops-server-on-promises) for details.                                                                        | SSL is verified by the OS                              |
| `testSuite`                            | Specifies a test suite within the Azure DevOps project as a target container of the synchronized test cases. If the test suite is specified, SpecSync will add the synchronized test cases to it for `push` command and consider the test cases within the suite for `pull` command. See [Group synchronized test cases to a test suite](/specsync/features/common-synchronization-features/group-synchronized-test-cases-to-a-test-suite.md) for details.                                                | test cases are not included in a test suite            |
| `testSuite/name`                       | The name of the Test Suite. For suites with non-unique names, please use the `testSuite/id` or `testSuite/path` setting.                                                                                                                                                                                                                                                                                                                                                                                  | either `name`, `id` or `path` is mandatory             |
| `testSuite/id`                         | The ID of the Test Suite as a number.                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | either `name`, `id` or `path` is mandatory             |
| `testSuite/path`                       | The path of the Test Suite from the root of the Test Plan, separated by `/` (e.g. `Ordering/Card Payment`).                                                                                                                                                                                                                                                                                                                                                                                               | either `name`, `id` or `path` is mandatory             |
| `testSuite/testPlan`                   | The name or ID of the Test Plan to search or create the test suite in, e.g. `My Plan` or `#1234`. (Optional, improves performance)                                                                                                                                                                                                                                                                                                                                                                        | not specified                                          |
| `azureDevOps`                          | <p>Azure DevOps server configuration settings.</p><ul><li><code>testCaseWorkItemName</code> — The name of the Test Case work item in a localized Azure DevOps process (Default: <code>Test Case</code>)</li><li><code>testSuiteWorkItemName</code> — The name of the Test Suite work item in a localized Azure DevOps process (Default: <code>Test Suite</code>)</li></ul>                                                                                                                                | uses default AzureDevOps server settings               |

{% content-ref url="/pages/-LVwFCLiKB3ACJLwVZGP" %}
[Configuration reference](/specsync/reference/configuration.md)
{% endcontent-ref %}
