Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

gameId

gameId: string | undefined

A universally unique identifier.

identity

identity: IdentityProfile | undefined

Information about the identity that was just authenticated.

identityToken

identityToken: string | undefined

Token used to authenticate the identity. Should be stored somewhere permanent. Pass this to rivet.api.identity#SetupIdentity$existing_identity_token next time rivet.api.identity#SetupIdentity is called. Token has a 90 day TTL. This means that if rivet.api.identity#SetupIdentity is not called again within 90 days, the token will no longer be valid. If this happens, the user can recover their account through the linking process (see rivet.api.identity#PrepareGameLink). This token should be stored locally and never sent to a server or another device. If this token is comprimised, anyone with access to this token has control of the identity.

identityTokenExpireTs

identityTokenExpireTs: Date | undefined

Timestamp (in milliseconds) at which the token expires.