syncTokenAndHost (Command)

Mis à jour le 16 Dec 2024
2 Minutes à lire

Partager
Sombre
Lumière
PDF

The content is currently unavailable in French. You are viewing the default English version.

Résumé de l’article

Avez-vous trouvé ce résumé utile ?

Merci pour vos commentaires

Availability: OneSpan Authentication Server 3.22 and later
Scenario: Authentication (SSM, HSM)

The syncTokenAndHost command synchronizes the server time with the authenticator time, or the server event counter with the authenticator event counter. It supports MDL authenticator instances and hardware authenticators. The synchronization requires two consecutive authenticator responses. The authenticator responses must either be Response-Only or 1-step Challenge/Response. 2-step Challenge/Response is not supported.

The respective user account must not be expired or locked, user auto-unlock is not supported by this command. However, if the responses are invalid, the user lock count is increased and the user account can get locked!

Only one authenticator can be synchronized at a time, but all authenticator applications of the authenticator will be synchronized. The authenticator and the authenticator applications must be allowed by the effective policy and must not be expired.

Parameters

Table: syncTokenAndHost input parameters
Parameter name	Data type	Description
componentType	String	Required. The component to use to serve this command.
user	UserInput	Required. Specifies the user who owns the authenticator (see Table: UserInput (Data type)). The user account must be active and must not be locked.
credential	MultiCredentialInput	Required. The user credentials.

Table: syncTokenAndHost output parameters
Parameter name	Data type	Description
status	CommandStatusResponse	Required. The error stack, if applicable, which indicates that the command has not completed successfully. This also includes the result and status codes returned by the command.
result	SyncTokenAndHostResult	Required. The output field for this command.

UserInput (Data type)

Table: UserInput (Data type)
Element name	Data type	Description
userID	String	The user ID.
domain	String	Optional. The user domain.

MultiCredentialInput (Data type)

Table: MultiCredentialInput (Data type)
Element name	Data type	Description
otp1	DigipassMultiCredentialInput	Required. The first authenticator response, either Response-Only or 1-step Challenge/Response.
otp2	DigipassMultiCredentialInput	Required. The second authenticator response, either Response-Only or 1-step Challenge/Response.
serialNumber	String	Optional. The serial number of the authenticator to synchronize. The authenticator must be allowed by the effective policy and must not be expired. Can be omitted if the user has exactly one authenticator assigned.
pin	String	Optional. The server PIN of the authenticator if used.

DigipassMultiCredentialInput (Data type)

Table: DigipassMultiCredentialInput (Data type)
Element name	Data type	Description
response	String	Required. The generated one-time password (OTP).
challenge	String	Optional. The challenge generated for a 1-step Challenge/Response operation. Choice element, only challenge or challengeKey can be present.
challengeKey	String	Optional. The key referring to the generated challenge generated for a 2-step Challenge/Response operation. Not supported by syncTokenAndHost. Choice element, only challenge or challengeKey can be present.

SyncTokenAndHostResult (Data type)

Table: SyncTokenAndHostResult (Data type)
Element name	Data type	Description
user	UserOutput	The returned user information (see Table: UserOutput (Data type)).
credentials	CredentialOutput	The serial number of the used authenticator.

UserOutput (Data type)

Table: UserOutput (Data type)
Element name	Data type	Description
userID	String	The resolved user ID.
domain	String	The user domain.
orgUnit	String	Optional. The organizational unit of the user.

CredentialOutput (Data type)

Table: CredentialOutput (Data type)
Element name	Data type	Description
serialNumber	String	Optional. The serial number of the authenticator used for the operation.

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Authentication">
  <soapenv:Header/>
  <soapenv:Body>
    <aut:syncTokenAndHost>
      <componentType>Authentication Sample Client</componentType>
      <user>
        <userID>Jane Doe</userID>
        <domain>Master</domain>
      </user>
      <credential>
        <opt1>
          <response>123456</response>
        </otp1>
        <opt2>
          <response>654321</response>
        </otp2>
        <serialNumber>1234567890</serialNumber>
      </credential>
    </aut:syncTokenAndHost>
  </soapenv:Body>
</soapenv:Envelope>

Cet article vous a-t-il été utile ?

What's Next

updatePassword (Command)

Table des matières

Parameters
Example