Retrieve an End User
GetEndUser returns the End User for the given ID. By default, this ID is assumed to be the external ID for the
user. If the identifier_type
query parameter is set to internal
, then the internal ID is used.
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
ID is the Versori identifier for the user. Most APIs will not use this field but instead reference users by their externalId.
ExternalID is the identifier for the user as determined by the organisation. This typically should be the same as the user's ID on the Primary Connector for the Hub. Regardless of the value, it must be unique within the Hub.
DisplayName is an optional human-readable name for the user. If not set, the default is an empty string.
The hub ID to which the user belongs to.
PrimaryConnection is the connection that the user will use to authenticate to the primary connector.
ID is the unique identifier of the Connection. Typically this is only used internally and most (if not all)
public-facing APIs will use the name
in combination with the Connector's id
instead.
Name is the name of the Connection. This must be unique within the owning Connector.
ConnectionCredentials defines the Action and Trigger credentials for the owning Connector. If multiple credentials are defined for each type, they are applied to the request in the order they are defined. This is to enable Connectors which require both a user session token and an API key to be provided in the request.
CreatedAt is the time the Connection was created.
UpdatedAt is the time the Connection was last updated.
CreatedAt is the time the user was created.
UpdatedAt is the time the user was last updated.