HomeAuthenticationCreate new JWT with valid refreshToken

Connect 5 - Authentication API

This page contains the details for the Client Services API. These are the public facing APIs that would allow a user to interact with our platforms.
Authentication

This section contains the details on the API to authenticate and obtain a JWT access token to call the APIs on this page.

The JWT will be used as the Bearer token to call any of the client-services APIs.

It will be short lived, thus each API request will need to be called with a new JWT via this auth API.

Parameters
emailRequired

Connect email

passwordRequired

Connect password

strategyRequired

legacyUser

posthttps://platform.businesswire.com/auth/login
A JSON object will be passed in that will contain the following:
{
  "email": "me@myemail.com",
  "password": "my-secure-password",
  "strategy": "legacyUser"
}
Response

On successful login, a statusCode of 200 will be returned and the JWT can be found in the Header with the key : x-auth-token.

A refreshToken will also be provided with the key x-refresh-token that will be used to create new access tokens.

Create new JWT with valid refreshToken

The following api is used to retrieve a new JWT, given an expired JWT and a valid refreshToken

Parameters
refreshTokenRequired

Refresh token

posthttps://platform.businesswire.com/auth/refresh

A JSON object will be passed in that will contain the following (example token):

{
  "refreshToken": "ckkslwrpb002g01ppmfqku6qv"
}
Response

On successful verification, a statusCode of 200 will be returned and the JWT can be found in the Header with the key : x-auth-token.