POST api/SysSecurity/GeneratePersistentToken
Authenticate the given login credentials and generate a persistent authentication token. This action requires a valid authentication token
Request Information
URI Parameters
None.
Body Parameters
Login Credentials
AuthenticationInputName | Description | Type | Additional information |
---|---|---|---|
Username |
User Name for Login |
string |
Required |
Password |
Password for Login |
string |
Required |
Request Formats
application/json, text/json
Sample:
{ "Username": "sample string 1", "Password": "sample string 2" }
application/xml, text/xml
Sample:
<AuthenticationInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.Base.WebAPI.Models"> <Password>sample string 2</Password> <Username>sample string 1</Username> </AuthenticationInput>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Instance of AuthenticatedUserModel - With AuthenticationToken. Failed response includes Http Status 400, 401, 500
AuthenticatedUserModelName | Description | Type | Additional information |
---|---|---|---|
IsAuthenticated |
Indicates whether the User is Authenticated |
boolean |
None. |
UserInfo |
Instance of the User Details. Null if the User is not Authenticated |
SysUserData |
None. |
AuthenticationToken |
API authentication token for the User. Empty if the User is not Authenticated |
string |
None. |
SessionId | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsAuthenticated": true, "UserInfo": null, "AuthenticationToken": "sample string 2", "SessionId": "sample string 3" }
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.