login.asc #1

=== Helix Versioning Engine Login

[[post_p4_vX_login]]
==== `POST /p4/v[api]/login`

Generates a host-unlocked Perforce login token for the server.

This is useful in cases where the authentication source is not the same as the p4d instance you operate most operations as.
If you happen to have the same authentication source, you can always run this; you'll pretty much just get the same ticket.

===== 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`
|===

===== Response Body

See <<error_responses>> for the format of failures.

Example response:

[source,json]
----
{
  "ticket": "16A76F005802E742E834163A22A4DED4"
}
----