=== Authentication Methods [[post_auth_v1_login]] ==== `POST /auth/v1/login` Generates the Perforce login token for the server. ===== Request Headers [cols="2*", options="header"] |=== | Header Name | Notes | `Accept` | `application/json`, `text/plain` | `Content-Type` | `application/json` | `X-Perforce-Helix_Web_Services-*` | See <<per_request_configuration>> |=== ===== Request Body JSON A single JSON object with the following keys [cols="2*", options="header"] |=== | Property | Description | `user` | The Helix Versioning Engine login | `password` | The password for the particular user |=== ===== Response Headers [cols="2*", options="header"] |=== | Header Name | Notes | `Content-Type` | `application/json`, `text/plain` |=== ===== Response Body See <<error_responses>> for the format of failures. Upon success, when `Content-Type` is `text/plain`, the response body is simply the P4 ticket value. .... 16A76F005802E742E834163A22A4DED4 .... When `Content-Type` is `application/json`, the response is a JSON object. [source,json] ---- { "ticket": "16A76F005802E742E834163A22A4DED4" } ----
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#1 | 15741 | ptomiak | Branch HWS for my use. | ||
//guest/perforce_software/helix-web-services/main/source/doc/auth/http.asc | |||||
#1 | 15622 | tjuricek |
Move source code to 'source/' subdirectory of branch. build/ will remain where it is. |
||
//guest/perforce_software/helix-web-services/main/doc/auth/http.asc | |||||
#2 | 15038 | tjuricek | Document 'login' auth method and client programming overview. | ||
#1 | 15032 | tjuricek |
Starting config and doc revisions. System is now broken while revisions underway. Configuration of the p4d connection is now done via a single HWSSettings middleware object injected into the Rack env. The HWSP4Cleanup middleware now cleans up any p4 injected into the Rack env. The Auth::App class now mostly just contains one method to generate a p4 ticket. /auth/v1/login. Added yard documentation for the main project. Yard docs have been reconfigured to dump into build/ directories. This should probably be done with each release. Hm... The top level rake file contains a task, 'all:doc', to update our documentation. This should probably be run for each checkin. Hm... Specs are now using Rack::Test on top of a 'live' p4d. I'd suggest you still use the p4util mechanism, which now dumps to a /tmp folder, so we can safely add P4IGNORE rules back into your local .p4config file. Old 'perforce' application now called 'helix_versioning_engine'. Removing cache data. Helix Sync may be slow. It may also get axed. We'll see. |