The LYNKS API uses the OAuth2 password grant flow for authentication. This means that you will receive the following information during onboarding to allow you to authenticate with LYNKS:
username
: the name of your technical user; you can request multiple different technical users with different permissions if required;password
: the password of the technical user;client_id
: the OAuth2client_id
that corresponds to your LYNKS tenant is provided after onboarding and tenant creation.
With these parameters, you'll be able to retrieve an access_token
and a refresh_token
, as described below. These credentials are very sensitive information, so please keep them safe.
To authenticate with the APIs, you'll need to add it to the Authorization header as follows:
Authorization: Bearer ${access_token}