CH logo® Knowledge Base
Contents Search
   

 

User Admin

Note: These settings are accessed via the Admin menu, which is displayed to Admin users only (hidden from Member users).

The setup of users in the Kentik portal is discussed in the following topics:

Note: If you would like assistance with any aspect of registering a user, please email us at support@kentik.com.

 

 
 top

About Users

A user is anyone at your company that is given authorization to access Kentik. Kentik supports two levels of users:

  • Administrator: Can perform all actions.
  • Member: Can view all data but have no access to the Admin menu (e.g. cannot add or edit users or devices).

Note: An Administrator can apply a filter in the user settings of any other user (see User Filters).

 

 
 top

Users Page

The Users page is home to the User List, which lists the users that are currently registered for your organization. To open the Users page, choose Admin from the Kentik navbar, then Users from the sidebar at left. Details of the Users page are covered in the following topics:

Note: The Users page is visible only to users whose level is Administrator.

 

 
 top  |  section

Users Page UI

The Users page has the following main elements:

  • Filter field: Enter text to filter the User List. The Full Name and Email columns are checked for a match on the string entered in this field.
  • Add User button: Opens the Add User dialog (see User Admin Dialogs).
  • User List: A table listing your organization’s currently registered users (see User List).

 

 
 top  |  section

User List

The User List is a table that lists all existing users for a given customer. The table provides the following information and actions for each user:

  • ID: The system-generated unique ID assigned when the user was registered.
  • Full name: The user’s full name.
  • Email: The user’s email address.
  • Level: The user’s level: Administrator or Member (see About Users).
  • Last login: The date of the user’s most recent login.
  • Delete: Opens a confirming dialog that allows you to remove the user from Kentik.

Click on a column heading to sort the list (ascending or descending).

Note: To see additional information about a given user, click anywhere in the row for that user, which opens an Edit User dialog in which you can review and edit settings (see Editing a User).

 

 
 top

User Admin Dialogs

Adding or editing a user via the Kentik portal involves specifying information in the fields of the user admin dialogs, which are covered in the following topics.

Note:
- User admin dialogs are visible only to users whose level is Administrator.
- Users can also be added and edited with the User API.

 

 
 top  |  section

About User Dialogs

The Kentik portal uses user admin dialogs to collect and display user information. The required information is entered into the fields of either of the following dialogs:

  • Add User when registering a new user with Kentik.
  • Edit User when editing an already registered user.

 

 
 top  |  section

User Dialogs UI

The Add User and Edit User dialogs share the same layout and the following common UI elements:

  • Close button: Click the X in the upper right corner to close the dialog. All elements will be restored to their values at the time the dialog was opened.
  • Remove button (Edit User dialog only): Remove the user from your organization’s collection of Kentik-registered users. This button is only present if the user being edited was manually added.
  • Cancel button: Cancel the add user or edit user operation and exit the dialog. All elements will be restored to their values at the time the dialog was opened.
  • Add User button (Add User dialog only): Save settings for the new user and exit the dialog.
  • Save button (Edit User dialog only): Save changes to user settings and exit the dialog.

 

 
 top  |  section

User Field Definitions

User admin dialogs (Add User and Edit User) contain the elements shown in the following table.

Element Type Description
Email address Editable field The user’s email address.
Full name Editable field The user’s full name.
User level Drop-down menu Administrators can perform all actions.
Members can view all data but have no access to the Admin menu (e.g. cannot add or edit users or devices).
API token
(Edit User only)
Text field A Kentik-generated string that is used to authenticate the user in an HTTP header (X-CH-Auth-API-Token).
Reset API Token Button Generates a new API token, which is displayed in the API Token field.
2-Factor
(Edit User only)
Button or text If 2-factor authentication is enabled (see User Authentication), the button disables it.
If it’s not enabled, the text says it’s disabled.
Product updates Toggle switch Check to receive email updates from Kentik about the product (e.g. updates to features, interface, capabilities, etc.).
Service updates Toggle switch Check to receive email updates from Kentik about service status (e.g. scheduled maintenance, etc.).
Add Filters Button Opens the Filtering dialog to enable the application of filters that limit the traffic seen by the user (see User Filters).

 

 
 top  |  section

User Filters

User-based filtering allows the application of one or more filters that restrict the data that can be queried by a given user. Because the Admin menu is not available for Members, only Administrators can set user filters. The intent is to enable control by Administrators over the data that can be accessed by specific Member users.

User filters are set from a dialog accessed via the Add Filters button on the Add User or Edit User dialog. The interface for setting a user filter is the same as the Filtering dialog accessed via the sidebar on portal pages such as Data Explorer (see Filtering Pane Settings). Both Saved Filters and Filter Groups can be applied.

Once a user-filter is associated with a given user it is systematically appended (ANDed) with any query run by that user, including:

  • Data Explorer or Dashboard queries in the Kentik Detect portal.
  • SQL queries from the portal’s Query Editor or via PostgreSQL clients.
    Note: This feature is available only to organizations with SQL enabled. For additional information, contact Kentik support.
  • Queries via Kentik APIs (see Query API).

One use case for a user filter would be to allow certain Members to only query data from routers whose description contains “backbone.” Another use case would be to allow certain Members to only query data for interfaces whose description contains CUSTOMER and that have been assigned to the sites Ashburn DC3 and Ashburn DC4 (see About Sites).

 

 
 top

Add or Edit User

