All Verbs | /session |
---|
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
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomUserSession(AuthUserSession):
custom_name: Optional[str] = None
custom_info: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UnAuthInfo:
custom_info: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSessionResponse:
result: Optional[CustomUserSession] = None
un_auth_info: Optional[UnAuthInfo] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSession:
pass
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /session HTTP/1.1
Host: test.servicestack.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetSession xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Test.ServiceInterface" />
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetSessionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Test.ServiceInterface"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <Result> <ReferrerUrl xmlns="http://schemas.servicestack.net/types">String</ReferrerUrl> <Id xmlns="http://schemas.servicestack.net/types">String</Id> <UserAuthId xmlns="http://schemas.servicestack.net/types">String</UserAuthId> <UserAuthName xmlns="http://schemas.servicestack.net/types">String</UserAuthName> <UserName xmlns="http://schemas.servicestack.net/types">String</UserName> <TwitterUserId xmlns="http://schemas.servicestack.net/types">String</TwitterUserId> <TwitterScreenName xmlns="http://schemas.servicestack.net/types">String</TwitterScreenName> <FacebookUserId xmlns="http://schemas.servicestack.net/types">String</FacebookUserId> <FacebookUserName xmlns="http://schemas.servicestack.net/types">String</FacebookUserName> <FirstName xmlns="http://schemas.servicestack.net/types">String</FirstName> <LastName xmlns="http://schemas.servicestack.net/types">String</LastName> <DisplayName xmlns="http://schemas.servicestack.net/types">String</DisplayName> <Company xmlns="http://schemas.servicestack.net/types">String</Company> <Email xmlns="http://schemas.servicestack.net/types">String</Email> <PrimaryEmail xmlns="http://schemas.servicestack.net/types">String</PrimaryEmail> <PhoneNumber xmlns="http://schemas.servicestack.net/types">String</PhoneNumber> <BirthDate xmlns="http://schemas.servicestack.net/types">0001-01-01T00:00:00</BirthDate> <BirthDateRaw xmlns="http://schemas.servicestack.net/types">String</BirthDateRaw> <Address xmlns="http://schemas.servicestack.net/types">String</Address> <Address2 xmlns="http://schemas.servicestack.net/types">String</Address2> <City xmlns="http://schemas.servicestack.net/types">String</City> <State xmlns="http://schemas.servicestack.net/types">String</State> <Country xmlns="http://schemas.servicestack.net/types">String</Country> <Culture xmlns="http://schemas.servicestack.net/types">String</Culture> <FullName xmlns="http://schemas.servicestack.net/types">String</FullName> <Gender xmlns="http://schemas.servicestack.net/types">String</Gender> <Language xmlns="http://schemas.servicestack.net/types">String</Language> <MailAddress xmlns="http://schemas.servicestack.net/types">String</MailAddress> <Nickname xmlns="http://schemas.servicestack.net/types">String</Nickname> <PostalCode xmlns="http://schemas.servicestack.net/types">String</PostalCode> <TimeZone xmlns="http://schemas.servicestack.net/types">String</TimeZone> <RequestTokenSecret xmlns="http://schemas.servicestack.net/types">String</RequestTokenSecret> <CreatedAt xmlns="http://schemas.servicestack.net/types">0001-01-01T00:00:00</CreatedAt> <LastModified xmlns="http://schemas.servicestack.net/types">0001-01-01T00:00:00</LastModified> <Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types"> <d3p1:string>String</d3p1:string> </Roles> <Permissions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types"> <d3p1:string>String</d3p1:string> </Permissions> <IsAuthenticated xmlns="http://schemas.servicestack.net/types">false</IsAuthenticated> <FromToken xmlns="http://schemas.servicestack.net/types">false</FromToken> <ProfileUrl xmlns="http://schemas.servicestack.net/types">String</ProfileUrl> <Sequence xmlns="http://schemas.servicestack.net/types">String</Sequence> <Tag xmlns="http://schemas.servicestack.net/types">0</Tag> <AuthProvider xmlns="http://schemas.servicestack.net/types">String</AuthProvider> <ProviderOAuthAccess xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types"> <d3p1:anyType i:nil="true" /> </ProviderOAuthAccess> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> <Audiences xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types"> <d3p1:string>String</d3p1:string> </Audiences> <Scopes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types"> <d3p1:string>String</d3p1:string> </Scopes> <Dns xmlns="http://schemas.servicestack.net/types">String</Dns> <Rsa xmlns="http://schemas.servicestack.net/types">String</Rsa> <Sid xmlns="http://schemas.servicestack.net/types">String</Sid> <Hash xmlns="http://schemas.servicestack.net/types">String</Hash> <HomePhone xmlns="http://schemas.servicestack.net/types">String</HomePhone> <MobilePhone xmlns="http://schemas.servicestack.net/types">String</MobilePhone> <Webpage xmlns="http://schemas.servicestack.net/types">String</Webpage> <EmailConfirmed xmlns="http://schemas.servicestack.net/types">false</EmailConfirmed> <PhoneNumberConfirmed xmlns="http://schemas.servicestack.net/types">false</PhoneNumberConfirmed> <TwoFactorEnabled xmlns="http://schemas.servicestack.net/types">false</TwoFactorEnabled> <SecurityStamp xmlns="http://schemas.servicestack.net/types">String</SecurityStamp> <Type xmlns="http://schemas.servicestack.net/types">String</Type> <RecoveryToken xmlns="http://schemas.servicestack.net/types">String</RecoveryToken> <RefId xmlns="http://schemas.servicestack.net/types">0</RefId> <RefIdStr xmlns="http://schemas.servicestack.net/types">String</RefIdStr> <CustomInfo>String</CustomInfo> <CustomName>String</CustomName> </Result> <UnAuthInfo> <CustomInfo>String</CustomInfo> </UnAuthInfo> </GetSessionResponse>