Overview

Inspect authentication information for a provided auth token.

Client

No require permission rules.

HTTP

GET /getAuthInfo?authToken=authToken

Request Query Parameters
CodeTypeRequiredDescription
authTokenstringtrueAuthentication token to inspect. Get from See Authenticate
Response Body

200 Ok

CodeTypeRequiredDescription
errorstringError message returned when the auth token cannot be inspected.
dataAuthInfoResponseAuthentication metadata resolved from the token. See AuthInfoResponse
AuthInfoResponse
CodeTypeRequiredDescription
gnTokenstringtrueGearN token value.
userIdstringtrueUser id bound to this auth token.
isRemovebooleantrueWhether the token has been removed or invalidated.
tsExpirenumbertrueToken expiration timestamp in milliseconds.
otherDatasGNHashtabletrueAdditional token metadata. See GNHashtable
tsCreatenumbertrueToken creation timestamp in milliseconds.
secretKeystringtrueSecret key context associated with this token.
GNHashtable

Stores key-value data using the GearN container rules, like dictionary.

CodeTypeRequiredDescription