Users are added and edited via the Users page of the Kentik Detect portal (choose Admin from the Kentik navbar, then Users from the sidebar at left). Adding and editing users is covered in the following sections:

Note: The Users page is visible only to users whose level is Administrator.

 

 
 top  |  section

Adding a User

To register a new user on Kentik Detect:

  1. Open the Users page (choose Admin from the Kentik navbar, then Users from the sidebar at left).
  2. Click the Add User button to open the Add User dialog.
  3. Specify the values of the fields in the dialog (see User Field Definitions).
  4. If the new user is a Member, specify any desired User Filters.
  5. Save the new user by clicking the Add User button (lower right).

 

 
 top  |  section

Editing a User

To edit the settings for an existing user:

  1. In the User List, click in the row of the user that you’d like to edit. The Edit User dialog will open.
  2. Edit the user settings:
    - Change any fields that you’d like to modify (see User Field Definitions).
    - If the user level is Member, change any User Filters.
    - To reset the API token, click the Reset API Token button. A new token will appear in the field.
  3. To save changes, click the Save button (lower right).

To remove the user from your organization’s collection of Kentik users, click Remove (lower left).

 

 
 top

User Profile

The User Profile, which displays current customer-wide and user-specific settings, is covered in the following topics:

 

 
 top  |  section

User Profile Page

The User Profile page (a.k.a. “Your Profile”) is organized as a collection of cards that each represent different categories of information, some of which is editable, related to the user and the organization (see topics below). To access the page, hover over your user name at the right of the main Kentik navbar, then choose My Profile from the menu.

 

 
 top  |  section

User Information

This card displays information specific to the individual user (editable where indicated):

  • Level (read-only field): Administrator or Member (see About Users).
  • Full name (editable field): The user’s full name as specified when the user was added or last edited.
  • Email (editable field): The email address specified when the user was added or last edited.
  • Update User Information (button): Saves any changes made to user information.

 

 
 top  |  section

User Notifications

The following user profile settings relate to notifications, both those that appear in the portal and those that can be emailed to the user:

  • Service updates (toggle switch): Determines whether notifications about service status (e.g. scheduled maintenance, outage, etc.) will be:
    - Emailed to the user.
    - Displayed in the portal during an active session (even with switch off, notifications will be displayed at login).
  • Product updates (toggle switch): Determines whether notifications about the product (e.g. updates to features, interface, capabilities, etc.) will be:
    - Emailed to the user.
    - Displayed in the portal during an active session (even with switch off, notifications will be displayed at login).
  • BGP session events (toggle switch): Determines whether the user will receive emails when there is a non service-affecting interruption (flap) in BGP.

 

 
 top  |  section

User Default Settings

The following user profile settings enable customization of the user experience in the portal:

  • Historical overlay (toggle switch): Determines whether the Historical Overlay display setting in Data Explorer is enabled by default.
  • rDNS lookup (toggle switch): Determines whether reverse DNS (rDNS) lookups are performed when querying IPs. Disabling this option will speed up IP queries.
  • Time zone (toggle switch): The time zone in which times are expressed, either UTC or local.
  • Landing page (radio buttons): Determines which page the Kentik Detect portal will go to after login:
    - Data Explorer (default): Data Explorer with default sidebar settings.
    - Alerting: The Active Alerts page.
    - Dashboard: A dashboard chosen from the resulting drop-down list.
    - Saved view: A saved view chosen from the resulting drop-down list.
  • Update Landing Page (button): Updates the landing page setting to the currently selected radio button.

When Landing Page is set to Dashboard or Saved View, a button (Select Dashboard or Select View) will appear at the right of the card. To choose a specific page, click the button to open a dialog that lets you select from available dashboards or saved views. The list can be sorted by clicking on its headings. It can also be filtered with the filter field or by using the following buttons across the top:

 

 
 top  |  section

User Authentication

The following user profile settings support user authentication for Kentik APIs.

  • Initiate Password Reset (button): Click to send password reset instructions to the email address associated with this user.
  • Enable YubiKey (button): For additional security, Kentik enables authentication via YubiKey, a hardware authentication device manufactured by Yubico that supports one-time passwords, public key encryption and authentication, and the Universal 2nd Factor protocol developed by the FIDO Alliance.
  • Enable TOTP (button): For additional security, Kentik offers time-based one-time password (TOTP) authentication. Click this button to open the TOTP registration pane.
  • API Token (read-only field): A Kentik-generated string that is used to authenticate the user in an HTTP header (X-CH-Auth-API-Token).
  • Reset API Token (button): Generates a new token, which will be written to the API Token field.

Note: If a security note is displayed just under the API token field then on the Access Control page (Admin » Access Control) the access setting for the API subsystem is set to allow only specified APIs.

 

 
 top  |  section

User KDE Information

Information enabling users from your organization to access data from KDE without going through the Kentik Detect portal (KDE Access via PostgreSQL):

  • KDE host:port: A Kentik-assigned host:port through which the user can access the KDE datastore.
  • KDE user: A Kentik-assigned unique identifier for the customer to which the user belongs.
  • KDE password: A Kentik-assigned password with which the user can access the KDE datastore.
  • PSQL command line: The commands with which the user can access the Kentik Data Engine (KDE) datastore in psql (command line PostgreSQL client).
    Notes:
    - The -W parameter should be passed in with no value, and the value shown for the parameter should be entered in response to the prompt that will result from the initial command.
    - This feature is available only to organizations with SQL enabled. For additional information, contact Kentik support.
 

In this article: