curl --request GET \
--url https://api.management.junction.com/v1/org/{org_id}/prepare_team_custom_credentials/{env}/{region} \
--header 'X-Vital-Org-Key: <api-key>'
{
"status": "no_action_needed",
"preparation_steps": [
{
"type": "redirect_uri",
"key": "<string>",
"value": "<string>",
"description": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Team Custom Credentials
Create Org Prepare Team Custom Credentials
Create or submit org prepare team custom credentials via the Junction API. Requires authentication with your team API key.
POST
/
v1
/
org
/
{org_id}
/
prepare_team_custom_credentials
/
{env}
/
{region}
curl --request GET \
--url https://api.management.junction.com/v1/org/{org_id}/prepare_team_custom_credentials/{env}/{region} \
--header 'X-Vital-Org-Key: <api-key>'
{
"status": "no_action_needed",
"preparation_steps": [
{
"type": "redirect_uri",
"key": "<string>",
"value": "<string>",
"description": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Junction Management API is available for the Scale plan.
The base URL of this endpoint is
https://api.management.junction.com/.The endpoint accepts only Management Key (X-Management-Key).
Team API Key is not accepted.curl --request GET \
--url https://api.management.junction.com/v1/org/{org_id}/prepare_team_custom_credentials/{env}/{region} \
--header 'X-Vital-Org-Key: <api-key>'
Authorizations
Path Parameters
Available options:
production, sandbox Available options:
us, eu Body
application/json
Available options:
oura, fitbit, garmin, whoop, strava, renpho, peloton, wahoo, zwift, freestyle_libre, abbott_libreview, tandem_source, freestyle_libre_ble, eight_sleep, withings, apple_health_kit, manual, ihealth, google_fit, beurer_api, beurer_ble, omron, omron_ble, onetouch_ble, accuchek_ble, contour_ble, dexcom, dexcom_v3, hammerhead, my_fitness_pal, health_connect, samsung_health, polar, cronometer, kardia, whoop_v2, ultrahuman, my_fitness_pal_v2, map_my_fitness, runkeeper, google_health Response
Successful Response
no_action_needed
No preparation needs to be done. You can apply the custom credential using the Set Team Custom Credentials API right away.
preparations_required
You should configure your OAuth application in accordance to the preparation steps provided, before calling the Set Team Custom Credentials API to apply the custom credential to your team.
Available options:
no_action_needed, preparations_required A list of steps which must be completed before applying the custom credential to your team through the Set Team Custom Credentials API.
Show child attributes
Show child attributes
Was this page helpful?