Skip to main content
POST
/
authentication
Get Authentication Token
curl --request POST \
  --url https://app.coverwhale.com/api/v1/authentication \
  --header 'Accept: <accept>' \
  --header 'AccessToken: <api-key>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "username": "j.doe@coverwhale.com",
  "password": "<string>",
  "new_password": "<string>",
  "refresh_token": "<string>"
}
'
{
  "AccessToken": "<string>",
  "RefreshToken": "<string>",
  "ExpiresIn": "3600"
}

Authorizations

​
AccessToken
string
header
required

AWS Cognito access token obtained from the /authentication endpoint. Token expires after 3600 seconds.

Headers

​
Content-Type
string
required
​
Accept
string
required

Body

application/json
​
username
string
required
Example:

"j.doe@coverwhale.com"

​
password
string
required

provided user password. Password reset can be used to recover account.

​
new_password
string
​
refresh_token
string

Can be combined with username to generate new AccessTokens.

Response

Authentication Success

​
AccessToken
string

Access Token, used for API calls.

​
RefreshToken
string

Refresh Token, used for re-authentication.

​
ExpiresIn
integer

Halflife for active AccessToken.

Example:

"3600"