Get connectionsoauth2callback
FinaliseConnectionCallback is the redirect URL to exchange an authorization code for an access token in an OAuth2.0 authorization code grant. It must be noted that the real callback URL configured with the OAuth2.0 provider should be a Switchboard URL (prompted to the user at app-creation time) and not this API URL.
Query Parameters
This value is generated by the /organisations/{organisationId}/connection-init operation and is an opaque
string and should have no meaning to external clients. Internally, it's used to verify the flow was
initialised by Switchboard and connect the authorisation grant to the user/organisation who initiated it.
Response
CreateCredentialResponse is the response containing the new credential.
Credential holds sensitive data not owned by Versori. Users can create credentials so that Versori systems can authenticate to external services on behalf of the user.
Type provides additional context to what data the credential contains. Certain types dictate that certain fields must be set in order for the credential to be considered valid:
- "Default" is the default type for a Credential. Data may contain arbitrary properties and will always be considered valid.
- "OAuth2Refresh" signifies the credential is to be used for issuing OAuth 2.0 access tokens based on a refresh token. The credential data must json-marshal into a CredentialDataOAuth2Refresh in order to be valid. Credentials of this type may only be created or updated via the connections APIs, not by the credentials APIs.
- "Raw" signifies the credential contains a value which can be used until the credential expires (or never if the credential has no expiry). The credential data must json-marshal into a CredentialDataRaw in order to be valid.
- "BasicAuth" signifies the credential contains credentials to be used in HTTP Basic authentication schemes. The credential data must json-marshal into a CredentialDataBasicAuth in order to be valid.