Skip to main content

Overview

Allows the client to trigger a Quick Login procedure on a remote Neuron, without having to scan a QR code, and if successful, logging in on the machine using a given Legal Identity. Note: The call to the remote neuron does not require a login or an Agent API connection. Note 2: A Legal ID can be used to login on multiple machines. If administrative access is granted to the corresponding Legal Identity, an administrative login will also be performed, if the login is successful. Note 3: Only session logins (i.e. admin logins and quick-logins) can be made using this resource. No new JWT token will be generated, as the Agent API can only be connected to the broker associated with the account the agent is using. Note 4: You can prepare the the remote quick login procedure by calling the /Account/PrepareRemoteQuickLogin resource to get the Legal ID associated with the current account. Note 5: This method of initiating the Quick-Login does not require the client to scan a QR code. Instead, the request to sign the login is sent automatically to the client when the /Account/RemoteQuickLogin resource is called. If authentication succeeds, a quick-login is performed automatically in the current session, and if there is an administrative account associated with the digital identity, such a login is also performed in the current session.

HTTP request

POST /Agent/Account/RemoteQuickLogin

Authentication

Requires a valid JWT bearer token.

Request (JSON)

{
	"legalId":Required(Str(PLegalId)),
	"purpose":Required(Str(PPurpose))
}

Input parameters

ParameterDescription
PLegalIdThe Legal ID of the current user. This ID will receive the signature request in order to Quick-Login on the remote Neuron.
PPurposeThe purpose string to show to the user in the app.

Response (JSON)

{
	"loggedIn":Required(Bool(PLoggedIn)),
	"petitionSent":Required(Bool(PPetitionSent))
}

Response parameters

ParameterDescription
PLoggedInIf the user was already logged in on the machine. If this is true, no petition is sent and no Quick-Login is necessary.
PPetitionSentIf a petition was sent to the client with the corresponding Legal Identity.

Notes

This endpoint uses the request schema notation described in Pattern matching.