Retrieve an Embedded Integration
GetEmbeddedIntegration returns the Integration for the given ID to be displayed to the user in the embedded UI.
Path Parameters
UserID references an End User in the Hub.
Most APIs support setting this value to either the internal Versori identifier or their external ID as
determined by the organisation. The identifier_type
query parameter is used to indicate which type of ID is
being used.
Query Parameters
IdentifierType indicates whether the user_id
path parameter is a internal identifier created by Versori, or an
external identifier. If the value is external
, some endpoints also require the hub
query parameter to
identify the correct Hub.
internal
, external
Response
EmbeddedIntegration represents an integration that is available to an end user and contains all the necessary information for the UI to determine how the user should activate the integration.