Connections

Connect a service with its sign-in

For a service whose connect shape is credentials. The password is exchanged once for the service's session and never stored. Sign-in attempts are rationed; nothing retries one on the athlete's behalf. code_required means the service sent a one-time code, for verifyCode.

post/integrations/{provider}/credentials

Request

  • Base URL: https://bodylab.lol/api/v1
  • URL: https://bodylab.lol/api/v1/integrations/{provider}/credentials
  • Auth: HTTP bearer

Path parameters

providerstring required

A connected service. Known values: garmin, oura, apple_health. Treat unknown values as "other".

Headers

X-Client-Platformstring

The native client's platform, e.g. ios. Server-side and non-native callers omit it.

X-Client-Versionstring

The native client's own semver version. With X-Client-Platform, a version below that platform's minimum is refused with CLIENT_UPGRADE_REQUIRED (426).

Request body

identifierstring required

The account's sign-in name; an email where identifierIsEmail.

passwordstring required

Response

OK

statusstring required

Where the sign-in got to. Known values: connected, code_required. Treat unknown values as "other".

Changes

No recorded changes to this operation across all 1 revision of this API.