VTN Credentials

Same as the organization client represents an application user account type in the Switch platform that allows simple but powerfull integration with the Switchmarket API, the Switch OpenADR VTN alternative are the VTN Credentials clients.

In order to get an access token from the Switch Authorization Server, you need to pass valid client ID and client secret in the request as explained in Client Credentials Flow. For this purpose you need to create a VTN Credentials client.

The Switch app offers a way for the organization administrators to manage their VTN credetials clients, such as view, and delete existing credentials clients, create new credentials clients and manage each credential client secrets.

Manage Credentials

View credentials clients

Follow the steps below to see your VTN credentials clients and their respective IDs.

1. In the upper-right corner of any page in the Switch app, click the User icon, then click on the organization for which you whish to see the VTN credentials clients for.

2. Next, in the upper-right corner of any page on Switch app, click the Settings icon, then click Administer my organization.

3. Next, in the left sidebar menu click OpenADR.

   
4. List of existing organization VTN credentials clients with their respective client IDs will be shown on the right, under the VTN Credentials tab.

   

In case there are no existing VTN credentials clients available for the organization, an empty list will be shown. In this case just proceed to the next topic about creating new VTN credetials client.

Create credentials client

To create new VTN credentials client you first need to be on the View credentials clients page as explained above and follow the steps below.

1. Click on the Create client button on the right.

   
2. Next, enter the VTN credentials client Name, select which scopes the client should have from the list of Available scopes, and click the Save button in the bottom-right.

   
3. After saving, the newly created VTN credentials client with its respective client ID will be shown in the list of existing VTN credentials clients.

   

Delete credentials client

To delete existing VTN credentials client you need to be on the View credentials clients page as explained above and follow the steps below.

1. Click on the Delete button on the right of the VTN credentials client name, of the one you want to delete.

   

By deleting a credentials client, any application using this credentials client will lose access to the Switchmarket OpenADR VTN API.

Manage Credentials Secrets

Create credentials secret

The credentials secret is a secret string that the application uses to prove its identity when requesting an access token and can be referred to as an application password. Each organization VTN credentials client can have one or multiple secrets. To generate secret, you need to be on the View credentials clients page as explained above and follow the steps below.

1. Click on the New secret button on the right after which the create new secret window is shown.

   
2. Fill in the required credentials secret details and click Save. Name - short descriptive name of the credentials secret Validity - the period under which the credentials secret will be valid for use. In case you do not provide the validity period, the default period will be 2 years starting from the date when you have created the secret.
3. After the details are saved, the credentials secret is generated and displayed below the credentials client information.

   

The secret string should be stored in a safe place and will not be shown here after the page is refreshed.

Delete credentials secret

To delete existing credentials secret you need to be on the View credentials clients page as explained above and follow the steps below.

1. Click on the Delete icon shown on the right of the credentials secret name

   

By deleting a credentials secret, any application using the combination of a client ID and the deleted credentials secret will lose access to the Switchmarket OpenADR VTN API.