POST api/Auth/Login
Provided with correct username an password will return WebApiTicket. Normaly authenticates through RostarCas Username Password combination. Remember if directory Services is used then change the usernames in cas to a domain\username combination.
Request Information
URI Parameters
None.
Body Parameters
LoginModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UserName |
Must contain a username |
string |
Required |
| Password |
Must contain a password |
string |
Required |
Request Formats
application/json, text/json
Sample:
{
"UserName": "sample string 1",
"Password": "sample string 2"
}
application/xml, text/xml
Sample:
<LoginModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RostarCASWebAPI.Models"> <Password>sample string 2</Password> <UserName>sample string 1</UserName> </LoginModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
WebApiToken
WebApiTicket| Name | Description | Type | Additional information |
|---|---|---|---|
| Ticket | string |
None. |
|
| ValidForMin |
returns the duration when the ticket is valid in minutes |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Ticket": "sample string 1",
"ValidForMin": 2
}
application/xml, text/xml
Sample:
<WebApiTicket xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RostarCASWebAPI.Models"> <Ticket>sample string 1</Ticket> <ValidForMin>2</ValidForMin> </WebApiTicket>