@keiser/metrics-sdk-sso-typescript

@keiser/metrics-sdk-sso-typescript@5.0.30

Project

This SDK facilitates communication between a client system (ie: phone app, website, server) and Keiser Metrics. The SDK is written in TypeScript and supports both browser and NodeJS platforms.

Installation

Navigate to the folder of your consuming project and install with npm:

npm install @keiser/metrics-sdk-sso-typescript@5.0.30 --save

Getting Started

Please follow the installation instruction and execute the following JS code:

import { MetricsSSOApi } from '@keiser/metrics-sdk-sso-typescript';

var api = new MetricsSSOApi()

let body:MetricsSSOApiAcceptedTermsVersionShowRequest = {
  // number (optional)
  userId: 8.14,
  // string (optional)
  apiVersion: apiVersion_example,
};

try {
  const data = await api.acceptedTermsVersionShow(body);
  console.log('API called successfully. Returned data: ' + data);
} catch (error) {
  console.error(error);
}

Documentation for API Endpoints

All URIs are relative to https://metrics-api-v3.keiser.com/api

Method	HTTP request	Description
acceptedTermsVersionShow	GET /auth/accepted-terms-version	Show a user accepted terms version
acceptedTermsVersionUpdate	PUT /auth/accepted-terms-version	Update a user accepted terms version
authConnect	POST /auth/connect	Connect a user to auth using email and password
authElevate	POST /auth/elevate	Elevate user session to Global ACL
authExchangeFulfillment	POST /auth/exchange/fulfillment	Exchanges an authorization token for access and refresh tokens
authExchangeInit	POST /auth/exchange/init	Generate an exchange token
authFacilityWelcomeFulfillment	POST /auth/facility/welcome/fulfillment	Fulfills a facility's user creation process
authKeepAlive	POST /auth/keep-alive	Keeps a user's tokens alive
authLogin	POST /auth/login	Login a user using email and password
authLogout	POST /auth/logout	Logout user by blacklisting token
authResetFulfillment	POST /auth/reset/fulfillment	Fulfills a user's credential reset request
authResetRequest	POST /auth/reset/request	Request to reset a user's credentials
authSetFacility	POST /auth/set-facility/{facilityId}	Sets the target facility for a user
authUpdate	POST /auth/update	Update a user's credentials
authUserInit	POST /auth/user/init	Initialize a new user
authUserInitFulfillment	POST /auth/user/init/fulfillment	Fulfill a new user initialization
authValidateReturnRoute	GET /auth/validate/return-route	Validates redirect url for known good routes
basicCredentialCreate	POST /auth/basic-credential	Create auth using email and password for user
basicCredentialUpdate	POST /auth/basic-credential/update	Update a user's credentials
emailAddressValidationFulfillment	POST /user/email-address/validation-fulfillment/{validationToken}	Fulfills a user's email validation process
heightMeasurementCreate	POST /user/height-measurement	Create a user height measurement
oauthAuthorize	POST /oauth/authorize	Authorizes a third party application
oauthDeauthorize	DELETE /oauth/deauthorize	Deauthorizes an oauth user
oauthInitiate	POST /oauth/initiate/{service}	Initiates OAuth access request and return parameters
oauthServiceDelete	DELETE /oauth/service/{id}	Delete a user's oauth service connection
oauthServiceList	GET /oauth/service/list	List a user's oauth service connections
oauthServiceShow	GET /oauth/service	Show a user's oauth service connection
oauthServiceSubscriptionCreate	POST /oauth/service/subscription	Create a oauth service subscription
oauthServiceSubscriptionDelete	DELETE /oauth/service/subscription/{id}	Delete a oauth service subscription
oauthServiceSubscriptionList	GET /oauth/service/subscription/list	List oauth service subscriptions
oauthServiceSubscriptionShow	GET /oauth/service/subscription	Show an oauth service subscription
oauthToken	GET /oauth/token	Returns tokens for third party oauth
profileUpdate	PUT /user/profile	Update a user profile
weightMeasurementCreate	POST /user/weight-measurement	Create a user weight measurement

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

Type: Bearer authentication (JWT)

Copyright and License

The Keiser Metrics SDK source code and distributed package are made available through the MIT license.

Using any of the APIs made available through the Keiser Metrics SDK to communicate with Keiser Metrics make you subject to the following agreements. Please read all documents in their entirety as they govern your use of the APIs and Keiser Metrics servers.

@keiser/metrics-sdk-sso-typescript