Identity API Reference¶

Complete API reference for the Identity module.

IntelliVerseXUserIdentity¶

Main identity and authentication manager.

Properties¶

Authentication Methods¶

AuthenticateGuestAsync¶

public async Task<IVXUserProfile> AuthenticateGuestAsync()

Creates or restores a guest account.

Returns: User profile

Throws: AuthException on failure

Example:

var user = await IntelliVerseXUserIdentity.Instance.AuthenticateGuestAsync();
Debug.Log($"Guest: {user.DisplayName}");

LoginWithEmailAsync¶

public async Task<IVXUserProfile> LoginWithEmailAsync(string email, string password)

Authenticates with email/password.

Parameters: - email - User email - password - User password

Returns: User profile

Throws: - AuthException - Invalid credentials - NetworkException - Connection failed

Example:

var user = await IntelliVerseXUserIdentity.Instance
    .LoginWithEmailAsync("user@email.com", "password123");

RegisterWithEmailAsync¶

public async Task<IVXUserProfile> RegisterWithEmailAsync(
    string email, 
    string password, 
    string displayName = null)

Creates a new account with email/password.

Parameters: - email - User email - password - Password (min 8 characters) - displayName - Optional display name

Returns: New user profile

Throws: AuthException if email exists

LoginWithGoogleAsync¶

public async Task<IVXUserProfile> LoginWithGoogleAsync()

Initiates Google Sign-In flow.

Returns: User profile

Throws: AuthException on failure or cancellation

LoginWithAppleAsync¶

public async Task<IVXUserProfile> LoginWithAppleAsync()

Initiates Apple Sign-In flow (iOS/macOS only).

Returns: User profile

Platform: iOS, macOS

LoginWithFacebookAsync¶

public async Task<IVXUserProfile> LoginWithFacebookAsync()

Initiates Facebook Login flow.

Returns: User profile

Session Methods¶

TryRestoreSessionAsync¶

public async Task<bool> TryRestoreSessionAsync()

Attempts to restore a previous session.

Returns: true if session restored

Example:

if (await IntelliVerseXUserIdentity.Instance.TryRestoreSessionAsync())
{
    // User is logged in
}
else
{
    ShowLoginScreen();
}

RefreshSessionAsync¶

public async Task RefreshSessionAsync()

Refreshes the current session token.

LogoutAsync¶

public async Task LogoutAsync()

Logs out the current user and clears session.

Example:

await IntelliVerseXUserIdentity.Instance.LogoutAsync();

Account Linking¶

LinkEmailAsync¶

public async Task LinkEmailAsync(string email, string password)

Links email/password to current account.

Parameters: - email - Email to link - password - Password for the email

Throws: AuthException if email already linked

LinkGoogleAsync¶

public async Task LinkGoogleAsync()

Links Google account to current user.

LinkAppleAsync¶

public async Task LinkAppleAsync()

Links Apple account to current user.

Password Management¶

SendPasswordResetAsync¶

public async Task SendPasswordResetAsync(string email)

Sends password reset email.

Parameters: - email - Account email

ChangePasswordAsync¶

public async Task ChangePasswordAsync(string currentPassword, string newPassword)

Changes the user's password.

Profile Management¶

UpdateDisplayNameAsync¶

public async Task UpdateDisplayNameAsync(string displayName)

Updates the user's display name.

UpdateAvatarAsync¶

public async Task UpdateAvatarAsync(string avatarUrl)

Updates the user's avatar URL.

Events¶

Example:

IntelliVerseXUserIdentity.OnAuthStateChanged += (state) =>
{
    if (state == AuthState.Authenticated)
        ShowMainMenu();
    else
        ShowLoginScreen();
};

IVXUserProfile¶

User profile data class.

Properties¶

AuthState Enum¶

public enum AuthState
{
    Unknown,
    Unauthenticated,
    Authenticating,
    Authenticated,
    Expired
}

AuthException¶

Authentication-specific exception.

Properties¶

Error Codes¶

See Also¶

• Identity Module Guide
• Authentication Flow Guide