Auth App serializers documentation

class auth_app.serializers.GitHubAuthCallbackSerializer(*args, **kwargs)

Bases: Serializer

Serializer to handle the callback from Github OAuth2.

Parameters:

• code – OAuth2 code returned by Github.

• state – State token to prevent CSRF.

Returns:

User’s email, id and JWT token

create(validated_data)

Verifies OAuth2Session and sign up/in user and returns JWT token

class auth_app.serializers.GitHubAuthInitSerializer(*args, **kwargs)

Bases: Serializer

Serializer to initiate Github OAuth2 flow.

Returns:

Authentication Github url and state

create(validated_data)

Return github authorization url and state

class auth_app.serializers.GoogleAuthCallbackSerializer(*args, **kwargs)

Bases: Serializer

Serializer to handle the callback from Google OAuth2.

Parameters:

• code – OAuth2 code returned by Google.

• state – State token to prevent CSRF.

Returns:

User’s email, id and JWT token

create(validated_data)

Verifies OAuth2Session and sign up/in user and returns JWT token

class auth_app.serializers.GoogleAuthInitSerializer(*args, **kwargs)

Bases: Serializer

Serializer to initiate Google OAuth2 flow.

Returns:

Authentication Google url and state

create(validated_data)

Return google authorization url and state

class auth_app.serializers.UserAuthSerializer(*args, **kwargs)

Bases: Serializer

Seriazlier verify JWT token for user authentication.

Parameters:

token – JWT token.

Returns:

User instance

validate(attrs)

Validates token

class auth_app.serializers.UserLogInSerializer(*args, **kwargs)

Bases: Serializer

Serializer for user login.

Parameters:

• email – Email address.

• password – Plain-text password.

Returns:

User data and JWT token.

validate(attrs)

Validates email/password, find user and returns JWT token

class auth_app.serializers.UserSerializer(*args, **kwargs)

Bases: ModelSerializer

Serializer for representing a user

Parameters:

• id – Stringified Id.

• username – User’s username.

• email – Email of the user.

Returns:

True if successful, False otherwise.

class Meta

Bases: object

fields = ['id', 'username', 'email']

model

alias of CustomUser

get_id(obj)

class auth_app.serializers.UserSignUpSerializer(*args, **kwargs)

Bases: ModelSerializer

Serializer for user sign up.

Parameters:

• username – Desired username.

• email – Desired user’s email address.

• password – User’s plain text password (write-only)/

Returns:

New user instance with JWT token attached

class Meta

Bases: object

fields = ['username', 'email', 'password']

model

alias of CustomUser

create(validated_data)

Creates new user and returns token

validate(attrs)

Validates email, and uniqness of it and username