POST authenticate
Retrieve a new JWT token by passing your FlowWorks username and password in the body of the request. See the See the 'Authentication' section for details on how to use this token in all of your API requests.
Request Information
URI Parameters
None.
Body Parameters
TokenRequestVMName | Description | Type | Additional information |
---|---|---|---|
UserName |
A FlowWorks user name. |
string |
None. |
Password |
The password for the FlowWorks user. |
string |
None. |
Request Formats
application/json, text/json
{ "UserName": "sample string 1", "Password": "sample string 2" }
application/xml, text/xml
<TokenRequestVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FW.WebApi2.ViewModels"> <Password>sample string 2</Password> <UserName>sample string 1</UserName> </TokenRequestVM>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
A Token object containing the token, the time when it was issued, and the time when it will expire.
TokenVMName | Description | Type | Additional information |
---|---|---|---|
Token |
A JWT token string. |
string |
None. |
IssuedAt |
The UTC time when the token was created in 'yyyy-MM-dd HH:mm:ss.fff' format. |
string |
None. |
Expires |
The UTC time when the token expires in 'yyyy-MM-dd HH:mm:ss.fff' format. |
string |
None. |
Response Formats
application/json, text/json
{ "Token": "sample string 1", "IssuedAt": "sample string 2", "Expires": "sample string 3" }
application/xml, text/xml
<TokenVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FW.WebApi2.ViewModels"> <Expires>sample string 3</Expires> <IssuedAt>sample string 2</IssuedAt> <Token>sample string 1</Token> </TokenVM>