Type: AuthenticationResponse

How did we do?
Contents

Represents an authentication response from HiveMP, which indicates whether or not HiveMP has enough information to authenticate the user and whether or not your game needs to prompt for additional information.

Outline

Represents an authentication response from HiveMP, which indicates whether or not HiveMP has enough information to authenticate the user and whether or not your game needs to prompt for additional information.

Properties

authenticatedSession Description If authentication was successful, this contains the user session with API key and other secrets.
Type UserSessionWithSecrets
availableProjects Description When promptForProject is true and projectId is null in the authentication request, and the authentication process would otherwise succeed (i.e. the password or authentication details are correct), this will be populated with a list of available projects that can be used in the projectId field in the next authentication request.
Type array of UserAvailableProject
intent Description One of null, "login", "register", "link" or "link-confirm", depending on what the intent of next step is.
Type string
passwordResetEmailSent Description When a user signs into a new platform for the first time, they may not have set a password on their account. If this is the case, HiveMP will automatically send them a "Please set your password" email in order complete authentication, and they'll need to do that before being able to sign into your game.
Type boolean
promptForEmailAddress Description If true, your game needs to prompt the user for an email address and include it with your next authentication request.
Type boolean
promptForMarketingPreferenceOptIn Description If true and you'd like to receive email addresses on player accounts, your game needs to prompt (or show a checkbox) to the user to opt-in to sharing their email address with you. HiveMP.UserSession.Service.AuthenticationRequest has more information about this behaviour.
Type boolean
promptForPassword Description If true, your game needs to prompt the user for a password, and include the salted, hashed version of it in your next authentication request.
Type boolean
promptForProject Description If true, your app needs to prompt the user for the project ID, using the availableProjects field.
Type boolean
promptForTwoFactor Description If true, your game needs to prompt the user for a two factor code with a "Trust this device for 30 days" checkbox, and include the two factor code on your next authentication request.
Type boolean