RMail API

Back to Authenticate(v1)

POST api/V1/Authentication/AuthenticateIUser

This method is used to generate AuthToken.

Prerequisites

To be implemented

Request Information

Lorem ipsum

URI Parameters

none

Header Parameters

Header Description

Name Description Type
Content-Type This is a request content type application/json
Accept This is a response content type application/json
AuthToken This is user’s authorization token. example@example.com^296f1f85-35d4-4dd4-a350-67131c926546^rps^en-US

Note: From the Header parameters mentioned, “AuthToken” is not required for the below mentioned services.

  • Account/RegisterUser
  • Authentication/AuthenticateUser

Body Parameters

Name Description Type Additional information
EmailId
This will set the user’s EmailID string None
Password
This will set the user’s Password string None
ReferenceKey
This will set the user’s ReferenceKey string None
IPAddress
This will set the user’s IPAddress string None

Request Formats

application/json, text/json
Sample:
{
"EmailId": "sample string 1",
"Password": "sample string 2",
"ReferenceKey": "sample string 3",
"IPAddress": "sample string 4"
}
application/xml, text/xml
Sample:
<UserIAuthenticate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<EmailId>sample string 1</EmailId>
<Password>sample string 2</Password>
<ReferenceKey>sample string 3</ReferenceKey>
<IPAddress>sample string 4</IPAddress>
</UserIAuthenticate>

Response Information

Resource Description

Name Description Type Additional information
AuthMessage
This will return response message. string None
AuthToken
This will return user’s Authorization Token. string None
EmailId
This will return user’s Email Id. string None

Response Formats

application/json, text/json
Sample:
{
"AuthMessage": "sample string 1",
"AuthToken": "sample string 2",
"EmailId": "sample string 3"
}
application/json, text/json
Sample:
<ResponseTokenWithEmailId xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<AuthMessage>sample string 1</AuthMessage>
<AuthToken>sample string 2</AuthToken>
<EmailId>sample string 3</EmailId>
</ResponseTokenWithEmailId>

Was this page helpful?