Interfaces
Version 27 Version 26 39.5.25 39.5.23 39.5.22 39.5.21 39.5.20 39.5.19 39.5.18 39.5.17 German English
Interfaces
Version 27 Version 26 39.5.25 39.5.23 39.5.22 39.5.21 39.5.20 39.5.19 39.5.18 39.5.17 German English
Breadcrumbs

Manage API Tokens MOD009DMN

Introduction

  • PLANTA link → Web Interfaces → Configuration → Web Interfaces → Manage API- token button → Manage API Tokens

  • PLANTA link → Web Interfaces → Manage API Tokens

Information

  • In this module, new tokens are generated or existing tokens are assigned to the web interfaces.

Procedure: generate a new token

  • Open the Manage API Tokens module. As a result, an empty record is already displayed for a new token.

  • Add a name or description in the Note field and save. The ID for the new token is generated automatically.

    • If the module is opened directly from the configuration of a web interface and a new token is generated, it is automatically assigned to the opened web interface.

  • A token can be set to invalid by

    • manually deactivating the Valid checkbox or

    • specifying an expiration date in the up to field on which the Valid checkbox is automatically deactivated (controlled by an event).

Procedure: assign a token to a new web interface

  • Open the Manage API Tokens module.

  • Right-click on a token and select Insert → API token assignment from the context menu.

  • Save. The assigned web interface is immediately visible below the token record.

Details

  • It is possible to assign a token to several web interfaces.

  • There can be several tokens for different groups of web interfaces.

  • It is, e.g., possible to generate a token and to use it for all Jira end points or all PLANTA pulse end points to establish a convenient connection to an external system.

  • It is now possible to set the API tokens for pulse/Jira) via environment variables.

    • planta__server__api_token__pulse = ac52d48bc316424f8f541b3855552d7e

    • planta__server__api_token__jira = 187658bcc7c14817b4679fd58581c3ec

    • The API token must correspond to the format of a UUID. When the erver starts, the token is displayed. If a token has already been assigned, nothing happens.