NSM Cloud - Getting token for MSW and NSM APIs

This document outlines how to generate Auth token for NSM APIs to access firewalls. 

Requirements

• NSM Essentials License for Firewall
• Firewall Managed via NSM
• MSW API Key Feature Enabled

High Level Process

1. Get MSW API Key from MySonicWall.com
2. Connect to MSW APIs
   1. Get Tenant Information
   2. Get NSM Access Code
3. Connect to NSM APIs
   1. Get Bearer Token
   2. Use Token for NSM APIs

Get MSW API Key from MySonicWall

MSW APIs are NOT enabled by default. To enable the same, call support

1. Once have MSW API enabled, Login to MySonicwall Account.
2. Navigate  to My Workspace | User Groups | User List
3. Click on ‘Generate API Key’ on the top right and a pop-up window will come up as below:
   
4. Click on ‘View / copy’ icon to copy the Key and save it for future use.

Connect to MSW APIs using Postman

a.  Get Tenant Information

1. Open postman and add a new collection enter URL (https://api.mysonicwall.com/api/hgms/get-cloud-tenants) in the input field using ‘GET’ method
   
2. Click on ‘Headers’ tab and add below keys and then click ‘Send’.
   Content-Type: application/json
   X-api-key: Enter the key received in step 1 above.
   
3. Below response show up under ‘Body’ section. Click on copy icon to copy the response as that will be used next to generate the NSM token
   
4. Click on copy icon to copy the response and save the output to text file.
5. Now search for the Tenant name in the output (Text file) and find the "productGroupID" and “tenantSerial” associated with that and keep it aside to be used in next step.

b. Get NSM Access Code

1. Add another collection enter URL (https://api.mysonicwall.com/api/generate-cscaccesscode ) in the input field using ‘POST’ method.
   
2. Click on ‘Headers’ tab and add below keys and then click ‘Send’.
   Content-Type: application/json
   X-api-key: Enter the key received in step 1 above.
3. Click below on ‘Body’ and select ‘raw’ and type / enter below text.
   tenantID – ‘productGroupID’ from previous step.
   Syntax - {"tenantId": “InsertprodcutGroupID”,"tileName": "ISNSMSAFEENABLED"}
   
4. Now click on ‘Send’ and it will return ‘accessCode’ under Body.
   
5. Copy the ‘accessCode’ as that need to use in next step to Generate NSM Token.

Connect to NSM using Postman

a. Get NSM Bearer Token

1. Add another collection enter URL (https://nsm-uswest.sonicwall.com/api/manager/auth/sso ) in the input field using ‘POST’ method.
   
2. Click below on ‘Body’ and select ‘raw’ and type / enter below text as per syntax.
   tenantSerial: From step B.a.5
   Code: From step B.b.4
   Syntax:{"tenantSerial":"InsertSerial", "code":"InsertCode"}
3. Click ‘Send’ and will below response will show up under ‘Body’.
   
4. NSM bearer token info will be shown in ‘message’. Same need to be used for authentication when running NSM APIs

b. Using Token for NSM APIs.

Below example is to get ARP cache using NSM API for a firewall managed by NSM

1. Add new collection enter API URL (https://nsm-uswest.sonicwall.com/api/manager/firewall/reporting/arp/caches ) in the input field using either ‘GET’ or ‘POST’ method.
2. Go to ‘Authentication’ tab and select ‘Bearer Token’ from the drop down under Type and insert the value (from step C.a.4) in ‘Token’ field.
   
3. Go to ‘Headers’ tab and add below Keys
   Content-Type: application/json-
   X-device-id: Enter the Firewall Serial for which data in being pulled.
   
4. Click ‘Send’ and response from firewall will show up in ‘Body’ with details requested.