StarterTemplate ASP.NET Host

<back to all web services

UserAuths

The following routes are available for this service:
All Verbs/api/userauths
UserAuths Parameters:
NameParameterData TypeRequiredDescription
Idsqueryint[]No
UserAuthsResponse Parameters:
NameParameterData TypeRequiredDescription
UserSessionformCustomUserSessionNo
UsersformList<User>No
UserAuthsformList<UserAuth>No
OAuthProvidersformList<UserAuthDetails>No
CustomUserSession Parameters:
NameParameterData TypeRequiredDescription
CustomIdformstringNo
AuthUserSession Parameters:
NameParameterData TypeRequiredDescription
ReferrerUrlformstringNo
IdformstringNo
UserAuthIdformstringNo
UserAuthNameformstringNo
UserNameformstringNo
TwitterUserIdformstringNo
TwitterScreenNameformstringNo
FacebookUserIdformstringNo
FacebookUserNameformstringNo
FirstNameformstringNo
LastNameformstringNo
DisplayNameformstringNo
CompanyformstringNo
EmailformstringNo
PrimaryEmailformstringNo
PhoneNumberformstringNo
BirthDateformDateTime?No
BirthDateRawformstringNo
AddressformstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
CultureformstringNo
FullNameformstringNo
GenderformstringNo
LanguageformstringNo
MailAddressformstringNo
NicknameformstringNo
PostalCodeformstringNo
TimeZoneformstringNo
RequestTokenSecretformstringNo
CreatedAtformDateTimeNo
LastModifiedformDateTimeNo
RolesformList<string>No
PermissionsformList<string>No
IsAuthenticatedformboolNo
FromTokenformboolNo
ProfileUrlformstringNo
SequenceformstringNo
TagformlongNo
ProviderOAuthAccessformList<IAuthTokens>No
IAuthTokens Parameters:
NameParameterData TypeRequiredDescription
ProviderformstringNo
UserIdformstringNo
AccessTokenformstringNo
AccessTokenSecretformstringNo
RefreshTokenformstringNo
RefreshTokenExpiryformDateTime?No
RequestTokenformstringNo
RequestTokenSecretformstringNo
ItemsformDictionary<string, string>No
User Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
EmailformstringNo
UserNameformstringNo
DisplayNameformstringNo
TwitterUserIdformstringNo
TwitterScreenNameformstringNo
TwitterNameformstringNo
FacebookNameformstringNo
FacebookFirstNameformstringNo
FacebookLastNameformstringNo
FacebookUserIdformstringNo
FacebookUserNameformstringNo
FacebookEmailformstringNo
YahooUserIdformstringNo
YahooFullNameformstringNo
YahooEmailformstringNo
GravatarImageUrl64formstringNo
UserAuth Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UserNameformstringNo
EmailformstringNo
PrimaryEmailformstringNo
PhoneNumberformstringNo
FirstNameformstringNo
LastNameformstringNo
DisplayNameformstringNo
CompanyformstringNo
BirthDateformDateTime?No
BirthDateRawformstringNo
AddressformstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
CultureformstringNo
FullNameformstringNo
GenderformstringNo
LanguageformstringNo
MailAddressformstringNo
NicknameformstringNo
PostalCodeformstringNo
TimeZoneformstringNo
SaltformstringNo
PasswordHashformstringNo
DigestHa1HashformstringNo
RolesformList<string>No
PermissionsformList<string>No
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
InvalidLoginAttemptsformintNo
LastLoginAttemptformDateTime?No
LockedDateformDateTime?No
RecoveryTokenformstringNo
RefIdformint?No
RefIdStrformstringNo
MetaformDictionary<string, string>No
UserAuthDetails Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UserAuthIdformintNo
ProviderformstringNo
UserIdformstringNo
UserNameformstringNo
FullNameformstringNo
DisplayNameformstringNo
FirstNameformstringNo
LastNameformstringNo
CompanyformstringNo
EmailformstringNo
PhoneNumberformstringNo
BirthDateformDateTime?No
BirthDateRawformstringNo
AddressformstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
CultureformstringNo
GenderformstringNo
LanguageformstringNo
MailAddressformstringNo
NicknameformstringNo
PostalCodeformstringNo
TimeZoneformstringNo
RefreshTokenformstringNo
RefreshTokenExpiryformDateTime?No
RequestTokenformstringNo
RequestTokenSecretformstringNo
ItemsformDictionary<string, string>No
AccessTokenformstringNo
AccessTokenSecretformstringNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
RefIdformint?No
RefIdStrformstringNo
MetaformDictionary<string, string>No

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

