Skip to content

onconova.core.auth.schemas

This module defines Pydantic schemas for user authentication and profile management within the Onconova system.

UserFilters module-attribute

Dynamically generated schema for filtering users, based on User schema.

AuthenticationMeta

Bases: BaseSchema

Schema representing authentication metadata.

Attributes:

Name Type Description
sessionToken Optional[str]

The session token associated with the authentication, if available.
accessToken Optional[str]

The access token for the authenticated session, if available.
isAuthenticated bool

Indicates whether the user is authenticated.

accessToken class-attribute instance-attribute

isAuthenticated class-attribute instance-attribute

sessionToken class-attribute instance-attribute

User

Bases: UserCreate

canExportData class-attribute instance-attribute

canManageCases class-attribute instance-attribute

canManageProjects class-attribute instance-attribute

canManageUsers class-attribute instance-attribute

canViewCases class-attribute instance-attribute

canViewCohorts class-attribute instance-attribute

canViewDatasets class-attribute instance-attribute

canViewProjects class-attribute instance-attribute

canViewUsers class-attribute instance-attribute

fullName class-attribute instance-attribute

id class-attribute instance-attribute

isProvided class-attribute instance-attribute

isSystemAdmin class-attribute instance-attribute

provider class-attribute instance-attribute

role class-attribute instance-attribute

UserCreate

Bases: BaseSchema

__orm_model__ class-attribute instance-attribute

accessLevel class-attribute instance-attribute

department class-attribute instance-attribute

email class-attribute instance-attribute

externalSource class-attribute instance-attribute

externalSourceId class-attribute instance-attribute

firstName class-attribute instance-attribute

isActive class-attribute instance-attribute

isServiceAccount class-attribute instance-attribute

lastLogin class-attribute instance-attribute

lastName class-attribute instance-attribute

organization class-attribute instance-attribute

shareable class-attribute instance-attribute

title class-attribute instance-attribute

username class-attribute instance-attribute

UserCredentials

Bases: Schema

Schema representing user credentials required for authentication.

Attributes:

Name Type Description
username str

The username of the user.
password str

The password associated with the username.

password class-attribute instance-attribute

username class-attribute instance-attribute

UserExport

Bases: BaseSchema, AnonymizationMixin

User information to be exported for acreditation purposes

__orm_model__ class-attribute instance-attribute

email class-attribute instance-attribute

externalSource class-attribute instance-attribute

externalSourceId class-attribute instance-attribute

firstName class-attribute instance-attribute

id class-attribute instance-attribute

lastName class-attribute instance-attribute

organization class-attribute instance-attribute

username class-attribute instance-attribute

resolve_anonymized(user) staticmethod

Source code in onconova/core/auth/schemas.py 
227
228
229
@staticmethod 
def resolve_anonymized(user):
    return not user.shareable

UserPasswordReset

Bases: Schema

Schema for user password reset operation.

Attributes:

Name Type Description
oldPassword str

The user's current password.
newPassword str

The user's new password to be set.

newPassword class-attribute instance-attribute

oldPassword class-attribute instance-attribute

UserProfile

Bases: BaseSchema

Schema representing a user's profile information.

Attributes:

Name Type Description
firstName Optional[str]

The user's given name. Accepts either 'firstName' or 'first_name' as input.
lastName Optional[str]

The user's surname. Accepts either 'lastName' or 'last_name' as input.
organization Optional[str]

The user's affiliated organization.
department Optional[str]

The user's department within the organization.
title Optional[str]

The user's job title or position.
email str

The user's primary email address.

department class-attribute instance-attribute

email class-attribute instance-attribute

firstName class-attribute instance-attribute

lastName class-attribute instance-attribute

organization class-attribute instance-attribute

title class-attribute instance-attribute

UserProviderClientToken

Bases: Schema

Schema representing a user's authentication tokens provided by a client.

Attributes:

Name Type Description
client_id str

The unique identifier for the client application.
id_token Optional[str]

The ID token issued by the authentication provider, if available.
access_token Optional[str]

The access token issued by the authentication provider, if available.

access_token class-attribute instance-attribute

client_id class-attribute instance-attribute

id_token class-attribute instance-attribute

UserProviderToken

Bases: Schema

Schema representing a user's provider token information.

Attributes:

Name Type Description
provider str

The name of the authentication provider (e.g., 'google', 'facebook').
process Literal['login'] | Literal['connect']

The process type, either 'login' or 'connect'.
token UserProviderClientToken

The token object containing provider-specific authentication details.

process class-attribute instance-attribute

provider class-attribute instance-attribute

token class-attribute instance-attribute

runner