POST api/serviceaccount/login
Request Information
URI Parameters
None.
Body Parameters
ServiceLogin| Name | Description | Type | Additional information |
|---|---|---|---|
| ServiceKey | string |
Required |
|
| UserId | string |
Required |
|
| UserIdentifier | UserIdentifierType |
Required |
Request Formats
application/json, text/json
Sample:
{
"ServiceKey": "sample string 1",
"UserId": "sample string 2",
"UserIdentifier": "SSN"
}
application/xml, text/xml
Sample:
<ServiceLogin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Security.Domain"> <ServiceKey>sample string 1</ServiceKey> <UserId>sample string 2</UserId> <UserIdentifier>SSN</UserIdentifier> </ServiceLogin>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ServiceAuthenticationResult| Name | Description | Type | Additional information |
|---|---|---|---|
| LoginStatus | ServiceLoginStatus |
None. |
|
| SecurityToken | string |
None. |
|
| TokenExpirationUtcTime | date |
None. |
|
| ErrorMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"LoginStatus": 1,
"SecurityToken": "sample string 1",
"TokenExpirationUtcTime": "2025-12-17T20:29:42.7985755-05:00",
"ErrorMessage": "sample string 2"
}
application/xml, text/xml
Sample:
<ServiceAuthenticationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Security.Domain"> <ErrorMessage>sample string 2</ErrorMessage> <SecurityToken>sample string 1</SecurityToken> <TokenExpirationUtcTime>2025-12-17T20:29:42.7985755-05:00</TokenExpirationUtcTime> <LoginStatus>ValidAccount</LoginStatus> </ServiceAuthenticationResult>