POST api/Users/LoginAuth

Request Information

URI Parameters

None.

Body Parameters

userAuth
NameDescriptionTypeAdditional information
userName

string

None.

IDP

string

None.

AuthKey

string

None.

Guid

string

None.

Request Formats

application/json, text/json

Sample:
{
  "userName": "sample string 1",
  "IDP": "sample string 2",
  "AuthKey": "sample string 3",
  "Guid": "sample string 4"
}

application/xml, text/xml

Sample:
<userAuth xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UserManagementAPI.Models">
  <AuthKey>sample string 3</AuthKey>
  <Guid>sample string 4</Guid>
  <IDP>sample string 2</IDP>
  <userName>sample string 1</userName>
</userAuth>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RootObjectOfUserLoginDetails
NameDescriptionTypeAdditional information
Success

integer

None.

LoginCount

integer

None.

Message

string

None.

Value

string

None.

token

string

None.

Result

UserLoginDetails

None.

NoOfRecords

integer

None.

Alert

string

None.

AlertType

string

None.

Action

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": 1,
  "LoginCount": 2,
  "Message": "sample string 3",
  "Value": "sample string 4",
  "token": "sample string 5",
  "Result": {
    "UserID": 1,
    "UserName": "sample string 1",
    "Email": "sample string 2",
    "UTCOffset": "sample string 3",
    "IsSuperUser": "sample string 4",
    "role_id": 1,
    "is_active": 1,
    "profile_pic": "sample string 5",
    "Token_type": "sample string 6",
    "Refresh_token": "sample string 7",
    "Access_token": "sample string 8",
    "Expires_in": 9,
    "RoleID": 10,
    "Profile_pic": "sample string 11",
    "UserType": "sample string 12",
    "expires": "sample string 13",
    "issued": "sample string 14",
    "TenantId": "sample string 15",
    "SubTenantId": "sample string 16",
    "TPTenantId": "sample string 17",
    "CompName": "sample string 18",
    "GUID": "sample string 19",
    "TradeType": "sample string 20",
    "IsWOMSPlusAccess": true,
    "IsSpiceTradeAccess": true,
    "IsWOMSAccess": true,
    "IsCatalogAccess": true,
    "IsShipmentMenu": true,
    "IsInvoiceMenu": true,
    "IsCDAMenu": true,
    "IDP": "sample string 28",
    "HVMSAccess": true,
    "PartnerManagementAccess": true
  },
  "NoOfRecords": 6,
  "Alert": "sample string 7",
  "AlertType": "sample string 8",
  "Action": "sample string 9"
}

application/xml, text/xml

Sample:
<RootObjectOfUserLoginDetailsAnoMCRry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UserManagementAPI.Models">
  <Action>sample string 9</Action>
  <Alert>sample string 7</Alert>
  <AlertType>sample string 8</AlertType>
  <LoginCount>2</LoginCount>
  <Message>sample string 3</Message>
  <NoOfRecords>6</NoOfRecords>
  <Result>
    <Access_token>sample string 8</Access_token>
    <CompName>sample string 18</CompName>
    <Email>sample string 2</Email>
    <Expires_in>9</Expires_in>
    <GUID>sample string 19</GUID>
    <HVMSAccess>true</HVMSAccess>
    <IDP>sample string 28</IDP>
    <IsCDAMenu>true</IsCDAMenu>
    <IsCatalogAccess>true</IsCatalogAccess>
    <IsInvoiceMenu>true</IsInvoiceMenu>
    <IsShipmentMenu>true</IsShipmentMenu>
    <IsSpiceTradeAccess>true</IsSpiceTradeAccess>
    <IsSuperUser>sample string 4</IsSuperUser>
    <IsWOMSAccess>true</IsWOMSAccess>
    <IsWOMSPlusAccess>true</IsWOMSPlusAccess>
    <PartnerManagementAccess>true</PartnerManagementAccess>
    <Profile_pic>sample string 11</Profile_pic>
    <Refresh_token>sample string 7</Refresh_token>
    <RoleID>10</RoleID>
    <SubTenantId>sample string 16</SubTenantId>
    <TPTenantId>sample string 17</TPTenantId>
    <TenantId>sample string 15</TenantId>
    <Token_type>sample string 6</Token_type>
    <TradeType>sample string 20</TradeType>
    <UTCOffset>sample string 3</UTCOffset>
    <UserID>1</UserID>
    <UserName>sample string 1</UserName>
    <UserType>sample string 12</UserType>
    <expires>sample string 13</expires>
    <is_active>1</is_active>
    <issued>sample string 14</issued>
    <profile_pic>sample string 5</profile_pic>
    <role_id>1</role_id>
  </Result>
  <Success>1</Success>
  <Value>sample string 4</Value>
  <token>sample string 5</token>
</RootObjectOfUserLoginDetailsAnoMCRry>