Logout

End a user session and invalidate the token.

When to use: When the user signs out or you need to invalidate a session for security.

Prerequisites

• Completed Login

• Have an access token to invalidate

5-Line Core

result = await gateway.logout(
    access_token=token.access_token,
    organization_id="default",
)
# Token is now invalid

Step-by-Step

1

Call Logout

result = await gateway.logout(
    access_token=token.access_token,
    organization_id="default",
)

2

Handle Result

if result.is_ok:
    print("Logged out successfully")
else:
    print(f"Logout failed: {result.error.message}")

3

Token is Invalid

# After logout, the token no longer works
validate_result = await gateway.validate_session(
    access_token=token.access_token,
    organization_id="default",
)
print(f"Token valid: {validate_result.is_ok}")  # False

4

Expected Output

Logged out successfully
Token valid: False

You can log out users!

Complete Example

Create logout.py:

"""GL IAM Logout Example."""

import asyncio

from gl_iam import IAMGateway
from gl_iam.core.types import PasswordCredentials
from gl_iam.providers.postgresql import PostgreSQLProvider, PostgreSQLConfig

DATABASE_URL = "postgresql+asyncpg://postgres:postgres@localhost:5432/gliam"


async def main():
    # Setup
    config = PostgreSQLConfig(database_url=DATABASE_URL)
    provider = PostgreSQLProvider(config)
    gateway = IAMGateway.from_fullstack_provider(provider)

    # Login
    auth_result = await gateway.authenticate(
        credentials=PasswordCredentials(email="[e-mail]", password="SecurePass123"),
        organization_id="default",
    )
    user, token = auth_result.unwrap()
    print(f"Logged in as: {user.email}")

    # Verify token works
    validate_result = await gateway.validate_session(token.access_token, "default")
    print(f"Before logout - token valid: {validate_result.is_ok}")

    # Logout
    result = await gateway.logout(
        access_token=token.access_token,
        organization_id="default",
    )

    if result.is_ok:
        print("Logged out successfully")

    # Verify token no longer works
    validate_result = await gateway.validate_session(token.access_token, "default")
    print(f"After logout - token valid: {validate_result.is_ok}")

    await provider.close()


if __name__ == "__main__":
    asyncio.run(main())

Run it:

uv run logout.py

Expected output:

Logged in as: [e-mail]
Before logout - token valid: True
Logged out successfully
After logout - token valid: False

Common Pitfalls

Pitfall	Solution
Not clearing client token	Clear stored token after logout
Ignoring logout errors	Log errors but don't block user
Not logging out on security events	Logout when password changed, suspicious activity

Next Steps

• Login - User can login again

• Result Pattern - Handle errors properly