Documentation

Support

Authentication for Unreal Engine

Authentication overview

Authentication for Unreal Engine

Struct AuthenticationResponse

Reference the data structure for authentication service responses.
Read time 2 minutesLast updated 2 hours ago

Mirrors an API response from the Unity Authentication Service.
Include
#include "Models/AuthenticationResponse.h"
Syntax
USTRUCT(BlueprintType)struct AUTHENTICATION_API FAuthenticationResponse

Fields

WasSuccessful

Whether the response was a success.

Declaration

bool bWasSuccessful = false

Blueprint

Name

Type

Default Value

Blueprint Property Type

Blueprint Property Category

Was SuccessfulBoolean
false
BlueprintReadOnlyUnity Gaming Services | Authentication

C++

Name

Type

Default Value

bWasSuccessful
bool
false

UserId

The generated user Id.

Declaration

FString UserId

Blueprint

Name

Type

Blueprint Property Type

Blueprint Property Category

User IdStringBlueprintReadOnlyUnity Gaming Services | Authentication

C++

Name

Type

UserId
FString

AccessToken

The generated authentication access token.

Declaration

FString AccessToken

Blueprint

Name

Type

Blueprint Property Type

Blueprint Property Category

Access TokenStringBlueprintReadOnlyUnity Gaming Services | Authentication

C++

Name

Type

AccessToken
FString

SessionToken

The generated authentication session token. This token can be used to sign in the user again.

Declaration

FString SessionToken

Blueprint

Name

Type

Blueprint Property Type

Blueprint Property Category

Session TokenStringBlueprintReadOnlyUnity Gaming Services | Authentication

C++

Name

Type

SessionToken
FString

AuthorizedTime

The time at which the response was sent.

Declaration

FDateTime AuthorizedTime

Blueprint

Name

Type

Blueprint Property Type

Blueprint Property Category

Authorized TimeDate Time StructureBlueprintReadOnlyUnity Gaming Services | Authentication

C++

Name

Type

AuthorizedTime
FDateTime

ExpiresIn

The time at which the response was sent.

Declaration

int32 ExpiresIn = 0

Blueprint

Name

Type

Default Value

Blueprint Property Type

Blueprint Property Category

Expires InInteger
0
BlueprintReadOnlyUnity Gaming Services | Authentication

C++

Name

Type

Default Value

ExpiresIn
int32
0