Manage Tyk Dashboard Users

Dashboard users have twofold access to the dashboard: they can access both the Dashboard API and the dashboard itself, it is possible to generate users that have read-only access to certain sections of the dashboard and the underlying API. Dashboard users are not the same as developer portal users (a.k.a. developers). The credentials are stored independently and have different mechanics relating to registration, management and access. For example, it is not possible to log into the developer portal using a dashboard account.

Using Dashboard UI

To create a dashboard user from the GUI:

Select “Users” from the “System Management” section
Click “ADD USER”
Add the user’s basic details In this section:
- First Name: The user’s first name.
- Last Name: The user’s last name.
- Email: The email address of the user, this will also be their login username.
- Password: The password to assign to the user, this will automatically be hashed and salted before storing in the database. NOTE you need to inform the user about the password you have created for them.
- Active: Must be true for the user to have access to the dashboard or the dashboard API.
Set the user permissions You can be very specific with regards to which pages and segments of the Dashboard the user has access to. Some Dashboard pages require access to multiple parts of the API, and so you may get errors if certain related elements are disabled (e.g. APIs + Policies) Permissions are set and enforced when they are set on this page. They can either be read or write. If set to deny then the record is non-existent in the object (there is no explicit “deny”). This means that if you set deny on all options it looks as if they have not been written, but they will still be enforced so long as even one read or write option has been set.
Click “Save” The user will automatically be created, as will their API Access token, which you will be able to retrieve by opening the user listing page again and selecting the user’s username.

Using Dashboard API

To authenticate requests to the Tyk Dashboard API, you will need to provide an API Key in the Authorization header. This is your Tyk Dashboard API Access Credentials, which can be found on the user detail page:

You can create a user with a call to the POST /api/users endpoint, for example:

curl -H "Authorization: {YOUR-TYK-DASHBOARD-API-ACCESS-CREDENTIALS}" \
 -s \
 -H "Content-Type: application/json" \
 -X POST \
 -d '{
  "first_name": "Test",
  "last_name": "User",
  "email_address": "test@testing.com",
  "active": true,
  "user_permissions": {
      "IsAdmin": "admin"
  },
  "password": "thisisatest"
 }' http://{your-dashboard-host}:{port}/api/users | python -mjson.tool

In this example, we have given the user Admin privileges. To see a detailed breakdown of permission objects, please see below. You will see the following response to confirm that the user has been created:

{
  "Message": "User created",
  "Meta": null,
  "Status": "OK"
}

The user is now active.

Manage User Passwords

You can change your password in these circumstances:

If you have forgotten your password
If you wish to change your password

Forgotten Your Password?

If you have forgotten your password, you can request a password reset email from the Dashboard Login screen:

Enter your login email address, and you will receive an email with a link that enables you to create a new password.

This link will only be valid for 1000 seconds
You will need to configure your outbound email settings to enable this feature.

Change Your Password

If you wish to change your current password, from the System Management > Users screen, select Edit for your Username.

You will not be able to change the password for other Dashboard users.

From your user details, click Reset Password:

Enter your current and new password (and confirm it) in the dialog box that is displayed, and click Reset Password. You will automatically be logged out of the Dashboard and will have to enter your username and new password to log back in.

Search Users

You can search for a user (by email address) by entering the address in the search field. The user list will automatically refresh with that user being displayed.

Password Policy

Tyk allows you to control password requirements for Dashboard users, developers (i.e. users registered to the developer portal) and basic auth keys. Please note: This configuration is enforced by the Tyk-Dashboard and as such is not available in the Tyk Open Source Edition. Also, since it requires access to the Tyk Dashboard installation folder, it is currently not available for Tyk Cloud clients. There are other security options available from the Dashboard config file. See the security section for more details. You can find the configuration files in the schemas directory of your Tyk Dashboard installation folder, as follows:

For Dashboard users you define policy in schemas/password.json
For developers you define policy in schemas/developer_password.json
For basic auth keys you define policy in ./schemas/basic_auth.json

The following validators are available:

minLength - sets minimum password length
multiCase - boolean, upper and lower case characters are required
minNumeric - minimum number of numeric characters
minSpecial - minimum number of special characters, like @, $, % etc.
disableSequential - boolean, disable passwords which include at least 3 sequential characters. For example: abc, 123, 111, xxx etc.

Below is an example of password.json file, with all options turned on:

{
  "title": "User password schema",
  "type": "string",

  "minLength": 6,
  "multiCase": true,
  "minNumeric": 2,
  "minSpecial": 2,
  "disableSequential": true
}

Overview

API Governance

Dashboard Analytics

User Management

Tyk Identity Broker (TIB)

Guides

Reference

Manage Tyk Dashboard Users