Documentation Powered by Redocly

Authentication Service

Download OpenAPI specification:Download

Access Token

Request an Access Token

Request Body schema:
password
required
string
username
required
string
client_id
required
string
client_secret
required
string
grant_type
string
Default: "password"
Enum: "password" "bio"

Responses

Request samples

Content type
{
  • "password": "string",
  • "username": "string",
  • "client_id": "string",
  • "client_secret": "string",
  • "grant_type": "password"
}

Response samples

Content type
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "token_type": "string",
  • "expires_in": 0
}

Logs user out by invalidating their refresh token

Request Body schema:
refresh_token
required
string
client_id
required
string
client_secret
required
string

Responses

Request samples

Content type
{
  • "refresh_token": "string",
  • "client_id": "string",
  • "client_secret": "string"
}

Response samples

Content type
{
  • "username": "string",
  • "message": "string"
}

Refresh an Access Token

Request Body schema:
refresh_token
required
string
client_id
required
string
client_secret
required
string

Responses

Request samples

Content type
{
  • "refresh_token": "string",
  • "client_id": "string",
  • "client_secret": "string"
}

Response samples

Content type
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "token_type": "string",
  • "expires_in": 0
}

Clients

Adds a Client to the System

Authorizations:
header Parameters
authorization
string
Request Body schema:
description
required
string
client_id
required
string
client_secret
required
string

Responses

Request samples

Content type
{
  • "description": "string",
  • "client_id": "string",
  • "client_secret": "string"
}

Creates SamlResponse encoded as base64 for the authenticated user and plan

Responses

Response samples

Content type
{
  • "acs_url": "string",
  • "saml_response": "string"
}

API Keys

Retrieve API Key Details

Request Body schema:
api_key
required
string

Responses

Request samples

Content type
{
  • "api_key": "string"
}

Response samples

Content type
{
  • "description": "string",
  • "api_key": "string",
  • "client_id": "string",
  • "created_at": 0
}

Request new API Key

Authorizations:
header Parameters
authorization
string
Request Body schema:
description
required
string
client_id
required
string

Responses

Request samples

Content type
{
  • "description": "string",
  • "client_id": "string"
}

Response samples

Content type
{
  • "description": "string",
  • "api_key": "string",
  • "client_id": "string",
  • "created_at": 0
}

SAML

Creates a Healthsparq SamlResponse encoded as base64 for the given plan participant

path Parameters
person-external-id
required
string

Responses

Response samples

Content type
{
  • "acs_url": "string",
  • "saml_response": "string"
}

Biometric

Register new biometric token. `device_id` identifies the device for a user so old biometric tokens related to that device can be removed. The same `biometric_token` can't be retrieved again, it's returned only once by the server.

Authorizations:
header Parameters
authorization
string
Request Body schema:
device_id
required
string

Responses

Request samples

Content type
{
  • "device_id": "string"
}

Response samples

Content type
{
  • "biometric_token": "string",
  • "expires_in": 0
}