Document toolboxDocument toolbox

Authentication

Pathfinder supports three different types of authentications. Depending on your needs and the support of your client library you can choose between the following authentication types:

  • API Keys

  • JWT

  • Basic authentication

 

API KEY

This authentication method allows any user with the correct permissions to create a special token via Pathfinder Client. This can be used in the authorization header for calls to the API to allow access to the API on behalf of the creator without requiring information about the user name and password. This is meant to be used in 3rd party applications that frequently access the API.

The API tokens can have different expiration dates depending on the properties set while creating them.

For more information, go to: Creating API key in Pathfinder client.

JWT

This authentication method requires the user to first login using user name and password and then store the token provided as a response. After that, the provided token is used in the authorization header for every call to the API to allow access to the API. The JWT tokens are only valid for 24 hours.

Basic authentication

This authentication method requires the user to login using a user name and password for every call to the API. In the request headers, you will see that the authorization header is going to pass a Base64 encoded string to the API, representing your username and password values, appended to the text "Basic". See RFC7617 for details.