API Tokens and Technical Users

Overview

LeanIX provides a variety of services which can be leveraged via our Available APIs. In order to authenticate calls to these APIs, an API Token is necessary.

API Tokens generated by individual ADMINS and Technical Users both provide credentials utilized within the authentication flow but they have some key distinctions.

While API Tokens created by individual Admin accounts can be accessed exclusively by the individual account holder, Technical User-generated API Tokens give ALL Admins in the workspace the ability to view the history and manage properties. This flexibility may be desirable for auditing purposes, as well as for managing organization-facing projects and integrations.

Note

At this time, Technical Users can be used exclusively with the Integration API, Webhooks and the GraphQL API. They cannot be utilized with the other available REST APIs.

Summary

Functionality
Technical User
API Token created under an individual account

Detailed history available to all ADMINS

Yes

No

Accessible to all ADMINS

Yes

No

Ability for all ADMINS to edit expiration date and other information

Yes

No

Ability to define the scope of authorization as READ-only. While at the same time still allow for the ability to create an API token.

Yes

No, all API tokens generated by individual ADMIN users are also ADMIN level tokens with read and write access.

Steps to Create a Technical User

In order to create a Technical User you must be an ADMIN.

  • Navigate to the Administration area
  • Select Technical Users
  • Click Create Technical User
  • Enter Name, Permission and specify the Expiration Date
  • Click Save, and the Technical User is created

Management

To see a history for a specific Technical User and to take other actions such as edit or delete, navigate to the Administration area and select Technical Users. Find the Technical User you are interested in. Options available for managing Technical Users are below:

Functionality
Details

Edit

Allows for the update of the description, change of expiration and permission (ADMIN, MEMBER, VIEWER)

Replace

Replaces the api token

Delete

Deletes the Technical User

History

Behavior including CRUD actions are logged and monitored.

Changes made on the technical user itself, from creation and any edits are also logged.

Updated 3 months ago


API Tokens and Technical Users


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.