---
title: "Log in."
method: POST
path: "/users/login"
tags: ["Users"]
---

# Log in.

`POST /users/login`

## Request body

- LoginUserCommand
  - `Password` string, required — The password to log in with.
  - `RememberMe` boolean — Whether the cookie should be persistent.
  - `RemoteIpAddress` string — IP Address of the user
  - `State` LoginState
    - `RedirectAfterLoginTo` string — The Url, relative to the portal site, to redirect to post successful login.
    - `UsingSecureConnection` boolean — Whether the client says it's using a secure connection. We need this because SSL offloading can obscure this and the server cannot tell whether the client initiated the call using a secure connection.
  - `Username` string, required — The username to log in with.

## Response `200`

The details of a successful login

- UserResource
  - `CanPasswordBeEdited` boolean
  - `Created` string, date-time
  - `DisplayName` string, required
  - `EmailAddress` string, email
  - `Id` string — Gets or sets a unique identifier for this resource.
  - `Identities` IdentityResource[]
    - `Claims` object
    - `IdentityProviderName` string
  - `IsActive` boolean
  - `IsRequestor` boolean — Gets or sets a value indicating whether this user resource represents the user who requested it.
  - `IsService` boolean
  - `LastModifiedBy` string — Gets or sets the username of the user who last modified this resource.
  - `LastModifiedOn` string, date-time — Gets or sets the date/time that this resource was last modified.
  - `Links` object — Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  - `Password` string
  - `ServiceAccountType` 'Standard' | 'Agent'
  - `Username` string

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/revisions/b296c3a60aa5/schema)