API

This chapter contains the developer reference documentation of the public API for django-eve-auth.

Backends

class EveSSOBackend

A backend for authenticating users with Eve SSO tokens.

authenticate(request, token: Token = None) → User | None

Authenticate user with an Eve SSO token.

Parameters:

  • request – Current request object

  • token – django-esi token

Returns:

Authenticated user or None if authentication failed.

classmethod create_user_from_token(token: Token) → User

Create new user object from an ESI token.

Parameters:

token – django-esi token

Returns:

Authenticated user or None if authentication failed.

get_user(user_id: int) → User | None

Fetch a user.

Parameters:

user_id – PK of the requested user

Returns:

Found user or None if the user does not exist.

Models

class UserEveCharacter(*args, **kwargs)

The Eve character an user was created with.

Parameters:

Relationship fields:

Parameters:

user (OneToOneField to User) – User (related name: eve_character)

exception DoesNotExist
exception MultipleObjectsReturned
character_portrait_url(size: int = 32) → str

Return the image URL of this user’s character portrait

classmethod generic_character_portrait_url(character_id: int, size: int = 32) → str

Return the image URL of the given character ID’s portrait

Tools

Test tools for Eve Auth.

add_permission_to_user_by_name(perm_name: str, user: User) → User

Add permission as string to given user

Parameters:

  • perm – Permission name as ‘app_label.codename’

  • user – user object

Returns:

updated user object

add_permissions_to_user(perm_objs: List[Permission], user: User) → User

Add permissions to given user

Parameters:

  • perm_objs – List of permission objects

  • user – user object

Returns:

updated user object

create_fake_token(character_id: int, character_name: str, user: User = None, character_owner_hash: str = None) → Token

Create a fake token.

create_fake_user(character_id: int, character_name: str, owner_hash: str = None, permissions: List[str] = None) → User

Create fake user from given eve character details.

Parameters:

  • character_id – Eve ID of the character

  • character_name – Name of the character

  • owner_hash – SSO owner hash

  • permissions – List of permission strings

Returns:

New User object

permission_by_name(perm: str) → Permission

returns permission specified by qualified name

Parameters:

perm – Permission name as ‘app_label.codename’

Returns:

Permission object or throws exception if not found

random_string(length: int) → int

Create random string consisting of lower case ascii characters and digits.

Views

Views for Eve Auth.

login(request, token: Token)

Login user with authorization from EVE SSO.

GET parameters:
  • next: View will redirect to the given URL after after successful login,

    instead of the default LOGIN_REDIRECT_URL

logout(request)

Logout current user.

Will redirect to URLs in order:

  • URL from next GET parameter, when set

  • LOGOUT_REDIRECT_URL setting, when set

  • LOGIN_URL setting