Version 3 has been released!

{AUTH} command

The {AUTH} command presents some authorization credentials/token to the other computer. It is up to the receiving computer to validate the tokens

Syntax

{AUTH} type ID ␑ token

  • type - type of token
    • R = Registration token
    • S = Server token
    • W = Write permission. Authorizes data to be saved to permanent storage.
  • ID - identifying key (usually the unique ID of the RemoteSign presenting the credentials)
  • token - an auth token. If empty, it means no token has been provided for that type and the receiving side should interpret that as a request for a token to be issued.
Use the {AUTH?} command to request the presentation of a token via the {AUTH} command.
When a RemoteSign connects to a RemoteSign server as a client, it will present its server token.

Note: Generally one only needs to send an {AUTH} command once per connection session. The other side should store a valid token. Repeatedly sending invalid tokens won't provide any benefit. This is especially so when no token is present as a token request will likely involve some authorization gesture from someone at the other end.

See also: {TOKEN} {AUTH?}

Overview and list of all RemoteSign commands: API reference

Supported by:
RemoteSign Windows v3.6 (any type)
RemoteSign Sequencer v3.5 (any type)
RemoteSign ESP v3.5 (types R and S)
Arrivals & Departures v2.1 (type R)