Authentication

Guide for setting up tenant authentication for API endpoints.

Settings vill apply to all endpoints mapped to the selected tenant.

Create new tenant authentication

To create a new tenant authentication configuration, click (+) in the lefthand menu.

The following properties can be configured:

  • Name (logical name of this configuration, mandatory)
  • Description (optional)
  • Tenant (the tenant that applies for this configuration, mandatory)

Edit existing tenant authentication

To edit an existing endpoint configuration, expand authentication list and select the configuration in the left hand menu.

An authentication configuration is divided  three tabs; General, Execution flow and Advanced. General is displayed by default.

General

On the General tab you can see/change:

  • Name
  • Description

You can also view:

  • Tenant
  • Internal id
  • Created timestamp

Execution flow

The execution flow is the pipe providing the functionality of the API.

You can add, enable/disable, remove and reorder the valves of the pipe.

Authentication is successful if pipe is executed without error and returns a single item.

Advanced

In the advanced tab you can change the pipe of your configuration to an already existing pipe.

Use this function to convert old manually created configurations to guide configuration.

If you check Convert selected pipe, the selected pipe will be converted to a format that can be managed by guides.

If you check Remove previous pipe, the current pipe will be removed from the configuration when you save.