Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Auth

Used to authenticate with the nation API in order to use private shards or nation commands. Private shards provide access to information that is only available to logged-in nations, while nation commands allow nations to perform actions that require being logged-in.

Hierarchy

  • Auth

Index

Properties

Optional autologin

autologin: undefined | string

The autologin string to be used to authenticate the nation API request. It is an encrypted version of your password that will keep working until your password is changed.

You probably don't know what this is initially. If updateAutologin is enabled, this value will be updated with the autologin string retrieved after the first request using this object.

Optional password

password: undefined | string

The password of the nation specified in the nation API request. This only needs to be provided if a PIN or autologin string is not specified.

Optional pin

pin: undefined | string

The PIN to be used to authenticate the nation API request. It will keep working until you log out, log in again, or go idle for two hours.

You probably don't know what this is initially. If updatePin is enabled, this value will be updated with the PIN retrieved after the first request using this object.

Optional updateAutologin

updateAutologin: undefined | false | true

If true, updates the value of autologin with the value of the X-Autologin header the first time this object is used in a request.

Optional updatePin

updatePin: undefined | false | true

If true, updates the value of pin with the value of the X-PIN header the first time this object is used in a request.

Generated using TypeDoc