User

Understanding the User object returned from authentication.

When to use: After login or validate, to access user properties and check permissions.

Prerequisites

• Completed Login

• Have a user object from authenticate() or validate_session()

5-Line Core

# User has identity info
print(user.id, user.email, user.display_name)
# User has authorization info
print(user.roles, user.permissions)
# User has helper methods
user.has_permission("documents:read")

User Properties

Property	Type	Description
id	str	Unique user identifier
email	str	User's email address
display_name	str | None	Display name
username	str | None	Username
roles	list[str]	Assigned roles
permissions	list[str]	Direct permissions
organization_id	str	Current organization
is_active	bool	Account active status
created_at	datetime	Account creation time

User Methods

Method	Returns	Description
has_permission(perm)	bool	Check single permission
has_all_permissions([...])	bool	Check all permissions (AND)
has_any_permission([...])	bool	Check any permission (OR)
has_role(role)	bool	Check raw role string
has_standard_role(role)	bool	Check standard role with hierarchy
get_standard_roles()	list	Get mapped standard roles

Step-by-Step

1

Access Identity Info

print(f"User ID: {user.id}")
print(f"Email: {user.email}")
print(f"Name: {user.display_name}")

2

Access Authorization Info

print(f"Roles: {user.roles}")
print(f"Permissions: {user.permissions}")

3

Check Permissions

if user.has_permission("documents:read"):
    print("User can read documents")

if user.has_all_permissions(["documents:read", "documents:write"]):
    print("User has full document access")

4

Check Roles

from gl_iam.core.roles import StandardRole

if user.has_standard_role(StandardRole.ORG_ADMIN):
    print("User is an admin")

5

Expected Output

User ID: 550e8400-e29b-41d4-a716-446655440000
Email: [e-mail]
Name: Alice
Roles: ['org_member']
Permissions: ['documents:read', 'documents:write']
User can read documents
User has full document access

You understand the User object!

Complete Example

"""GL IAM User Object Example."""

from gl_iam.core.roles import StandardRole


def inspect_user(user):
    """Inspect a User object."""
    # Identity
    print("=== Identity ===")
    print(f"ID: {user.id}")
    print(f"Email: {user.email}")
    print(f"Display Name: {user.display_name}")

    # Authorization
    print("\n=== Authorization ===")
    print(f"Roles: {user.roles}")
    print(f"Permissions: {user.permissions}")

    # Permission checks
    print("\n=== Permission Checks ===")
    print(f"Can read docs: {user.has_permission('documents:read')}")
    print(f"Can delete docs: {user.has_permission('documents:delete')}")

    # Role checks
    print("\n=== Role Checks ===")
    print(f"Is member: {user.has_standard_role(StandardRole.ORG_MEMBER)}")
    print(f"Is admin: {user.has_standard_role(StandardRole.ORG_ADMIN)}")


# Use after login
user, token = (await gateway.authenticate(creds, org)).unwrap()
inspect_user(user)

Next Steps

• Validate - Get User from token on protected endpoints

• Standard Roles - Deep dive into role checking

• Permissions - Deep dive into permission checking

---

Found an issue on this page? Report it on our feedback form.