HTTP + XML

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

POST /xml/reply/UserAuths HTTP/1.1 
Host: bootstrapapi.servicestack.net 
Content-Type: application/xml
Content-Length: length

<UserAuths xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SocialBootstrapApi.ServiceInterface">
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </Ids>
</UserAuths>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserAuthsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SocialBootstrapApi.ServiceInterface">
  <OAuthProviders xmlns:d2p1="http://schemas.datacontract.org/2004/07/ServiceStack.Auth">
    <d2p1:UserAuthDetails>
      <d2p1:AccessToken>String</d2p1:AccessToken>
      <d2p1:AccessTokenSecret>String</d2p1:AccessTokenSecret>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:Address2>String</d2p1:Address2>
      <d2p1:BirthDate>0001-01-01T00:00:00</d2p1:BirthDate>
      <d2p1:BirthDateRaw>String</d2p1:BirthDateRaw>
      <d2p1:City>String</d2p1:City>
      <d2p1:Company>String</d2p1:Company>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:Culture>String</d2p1:Culture>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:FullName>String</d2p1:FullName>
      <d2p1:Gender>String</d2p1:Gender>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Items xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:Items>
      <d2p1:Language>String</d2p1:Language>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:MailAddress>String</d2p1:MailAddress>
      <d2p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:Meta>
      <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
      <d2p1:Nickname>String</d2p1:Nickname>
      <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:Provider>String</d2p1:Provider>
      <d2p1:RefId>0</d2p1:RefId>
      <d2p1:RefIdStr>String</d2p1:RefIdStr>
      <d2p1:RefreshToken>String</d2p1:RefreshToken>
      <d2p1:RefreshTokenExpiry>0001-01-01T00:00:00</d2p1:RefreshTokenExpiry>
      <d2p1:RequestToken>String</d2p1:RequestToken>
      <d2p1:RequestTokenSecret>String</d2p1:RequestTokenSecret>
      <d2p1:State>String</d2p1:State>
      <d2p1:TimeZone>String</d2p1:TimeZone>
      <d2p1:UserAuthId>0</d2p1:UserAuthId>
      <d2p1:UserId>String</d2p1:UserId>
      <d2p1:UserName>String</d2p1:UserName>
    </d2p1:UserAuthDetails>
  </OAuthProviders>
  <UserAuths xmlns:d2p1="http://schemas.datacontract.org/2004/07/ServiceStack.Auth">
    <d2p1:UserAuth>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:Address2>String</d2p1:Address2>
      <d2p1:BirthDate>0001-01-01T00:00:00</d2p1:BirthDate>
      <d2p1:BirthDateRaw>String</d2p1:BirthDateRaw>
      <d2p1:City>String</d2p1:City>
      <d2p1:Company>String</d2p1:Company>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:Culture>String</d2p1:Culture>
      <d2p1:DigestHa1Hash>String</d2p1:DigestHa1Hash>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:FullName>String</d2p1:FullName>
      <d2p1:Gender>String</d2p1:Gender>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:InvalidLoginAttempts>0</d2p1:InvalidLoginAttempts>
      <d2p1:Language>String</d2p1:Language>
      <d2p1:LastLoginAttempt>0001-01-01T00:00:00</d2p1:LastLoginAttempt>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:LockedDate>0001-01-01T00:00:00</d2p1:LockedDate>
      <d2p1:MailAddress>String</d2p1:MailAddress>
      <d2p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:Meta>
      <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
      <d2p1:Nickname>String</d2p1:Nickname>
      <d2p1:PasswordHash>String</d2p1:PasswordHash>
      <d2p1:Permissions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Permissions>
      <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:PrimaryEmail>String</d2p1:PrimaryEmail>
      <d2p1:RecoveryToken>String</d2p1:RecoveryToken>
      <d2p1:RefId>0</d2p1:RefId>
      <d2p1:RefIdStr>String</d2p1:RefIdStr>
      <d2p1:Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Roles>
      <d2p1:Salt>String</d2p1:Salt>
      <d2p1:State>String</d2p1:State>
      <d2p1:TimeZone>String</d2p1:TimeZone>
      <d2p1:UserName>String</d2p1:UserName>
    </d2p1:UserAuth>
  </UserAuths>
  <UserSession xmlns:d2p1="http://schemas.datacontract.org/2004/07/SocialBootstrapApi.Models">
    <ReferrerUrl xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</ReferrerUrl>
    <Id xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</Id>
    <UserAuthId xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</UserAuthId>
    <UserAuthName xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</UserAuthName>
    <UserName xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</UserName>
    <TwitterUserId xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</TwitterUserId>
    <TwitterScreenName xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</TwitterScreenName>
    <FacebookUserId xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</FacebookUserId>
    <FacebookUserName xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</FacebookUserName>
    <FirstName xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</FirstName>
    <LastName xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</LastName>
    <DisplayName xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</DisplayName>
    <Company xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</Company>
    <Email xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</Email>
    <PrimaryEmail xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</PrimaryEmail>
    <PhoneNumber xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</PhoneNumber>
    <BirthDate xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">0001-01-01T00:00:00</BirthDate>
    <BirthDateRaw xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</BirthDateRaw>
    <Address xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</Address>
    <Address2 xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</Address2>
    <City xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</City>
    <State xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</State>
    <Country xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</Country>
    <Culture xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</Culture>
    <FullName xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</FullName>
    <Gender xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</Gender>
    <Language xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</Language>
    <MailAddress xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</MailAddress>
    <Nickname xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</Nickname>
    <PostalCode xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</PostalCode>
    <TimeZone xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</TimeZone>
    <RequestTokenSecret xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</RequestTokenSecret>
    <CreatedAt xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">0001-01-01T00:00:00</CreatedAt>
    <LastModified xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">0001-01-01T00:00:00</LastModified>
    <Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">
      <d3p1:string>String</d3p1:string>
    </Roles>
    <Permissions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">
      <d3p1:string>String</d3p1:string>
    </Permissions>
    <IsAuthenticated xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">false</IsAuthenticated>
    <FromToken xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">false</FromToken>
    <ProfileUrl xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</ProfileUrl>
    <Sequence xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">String</Sequence>
    <Tag xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">0</Tag>
    <ProviderOAuthAccess xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">
      <d3p1:anyType i:nil="true" />
    </ProviderOAuthAccess>
    <d2p1:CustomId>String</d2p1:CustomId>
  </UserSession>
  <Users xmlns:d2p1="http://schemas.datacontract.org/2004/07/SocialBootstrapApi.Models">
    <d2p1:User>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FacebookEmail>String</d2p1:FacebookEmail>
      <d2p1:FacebookFirstName>String</d2p1:FacebookFirstName>
      <d2p1:FacebookLastName>String</d2p1:FacebookLastName>
      <d2p1:FacebookName>String</d2p1:FacebookName>
      <d2p1:FacebookUserId>String</d2p1:FacebookUserId>
      <d2p1:FacebookUserName>String</d2p1:FacebookUserName>
      <d2p1:GravatarImageUrl64>String</d2p1:GravatarImageUrl64>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:TwitterName>String</d2p1:TwitterName>
      <d2p1:TwitterScreenName>String</d2p1:TwitterScreenName>
      <d2p1:TwitterUserId>String</d2p1:TwitterUserId>
      <d2p1:UserName>String</d2p1:UserName>
      <d2p1:YahooEmail>String</d2p1:YahooEmail>
      <d2p1:YahooFullName>String</d2p1:YahooFullName>
      <d2p1:YahooUserId>String</d2p1:YahooUserId>
    </d2p1:User>
  </Users>
</UserAuthsResponse>