Authentication and token refresh

Authentication verifies your digital identity and is required before you can make authorised requests to Tuum API endpoints.

Primary authentication

To verify your digital identity, use your credentials to access the authentication API endpoint at the base URL of your target environment.

Sample API call

For a detailed example, refer to the Authenticate employee sample call in the API cookbook.

Result

Upon a successful API call, you will receive a JSON Web Token (JWT) that authorises access to the Tuum API endpoints, based on the privileges assigned to the authenticated service principal.

Use the JWT as the value for the x-auth-token header parameter in any subsequent API calls within the Tuum system.

Token refresh

To refresh your expired JWT and get a new one without re-entering your username and password, use the authentication refresh API endpoint.

Sample API call

For a detailed example, please refer to the Refresh JSON Web Token sample call in the API cookbook.