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.
Models¶
- class UserEveCharacter(*args, **kwargs)¶
The Eve character an user was created with.
- Parameters:
id (BigAutoField) – Primary key: ID
character_id (PositiveIntegerField) – Character id
character_name (CharField) – Character name
character_owner_hash (CharField) – Character owner hash
Relationship fields:
- Parameters:
user (
OneToOneField
toUser
) – User (related name:eve_character
)
- exception DoesNotExist¶
- exception MultipleObjectsReturned¶
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
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 setLOGOUT_REDIRECT_URL
setting, when setLOGIN_URL
setting