POST api/Authentication/Login?authCookieName={authCookieName}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| authCookieName | string |
None. |
Body Parameters
ApiLogin| Name | Description | Type | Additional information |
|---|---|---|---|
| Username | string |
None. |
|
| Password | string |
None. |
|
| RememberMe | boolean |
None. |
|
| ClientId | string |
None. |
|
| ForceLogin | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Username": "sample string 1",
"Password": "sample string 2",
"RememberMe": true,
"ClientId": "sample string 4",
"ForceLogin": true
}
application/xml, text/xml
Sample:
<ApiLogin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cyzerg.WebApi.Extensions.Common"> <ClientId>sample string 4</ClientId> <ForceLogin>true</ForceLogin> <Password>sample string 2</Password> <RememberMe>true</RememberMe> <Username>sample string 1</Username> </ApiLogin>
application/x-www-form-urlencoded
Sample:
Sample not available.
text/html
Sample:
{"Username":"sample string 1","Password":"sample string 2","RememberMe":true,"ClientId":"sample string 4","ForceLogin":true}
Response Information
Resource Description
Token| Name | Description | Type | Additional information |
|---|---|---|---|
| .expires | string |
None. |
|
| .issued | string |
None. |
|
| access_token | string |
None. |
|
| as:client_id | string |
None. |
|
| expires_in | integer |
None. |
|
| refresh_token | string |
None. |
|
| token_type | string |
None. |
|
| userName | string |
None. |
|
| fullName | string |
None. |
|
| currentLoggedInUser | Object |
None. |
|
| tenant_dbs | string |
None. |
|
| menus | Collection of MenusEntity |
None. |
Response Formats
application/json, text/json
Sample:
{
".expires": "sample string 1",
".issued": "sample string 2",
"access_token": "sample string 3",
"as:client_id": "sample string 4",
"expires_in": 5,
"refresh_token": "sample string 6",
"token_type": "sample string 7",
"userName": "sample string 8",
"fullName": "sample string 9",
"currentLoggedInUser": {},
"tenant_dbs": "sample string 11",
"menus": [
{
"ModuleName": "sample string 1",
"ModuleUrl": "sample string 2",
"SubModules": [
{
"SubModuleName": "sample string 1",
"SubModuleUrl": "sample string 2",
"HasSubMenus": true,
"SubMenus": [
{
"ScreenName": "sample string 1",
"SubMenuUrl": "sample string 2"
},
{
"ScreenName": "sample string 1",
"SubMenuUrl": "sample string 2"
}
]
},
{
"SubModuleName": "sample string 1",
"SubModuleUrl": "sample string 2",
"HasSubMenus": true,
"SubMenus": [
{
"ScreenName": "sample string 1",
"SubMenuUrl": "sample string 2"
},
{
"ScreenName": "sample string 1",
"SubMenuUrl": "sample string 2"
}
]
}
]
},
{
"ModuleName": "sample string 1",
"ModuleUrl": "sample string 2",
"SubModules": [
{
"SubModuleName": "sample string 1",
"SubModuleUrl": "sample string 2",
"HasSubMenus": true,
"SubMenus": [
{
"ScreenName": "sample string 1",
"SubMenuUrl": "sample string 2"
},
{
"ScreenName": "sample string 1",
"SubMenuUrl": "sample string 2"
}
]
},
{
"SubModuleName": "sample string 1",
"SubModuleUrl": "sample string 2",
"HasSubMenus": true,
"SubMenus": [
{
"ScreenName": "sample string 1",
"SubMenuUrl": "sample string 2"
},
{
"ScreenName": "sample string 1",
"SubMenuUrl": "sample string 2"
}
]
}
]
}
]
}
application/xml, text/xml
Sample:
<Token xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cyzerg.WebApi.Extensions.Common">
<AccessToken>sample string 3</AccessToken>
<ClientId>sample string 4</ClientId>
<Expires>sample string 1</Expires>
<ExpiresIn>5</ExpiresIn>
<Fullname>sample string 9</Fullname>
<Issued>sample string 2</Issued>
<Menus xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cyzerg.Model">
<d2p1:MenusEntity>
<d2p1:ModuleName>sample string 1</d2p1:ModuleName>
<d2p1:ModuleUrl>sample string 2</d2p1:ModuleUrl>
<d2p1:SubModules>
<d2p1:SubModule>
<d2p1:HasSubMenus>true</d2p1:HasSubMenus>
<d2p1:SubMenus>
<d2p1:SubMenu>
<d2p1:ScreenName>sample string 1</d2p1:ScreenName>
<d2p1:SubMenuUrl>sample string 2</d2p1:SubMenuUrl>
</d2p1:SubMenu>
<d2p1:SubMenu>
<d2p1:ScreenName>sample string 1</d2p1:ScreenName>
<d2p1:SubMenuUrl>sample string 2</d2p1:SubMenuUrl>
</d2p1:SubMenu>
</d2p1:SubMenus>
<d2p1:SubModuleName>sample string 1</d2p1:SubModuleName>
<d2p1:SubModuleUrl>sample string 2</d2p1:SubModuleUrl>
</d2p1:SubModule>
<d2p1:SubModule>
<d2p1:HasSubMenus>true</d2p1:HasSubMenus>
<d2p1:SubMenus>
<d2p1:SubMenu>
<d2p1:ScreenName>sample string 1</d2p1:ScreenName>
<d2p1:SubMenuUrl>sample string 2</d2p1:SubMenuUrl>
</d2p1:SubMenu>
<d2p1:SubMenu>
<d2p1:ScreenName>sample string 1</d2p1:ScreenName>
<d2p1:SubMenuUrl>sample string 2</d2p1:SubMenuUrl>
</d2p1:SubMenu>
</d2p1:SubMenus>
<d2p1:SubModuleName>sample string 1</d2p1:SubModuleName>
<d2p1:SubModuleUrl>sample string 2</d2p1:SubModuleUrl>
</d2p1:SubModule>
</d2p1:SubModules>
</d2p1:MenusEntity>
<d2p1:MenusEntity>
<d2p1:ModuleName>sample string 1</d2p1:ModuleName>
<d2p1:ModuleUrl>sample string 2</d2p1:ModuleUrl>
<d2p1:SubModules>
<d2p1:SubModule>
<d2p1:HasSubMenus>true</d2p1:HasSubMenus>
<d2p1:SubMenus>
<d2p1:SubMenu>
<d2p1:ScreenName>sample string 1</d2p1:ScreenName>
<d2p1:SubMenuUrl>sample string 2</d2p1:SubMenuUrl>
</d2p1:SubMenu>
<d2p1:SubMenu>
<d2p1:ScreenName>sample string 1</d2p1:ScreenName>
<d2p1:SubMenuUrl>sample string 2</d2p1:SubMenuUrl>
</d2p1:SubMenu>
</d2p1:SubMenus>
<d2p1:SubModuleName>sample string 1</d2p1:SubModuleName>
<d2p1:SubModuleUrl>sample string 2</d2p1:SubModuleUrl>
</d2p1:SubModule>
<d2p1:SubModule>
<d2p1:HasSubMenus>true</d2p1:HasSubMenus>
<d2p1:SubMenus>
<d2p1:SubMenu>
<d2p1:ScreenName>sample string 1</d2p1:ScreenName>
<d2p1:SubMenuUrl>sample string 2</d2p1:SubMenuUrl>
</d2p1:SubMenu>
<d2p1:SubMenu>
<d2p1:ScreenName>sample string 1</d2p1:ScreenName>
<d2p1:SubMenuUrl>sample string 2</d2p1:SubMenuUrl>
</d2p1:SubMenu>
</d2p1:SubMenus>
<d2p1:SubModuleName>sample string 1</d2p1:SubModuleName>
<d2p1:SubModuleUrl>sample string 2</d2p1:SubModuleUrl>
</d2p1:SubModule>
</d2p1:SubModules>
</d2p1:MenusEntity>
</Menus>
<RefreshToken>sample string 6</RefreshToken>
<TenantDbs>sample string 11</TenantDbs>
<TokenType>sample string 7</TokenType>
<User />
<Username>sample string 8</Username>
</Token>
text/html
Sample:
{".expires":"sample string 1",".issued":"sample string 2","access_token":"sample string 3","as:client_id":"sample string 4","expires_in":5,"refresh_token":"sample string 6","token_type":"sample string 7","userName":"sample string 8","fullName":"sample string 9","currentLoggedInUser":{},"tenant_dbs":"sample string 11","menus":[{"ModuleName":"sample string 1","ModuleUrl":"sample string 2","SubModules":[{"SubModuleName":"sample string 1","SubModuleUrl":"sample string 2","HasSubMenus":true,"SubMenus":[{"ScreenName":"sample string 1","SubMenuUrl":"sample string 2"},{"ScreenName":"sample string 1","SubMenuUrl":"sample string 2"}]},{"SubModuleName":"sample string 1","SubModuleUrl":"sample string 2","HasSubMenus":true,"SubMenus":[{"ScreenName":"sample string 1","SubMenuUrl":"sample string 2"},{"ScreenName":"sample string 1","SubMenuUrl":"sample string 2"}]}]},{"ModuleName":"sample string 1","ModuleUrl":"sample string 2","SubModules":[{"SubModuleName":"sample string 1","SubModuleUrl":"sample string 2","HasSubMenus":true,"SubMenus":[{"ScreenName":"sample string 1","SubMenuUrl":"sample string 2"},{"ScreenName":"sample string 1","SubMenuUrl":"sample string 2"}]},{"SubModuleName":"sample string 1","SubModuleUrl":"sample string 2","HasSubMenus":true,"SubMenus":[{"ScreenName":"sample string 1","SubMenuUrl":"sample string 2"},{"ScreenName":"sample string 1","SubMenuUrl":"sample string 2"}]}]}]}