---
title: "A command resource used for logging in."
method: POST
path: "/users/login"
tags: ["Users"]
---

# A command resource used for logging in.

`POST /users/login`

## Request body

- LoginUserCommand
  - `Password` string, required
  - `RememberMe` boolean
  - `RemoteIpAddress` string
  - `State` LoginState
    - `RedirectAfterLoginTo` string
    - `UsingSecureConnection` boolean
  - `Username` string, required

## Response `200`

The details of a successful login

- UserResource
  - `CanPasswordBeEdited` boolean
  - `Created` string, date-time
  - `DisplayName` string, required
  - `EmailAddress` string, email
  - `Id` string
  - `Identities` IdentityResource[]
    - `Claims` object
    - `IdentityProviderName` string
  - `IsActive` boolean
  - `IsRequestor` boolean
  - `IsService` boolean
  - `LastModifiedBy` string
  - `LastModifiedOn` string, date-time
  - `Links` object
  - `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/versions/bc9158facfc7/schema)