POST api/login

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Anonymous	boolean	Required
AppModuleNumber	integer	Required
UserName	string	None.
Password	string	None.
TwoFactorKey	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Anonymous": true,
  "AppModuleNumber": 2,
  "UserName": "sample string 3",
  "Password": "sample string 4",
  "TwoFactorKey": "sample string 5"
}

application/xml, text/xml

Sample:

<SpaAuthLoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">
  <Anonymous>true</Anonymous>
  <AppModuleNumber>2</AppModuleNumber>
  <Password>sample string 4</Password>
  <TwoFactorKey>sample string 5</TwoFactorKey>
  <UserName>sample string 3</UserName>
</SpaAuthLoginRequest>

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 'SpaAuthLoginRequest'.

Response Information

Resource Description

SpaAuthLoginResultApp

Name	Type	Additional information
Result	string	None.
Authentication	SpaAuthApp	None.
FirstName	string	None.
LastName	string	None.
Email	string	None.
Roles	Collection of integer	None.
Custom1	string	None.
Custom2	string	None.
Features	Collection of SpaFeatureApp	None.
FeatureAccess	Collection of SpaFeatureAccessApp	None.
Routes	Collection of SpaRouteApp	None.
Actions	Collection of integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": "sample string 1",
  "Authentication": {
    "Id": 1,
    "AuthKey": "sample string 1",
    "UserId": 1,
    "IsValid": true,
    "LoginTime": "2025-12-19T05:26:56.8561604+01:00",
    "ValidUntil": "2025-12-19T05:26:56.8561604+01:00",
    "LogoutTime": "2025-12-19T05:26:56.8561604+01:00"
  },
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Email": "sample string 4",
  "Roles": [
    1,
    2
  ],
  "Custom1": "sample string 5",
  "Custom2": "sample string 6",
  "Features": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "DisplayName": "sample string 3",
      "IconName": "sample string 4"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "DisplayName": "sample string 3",
      "IconName": "sample string 4"
    }
  ],
  "FeatureAccess": [
    {
      "Id": 1,
      "UserRoleId": 1,
      "FeatureId": 1
    },
    {
      "Id": 1,
      "UserRoleId": 1,
      "FeatureId": 1
    }
  ],
  "Routes": [
    {
      "Id": 1,
      "UserRoleId": 1,
      "CallingFeatureId": 1,
      "TargetFeatureId": 1,
      "Route": "sample string 2",
      "IsGlobalRoute": true,
      "AlternateFeatureText": "sample string 3",
      "UserRoleCustom1": "sample string 4"
    },
    {
      "Id": 1,
      "UserRoleId": 1,
      "CallingFeatureId": 1,
      "TargetFeatureId": 1,
      "Route": "sample string 2",
      "IsGlobalRoute": true,
      "AlternateFeatureText": "sample string 3",
      "UserRoleCustom1": "sample string 4"
    }
  ],
  "Actions": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<SpaAuthLoginResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">
  <Actions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Actions>
  <Authentication>
    <AuthKey>sample string 1</AuthKey>
    <Id>1</Id>
    <IsValid>true</IsValid>
    <LoginTime>2025-12-19T05:26:56.8561604+01:00</LoginTime>
    <LogoutTime>2025-12-19T05:26:56.8561604+01:00</LogoutTime>
    <UserId>1</UserId>
    <ValidUntil>2025-12-19T05:26:56.8561604+01:00</ValidUntil>
  </Authentication>
  <Custom1>sample string 5</Custom1>
  <Custom2>sample string 6</Custom2>
  <Email>sample string 4</Email>
  <FeatureAccess>
    <SpaFeatureAccess>
      <FeatureId>1</FeatureId>
      <Id>1</Id>
      <UserRoleId>1</UserRoleId>
    </SpaFeatureAccess>
    <SpaFeatureAccess>
      <FeatureId>1</FeatureId>
      <Id>1</Id>
      <UserRoleId>1</UserRoleId>
    </SpaFeatureAccess>
  </FeatureAccess>
  <Features>
    <SpaFeature>
      <DisplayName>sample string 3</DisplayName>
      <IconName>sample string 4</IconName>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </SpaFeature>
    <SpaFeature>
      <DisplayName>sample string 3</DisplayName>
      <IconName>sample string 4</IconName>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </SpaFeature>
  </Features>
  <FirstName>sample string 2</FirstName>
  <LastName>sample string 3</LastName>
  <Result>sample string 1</Result>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Roles>
  <Routes>
    <SpaRoute>
      <AlternateFeatureText>sample string 3</AlternateFeatureText>
      <CallingFeatureId>1</CallingFeatureId>
      <Id>1</Id>
      <IsGlobalRoute>true</IsGlobalRoute>
      <Route>sample string 2</Route>
      <TargetFeatureId>1</TargetFeatureId>
      <UserRoleCustom1>sample string 4</UserRoleCustom1>
      <UserRoleId>1</UserRoleId>
    </SpaRoute>
    <SpaRoute>
      <AlternateFeatureText>sample string 3</AlternateFeatureText>
      <CallingFeatureId>1</CallingFeatureId>
      <Id>1</Id>
      <IsGlobalRoute>true</IsGlobalRoute>
      <Route>sample string 2</Route>
      <TargetFeatureId>1</TargetFeatureId>
      <UserRoleCustom1>sample string 4</UserRoleCustom1>
      <UserRoleId>1</UserRoleId>
    </SpaRoute>
  </Routes>
</SpaAuthLoginResult>