POST api/account/clientportallogin

Authenticates client portal user credentials Consumers: Client Portal

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SessionToken	globally unique identifier	Required
UserName	string	Required
Domain	string	Required
ApplicationId	string	Required
CallerAgentInformation	CallerAgentInformation	None.

Request Formats

application/json, text/json

Sample:

{
  "SessionToken": "a6ab73ae-4867-4c3a-aae3-a2afb4a2a317",
  "UserName": "sample string 2",
  "Domain": "sample string 3",
  "ApplicationId": "sample string 4",
  "CallerAgentInformation": {
    "UserAgent": "sample string 1",
    "IpAddress": "sample string 2",
    "HostServer": "sample string 3",
    "RequestUriAbsolutePath": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<SessionUserAuthenticationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.RequestModels">
  <ApplicationId>sample string 4</ApplicationId>
  <CallerAgentInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.Models">
    <d2p1:HostServer>sample string 3</d2p1:HostServer>
    <d2p1:IpAddress>sample string 2</d2p1:IpAddress>
    <d2p1:RequestUriAbsolutePath>sample string 4</d2p1:RequestUriAbsolutePath>
    <d2p1:UserAgent>sample string 1</d2p1:UserAgent>
  </CallerAgentInformation>
  <Domain>sample string 3</Domain>
  <UserName>sample string 2</UserName>
  <SessionToken>a6ab73ae-4867-4c3a-aae3-a2afb4a2a317</SessionToken>
</SessionUserAuthenticationRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SessionUserAuthenticationRequest'.

Response Information

Resource Description

ClientPortalAuthenticationResponse

Name	Type	Additional information
ClientIds	Collection of integer	None.
SecurityToken	string	None.
TokenExpirationUtcTime	date	None.
ErrorMessage	string	None.
AuthenticationStatus	AuthenticationStatus	None.

Response Formats

application/json, text/json

Sample:

{
  "ClientIds": [
    1,
    2
  ],
  "SecurityToken": "sample string 1",
  "TokenExpirationUtcTime": "2026-05-03T10:35:36.0901477-04:00",
  "ErrorMessage": "sample string 2",
  "AuthenticationStatus": 0
}

application/xml, text/xml

Sample:

<ClientPortalAuthenticationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.ResponseModels">
  <AuthenticationStatus>NotSet</AuthenticationStatus>
  <ErrorMessage>sample string 2</ErrorMessage>
  <SecurityToken>sample string 1</SecurityToken>
  <TokenExpirationUtcTime>2026-05-03T10:35:36.0901477-04:00</TokenExpirationUtcTime>
  <ClientIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ClientIds>
</ClientPortalAuthenticationResponse>