POST api/Account/rapid/auth
Authenticate with a username and password. Response contains an account summary.
Request Information
URI Parameters
None.
Body Parameters
Credentials object containing username and password
UserCredentialsName | Description | Type | Additional information |
---|---|---|---|
Username |
Email adddress for the account |
string |
None. |
Password |
Current password for the account |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Username": "john.doe@email.com", "Password": "PlainTextPassword" }
application/xml, text/xml
Sample:
<UserCredentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PBR.FanClub.WebAPI.Models"> <Password>PlainTextPassword</Password> <Username>john.doe@email.com</Username> </UserCredentials>
Response Information
Resource Description
AccountAuthResponseName | Description | Type | Additional information |
---|---|---|---|
AuthenticatedUser | AccountSummary |
None. |
|
Success |
Boolean value indicating if request was fulfilled |
boolean |
None. |
ErrorMessage |
List of any errors or problems that prevented request from being fulfilled. |
Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{ "AuthenticatedUser": { "UserAccountID": 54321, "EmailAddress": "john.doe@email.com", "LastName": "Doe", "FirstName": "John", "VerifyToken": "d6a9c09d-dcd7-45cf-9fb4-e967018c11a5" }, "Success": true, "ErrorMessage": [] }
application/xml, text/xml
Sample:
<AccountAuthResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PBR.FanClub.WebAPI.Models"> <ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <Success>true</Success> <AuthenticatedUser> <EmailAddress>john.doe@email.com</EmailAddress> <FirstName>John</FirstName> <LastName>Doe</LastName> <UserAccountID>54321</UserAccountID> <VerifyToken>d6a9c09d-dcd7-45cf-9fb4-e967018c11a5</VerifyToken> </AuthenticatedUser> </AccountAuthResponse>