VTN Credentials

Same as the organization client represents an application user account type in the Switch platform, which allows simple but powerful integration with the Switch 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 credentials 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 wish 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 My organization.

   
3. Next, in the left sidebar menu click OpenADR and select VTN credentials tab.

   
4. List of existing 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 and client secret will be shown in the list of existing VTN credentials clients. Remember that the client secret is shown and can be copied at this stage only and after you refresh the page you will not have that possibility again.

   

Rotate credential secret

To rotate the client secret you need to be on the View clients page as explained above and follow the steps below.

1. Click on the rotate button right next to the secret hint of the credential secret that you want to rotate and confirm the secret rotation

   
2. The secret will be rotated and the new value will be shown until you refresh the page, after which, you will be able to see only the secret hint.

   

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 and confirm the deletion.

   

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