Get a platform context's connection to a 3rd Party Application
This endpoint can be used by your server to retrieve an access token for a specific context's (e.g. user or group) connection to a 3rd party application. It will automatically refresh expired access tokens if the corresponding service supports it.
If the context has not been provisioned, the endpoint will return a 404
status code.
If the context has not yet enabled the connection, the enabled
parameter of the connection
will be false
.
If the context has enabled the connection, but no access token is available, the access_credential
parameter of the authorization
will be empty, and the status
parameter will be something other than active
(most commonly error
).
If the context has multiple connections to a given service, the endpoint will return the "healthiest" connection (i.e. prefer connections that are enabled
and active
). If you're working with multiple connections, you should instead use Get Connection by ID.
See the Retrieving Access Tokens Guide for examples of how to use this endpoint.