FrameAppWS

<back to all web services

CustomUserSession

Requires Authentication 
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class IAuthTokens:
    provider: Optional[str] = None
    user_id: Optional[str] = None
    access_token: Optional[str] = None
    access_token_secret: Optional[str] = None
    refresh_token: Optional[str] = None
    refresh_token_expiry: Optional[datetime.datetime] = None
    request_token: Optional[str] = None
    request_token_secret: Optional[str] = None
    items: Optional[Dict[str, str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AuthUserSession(IMeta):
    referrer_url: Optional[str] = None
    id: Optional[str] = None
    user_auth_id: Optional[str] = None
    user_auth_name: Optional[str] = None
    user_name: Optional[str] = None
    twitter_user_id: Optional[str] = None
    twitter_screen_name: Optional[str] = None
    facebook_user_id: Optional[str] = None
    facebook_user_name: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    display_name: Optional[str] = None
    company: Optional[str] = None
    email: Optional[str] = None
    primary_email: Optional[str] = None
    phone_number: Optional[str] = None
    birth_date: Optional[datetime.datetime] = None
    birth_date_raw: Optional[str] = None
    address: Optional[str] = None
    address2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    country: Optional[str] = None
    culture: Optional[str] = None
    full_name: Optional[str] = None
    gender: Optional[str] = None
    language: Optional[str] = None
    mail_address: Optional[str] = None
    nickname: Optional[str] = None
    postal_code: Optional[str] = None
    time_zone: Optional[str] = None
    request_token_secret: Optional[str] = None
    created_at: datetime.datetime = datetime.datetime(1, 1, 1)
    last_modified: datetime.datetime = datetime.datetime(1, 1, 1)
    roles: Optional[List[str]] = None
    permissions: Optional[List[str]] = None
    is_authenticated: bool = False
    from_token: bool = False
    profile_url: Optional[str] = None
    sequence: Optional[str] = None
    tag: int = 0
    auth_provider: Optional[str] = None
    provider_o_auth_access: Optional[List[IAuthTokens]] = None
    meta: Optional[Dict[str, str]] = None
    audiences: Optional[List[str]] = None
    scopes: Optional[List[str]] = None
    dns: Optional[str] = None
    rsa: Optional[str] = None
    sid: Optional[str] = None
    hash: Optional[str] = None
    home_phone: Optional[str] = None
    mobile_phone: Optional[str] = None
    webpage: Optional[str] = None
    email_confirmed: Optional[bool] = None
    phone_number_confirmed: Optional[bool] = None
    two_factor_enabled: Optional[bool] = None
    security_stamp: Optional[str] = None
    type: Optional[str] = None
    recovery_token: Optional[str] = None
    ref_id: Optional[int] = None
    ref_id_str: Optional[str] = None


class MotorBD(str, Enum):
    POSTGRESQL = 'POSTGRESQL'
    ORACLE = 'ORACLE'
    SQLSERVER = 'SQLSERVER'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomUserSession(AuthUserSession):
    id_usuario: Optional[str] = None
    id_sistema: Decimal = decimal.Decimal(0)
    id_empresa_prod: Optional[str] = None
    id_empresa: Decimal = decimal.Decimal(0)
    id_modulo: Optional[str] = None
    motor_prod: Optional[MotorBD] = None
    motor_app_adm: Optional[MotorBD] = None
    prod_connection_string: Optional[str] = None
    app_adm_connection_string: Optional[str] = None
    cache_key_adm: Optional[str] = None
    password: Optional[str] = None
    session_d_b: bool = False
    mensaje_error: Optional[str] = None
    documento_usuario: Optional[str] = None
    app_adm: Optional[str] = None
    imei: Optional[str] = None
    base_u_r_l: Optional[str] = None
    usa_serv_aux: Optional[str] = None
    tipo_valida_auth: Optional[str] = None
    token_ext: Optional[str] = None
    subsistema: Optional[str] = None
    two_factor: Optional[str] = None
    referrer_url: Optional[str] = None
    id: Optional[str] = None
    user_auth_id: Optional[str] = None
    user_auth_name: Optional[str] = None
    user_name: Optional[str] = None
    twitter_user_id: Optional[str] = None
    twitter_screen_name: Optional[str] = None
    facebook_user_id: Optional[str] = None
    facebook_user_name: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    display_name: Optional[str] = None
    company: Optional[str] = None
    email: Optional[str] = None
    primary_email: Optional[str] = None
    phone_number: Optional[str] = None
    birth_date: Optional[datetime.datetime] = None
    birth_date_raw: Optional[str] = None
    address: Optional[str] = None
    address2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    country: Optional[str] = None
    culture: Optional[str] = None
    full_name: Optional[str] = None
    gender: Optional[str] = None
    language: Optional[str] = None
    mail_address: Optional[str] = None
    nickname: Optional[str] = None
    postal_code: Optional[str] = None
    time_zone: Optional[str] = None
    request_token_secret: Optional[str] = None
    created_at: datetime.datetime = datetime.datetime(1, 1, 1)
    last_modified: datetime.datetime = datetime.datetime(1, 1, 1)
    roles: Optional[List[str]] = None
    permissions: Optional[List[str]] = None
    is_authenticated: bool = False
    from_token: bool = False
    profile_url: Optional[str] = None
    sequence: Optional[str] = None
    tag: int = 0
    auth_provider: Optional[str] = None
    provider_o_auth_access: Optional[List[IAuthTokens]] = None
    meta: Optional[Dict[str, str]] = None
    audiences: Optional[List[str]] = None
    scopes: Optional[List[str]] = None
    dns: Optional[str] = None
    rsa: Optional[str] = None
    sid: Optional[str] = None
    hash: Optional[str] = None
    home_phone: Optional[str] = None
    mobile_phone: Optional[str] = None
    webpage: Optional[str] = None
    email_confirmed: Optional[bool] = None
    phone_number_confirmed: Optional[bool] = None
    two_factor_enabled: Optional[bool] = None
    security_stamp: Optional[str] = None
    type: Optional[str] = None
    recovery_token: Optional[str] = None
    ref_id: Optional[int] = None
    ref_id_str: Optional[str] = None

Python CustomUserSession DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsonl/reply/CustomUserSession HTTP/1.1 
Host: soluser-recaudo.sgsas.co 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"IDUsuario":"String","IDSistema":0,"IDEmpresaProd":"String","IDEmpresa":0,"IDModulo":"String","MotorProd":"POSTGRESQL","MotorAppAdm":"POSTGRESQL","ProdConnectionString":"String","AppAdmConnectionString":"String","CacheKeyAdm":"String","Password":"String","SessionDB":false,"MensajeError":"String","DocumentoUsuario":"String","app_adm":"String","imei":"String","BaseURL":"String","UsaServAux":"String","TipoValidaAuth":"String","TokenExt":"String","Subsistema":"String","TwoFactor":"String","ReferrerUrl":"String","Id":"String","UserAuthId":"String","UserAuthName":"String","UserName":"String","TwitterUserId":"String","TwitterScreenName":"String","FacebookUserId":"String","FacebookUserName":"String","FirstName":"String","LastName":"String","DisplayName":"String","Company":"String","Email":"String","PrimaryEmail":"String","PhoneNumber":"String","BirthDate":"0001-01-01T00:00:00.0000000","BirthDateRaw":"String","Address":"String","Address2":"String","City":"String","State":"String","Country":"String","Culture":"String","FullName":"String","Gender":"String","Language":"String","MailAddress":"String","Nickname":"String","PostalCode":"String","TimeZone":"String","RequestTokenSecret":"String","Roles":["String"],"Permissions":["String"],"IsAuthenticated":false,"FromToken":false,"ProfileUrl":"String","Sequence":"String","Tag":0,"AuthProvider":"String","ProviderOAuthAccess":[{}],"Meta":{"String":"String"},"Audiences":["String"],"Scopes":["String"],"Dns":"String","Rsa":"String","Sid":"String","Hash":"String","HomePhone":"String","MobilePhone":"String","Webpage":"String","EmailConfirmed":false,"PhoneNumberConfirmed":false,"TwoFactorEnabled":false,"SecurityStamp":"String","Type":"String","RecoveryToken":"String","RefId":0,"RefIdStr":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"IDUsuario":"String","IDSistema":0,"IDEmpresaProd":"String","IDEmpresa":0,"IDModulo":"String","MotorProd":"POSTGRESQL","MotorAppAdm":"POSTGRESQL","ProdConnectionString":"String","AppAdmConnectionString":"String","CacheKeyAdm":"String","Password":"String","SessionDB":false,"MensajeError":"String","DocumentoUsuario":"String","app_adm":"String","imei":"String","BaseURL":"String","UsaServAux":"String","TipoValidaAuth":"String","TokenExt":"String","Subsistema":"String","TwoFactor":"String","ReferrerUrl":"String","Id":"String","UserAuthId":"String","UserAuthName":"String","UserName":"String","TwitterUserId":"String","TwitterScreenName":"String","FacebookUserId":"String","FacebookUserName":"String","FirstName":"String","LastName":"String","DisplayName":"String","Company":"String","Email":"String","PrimaryEmail":"String","PhoneNumber":"String","BirthDate":"0001-01-01T00:00:00.0000000","BirthDateRaw":"String","Address":"String","Address2":"String","City":"String","State":"String","Country":"String","Culture":"String","FullName":"String","Gender":"String","Language":"String","MailAddress":"String","Nickname":"String","PostalCode":"String","TimeZone":"String","RequestTokenSecret":"String","Roles":["String"],"Permissions":["String"],"IsAuthenticated":false,"FromToken":false,"ProfileUrl":"String","Sequence":"String","Tag":0,"AuthProvider":"String","ProviderOAuthAccess":[{}],"Meta":{"String":"String"},"Audiences":["String"],"Scopes":["String"],"Dns":"String","Rsa":"String","Sid":"String","Hash":"String","HomePhone":"String","MobilePhone":"String","Webpage":"String","EmailConfirmed":false,"PhoneNumberConfirmed":false,"TwoFactorEnabled":false,"SecurityStamp":"String","Type":"String","RecoveryToken":"String","RefId":0,"RefIdStr":"String"}