---
title: "login"
method: POST
path: "/api/users/login"
tags: ["AppUser"]
---

# login

`POST /api/users/login`

## Request body

- LoginViewModel — AppUserController.Login parameter
  - `username` string, nullable — username
  - `password` string, nullable — password
  - `clientAppName` string, nullable — Client App Name
  - `language` string, nullable — Client Language

## Response `200`

OK

- LoggedOnUserModel — Logged On User Model
  - `sessionId` string, uuid — Session Id
  - `token` string, nullable — Security Token
  - `user` PublicRAppUser — user informtaion
    - `id` string, uuid, nullable — Id
    - `username` string, nullable — User Name
    - `email` string, email, nullable — User Email
    - `phoneNumber` string, tel, nullable — User Mobile Phone Number
    - `firstName` string, nullable — First Name
    - `surName` string, nullable — SurName
    - `status` 0 | 1, required — User Status
    - `rImageId` string, uuid, nullable — user image
    - `nickName` string, nullable — nick name
    - `bio` string, nullable — biography
    - `website` string, nullable — web site
    - `emailConfirmed` boolean — email verified
    - `createDate` string, date-time — create date
  - `securableItem` SecurableItem[], nullable — Permissions
    - `shortName` string, nullable — Short Name
    - `description` string, nullable — Descripttion
    - `operations` SecurableItemOperation[], nullable — Operations (short name + description + has permission)
      - `shortName` string, nullable — Short Name
      - `description` string, nullable — Descripttion
      - `prerequisites` SecurableItemOperationPrerequisite[], nullable — Prerequisites
        - `secureItemShortName` string, nullable — Prerequisite SecureItem ShortName
        - `operationShortName` string, nullable — Prerequisite Operation ShortName
      - `status` boolean — Status (has permission)

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/ganjoor/apis/rmuseum-api.md) · [All operations](https://skmtc.net/ganjoor/apis/rmuseum-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ganjoor/rmuseum-api/versions/bb8e104d36d2/schema)