POST Auth/Login

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
SessionID	integer	None.
UserID	integer	None.
UserHash	string	None.
UserToken	string	None.
RefreshToken	string	None.
ExpiryDateUtc	date	None.
SessionData	Collection of Object	None.
AppData	Collection of Object	None.
Props	Collection of Object	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
Expired	boolean	None.
ExpiresSoon	boolean	None.
UserName	string	None.
IsAuthorized	boolean	None.
Features	Collection of string	None.
Summary	string	None.
IsSingleSignOn	boolean	None.

Response Formats

application/json

Sample:

{
  "sessionID": 1,
  "userID": 2,
  "userHash": "sample string 3",
  "userToken": "sample string 4",
  "refreshToken": "",
  "expiryDateUtc": "2024-05-20T04:23:26.0970256+00:00",
  "appData": [
    {
      "n": "RefreshToken"
    }
  ],
  "props": [
    {
      "n": "RefreshToken"
    }
  ],
  "recordState": 1,
  "created": {
    "dateUtc": "2024-05-20T04:23:26.0970256+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 5/20/2024 4:23:26 AMZ"
  },
  "lastUpdated": {
    "dateUtc": "2024-05-20T04:23:26.0970256+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 5/20/2024 4:23:26 AMZ"
  },
  "expired": true,
  "expiresSoon": false,
  "userName": "",
  "isAuthorized": true,
  "features": [
    "sample string 1",
    "sample string 2"
  ],
  "summary": "sample string 4",
  "isSingleSignOn": false
}

text/json

Sample:

{
  "sessionID": 1,
  "userID": 2,
  "userHash": "sample string 3",
  "userToken": "sample string 4",
  "refreshToken": "",
  "expiryDateUtc": "2024-05-20T04:23:26.0970256+00:00",
  "appData": [
    {
      "n": "RefreshToken"
    },
    {
      "n": "UserName"
    }
  ],
  "props": [
    {
      "n": "RefreshToken"
    },
    {
      "n": "UserName"
    }
  ],
  "recordState": 1,
  "created": {
    "dateUtc": "2024-05-20T04:23:26.0970256+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 5/20/2024 4:23:26 AMZ"
  },
  "lastUpdated": {
    "dateUtc": "2024-05-20T04:23:26.0970256+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 5/20/2024 4:23:26 AMZ"
  },
  "expired": true,
  "expiresSoon": false,
  "userName": "",
  "isAuthorized": true,
  "features": [
    "sample string 1",
    "sample string 2"
  ],
  "summary": "sample string 4",
  "isSingleSignOn": false
}

application/xml, text/xml

Sample:

<UserSessionDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.AuthClient.Abstractions">
  <AppData xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections">
    <d2p1:Property>
      <d2p1:Name>RefreshToken</d2p1:Name>
      <d2p1:Value i:nil="true" />
      <d2p1:ValueForXML i:nil="true" />
    </d2p1:Property>
    <d2p1:Property>
      <d2p1:Name>UserName</d2p1:Name>
      <d2p1:Value i:nil="true" />
      <d2p1:ValueForXML i:nil="true" />
    </d2p1:Property>
  </AppData>
  <Created xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Models">
    <d2p1:DateUtc>2024-05-20T04:23:26.0970256+00:00</d2p1:DateUtc>
    <d2p1:UserName>sample string 2</d2p1:UserName>
  </Created>
  <ExpiryDateUtc>2024-05-20T04:23:26.0970256+00:00</ExpiryDateUtc>
  <Features xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Features>
  <LastUpdated xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Models">
    <d2p1:DateUtc>2024-05-20T04:23:26.0970256+00:00</d2p1:DateUtc>
    <d2p1:UserName>sample string 2</d2p1:UserName>
  </LastUpdated>
  <Props xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections">
    <d2p1:Property>
      <d2p1:Name>RefreshToken</d2p1:Name>
      <d2p1:Value i:nil="true" />
      <d2p1:ValueForXML i:nil="true" />
    </d2p1:Property>
    <d2p1:Property>
      <d2p1:Name>UserName</d2p1:Name>
      <d2p1:Value i:nil="true" />
      <d2p1:ValueForXML i:nil="true" />
    </d2p1:Property>
  </Props>
  <RecordState>Active</RecordState>
  <SessionData xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" i:nil="true" />
  <SessionID>1</SessionID>
  <UserHash>sample string 3</UserHash>
  <UserID>2</UserID>
  <UserToken>sample string 4</UserToken>
</UserSessionDTO>

application/x-compressed-json

Sample:

�͑�N�@�_%�JK�פ��*u��H��:���Hr��E�D}2�W�I�
���������?�?j $�Ly;5@E�Pv፦-( ]��.+7�:qa^�<QCV�Ҷ/���������'��B�C
�X�Pɉ��Kq}%d4�B	�=�ZnР�kh�<���t�%���a��u������3V���!�)�ҳP�~��6$�T�v�S-0e��5���`v�Ĵ�k�K�����
�w�O��᭮uN�˕m2�U~k\�v�Z�~+n����#��߬aks�c�mʇ�b�!m,