DynID Portal assigns permissions to your users based on group membership inside the DynID Portal. In order to use some Dyn product APIs, you need to have access to an API User account in the DynID Portal along with the correct permission group(s).

This document covers the details of creating an API user and API Key for using the APIs, Resetting an API Key, and Finding the DynID of an API User.

NOTE: In order to view the Company > API Users view, your DynID must have DynID Admin group permissions in DynID portal.

 

 


Creating an API User

 

 1. See the help topic Managing DynID Group Permissions for general instructions on setting up DynIDs with specific permissions. Managing DynID Group Permissions
2. Instead of selecting Company > App Users in step 3 of Managing DynID Group Permissions, select Company > API Users. API Users menu item
 3. Selecting API Users opens the API Users page. Select Create API User
 4. Click the Create API User button at the top of the page. Create API User button
 5. Assign a name and groups to the API User.

NOTE ABOUT GROUPS:

To use the APIs, users will need to assigned specific Groups based on the API they will be using. Assign the following Groups to grant permission to each API:

DNS API:

  • API
  • Zone Management (Read)
  • Zone Management (Write)

Traffic Steering Policies API:

  • API
  • Traffic Steering: Policies
  • IPM – Asset Management

DNS Reporting API:

  • API
  • DNS Reporting

Email API:

  • API
  • Email
  • Email Admin (grants administrative privileges to user)

For Discovery and Attribution API:

  • API
  • II Attribution API

For Internet Intelligence – Routing Alerts API:

  • API
  • II Routing Alert API (Write)
  • II Routing Alert API (Read)

Internet Intelligence – Performance Alerts API:

  • API
  • II Performance Alert API (Write)
  • II Performance Alert API (Read)

This process is the same as step 6 of Managing DynID Group Permissions.

NOTE: You will need to have the appropriate entitlements added to your Dyn account to access the Groups necessary for your API. If you do not see the API Groups available for your product, please contact Dyn Support.

Add API User
6. Click Add to create the API User. Add Answer button
7. Unlike non-API users, the DynID is assigned to your API User. This DynID is the username you will use to access this API.

Record your DynID for the API User.

The API User DynID can be found in the Company > API Users view, in case you misplace the DynID.

API User Added Successfully
 8.  Along with the assigned DynID, you will need an API key to access the API. Click the Generate API Key button to create your API Key.

API Keys cannot be recovered, but can be regenerated.

Generate API Key button
 9. The API Key is shown in the yellow colored box (inside a red square in our example).

NOTE: Record this API Key. This is the only time and place where you will be able to see this API Key. If you lose your API Key, return to the Company  > API Users view to reset your API Key.

API Key Generated
 10. Close the window after you have recorded the API Key. Close button

 


Resetting an API Key

 

 1. In the DynID portal, select Company > API Users. API Users menu item
2. Select the API user to reset the API Key. Select API User
 3. Click Reset API Key in the left pane. Click Reset API Key
 4. Click Proceed to create a new API Key for this API User.

NOTE:  If there is an automated script or program that uses this API User and API Key to access the API, you will need to edit it and replace the API Key with this new one. Otherwise, the script or program will fail the next time it runs.

Click Proceed
 5. Click the Generate API Key button to create your API Key.

API Keys cannot be recovered, but can be regenerated.

Generate API Key button
6.The API Key is shown in the yellow colored box (inside a red square in our example).

NOTE: Record this API Key. This is the only time and place where you will be able to see this API Key. If you lose your API Key, return to the Company  > API Users view to reset your API Key.

New API Key Generated
 7. Close the window after you have recorded the new API Key. Close button

 


Finding an API User’s DynID

 

 1. In the DynID portal, select Company > API Users. API Users menu item
2. Select the API user to see the DynID. Select API User
 3. Find the Personal Information section in the left pane. API Users left pane view
 4. Click the phrase Click to Expand to view the DynID for this API User. Click to Expand
 5. The DynID displays in the screen and in a pop-up. API User DynID