---
title: "Get Users"
method: GET
path: "/connect/users"
tags: ["Users"]
---

# Get Users

`GET /connect/users`

Returns all SOC users.

## Response `200`

List of user objects, or empty list if not permitted to view user list

- ModelUser[]
  - `createTime` string — The date and time that this user was created. This is a read-only field.
  - `email` string — The email address for this user.
  - `firstName` string — The user's first name.
  - `id` string — The ID assigned to this user by the server. This is a read-only field.
  - `lastName` string — The user's last name, or family name.
  - `note` string — A custom note about this user.
  - `oidcStatus` string — The OIDC status for this user. This is a read-only field.
  - `password` string — The password must have a length of at least 8 characters and no more than 72 characters and cannot contain the following: ' " $ \
  - `passwordChanged` boolean — A rough determination of whether this user has changed their password since the user was created. Technically this can only detect if the user has been updated after creation and is therefore an imperfect estimator for whether the password has been changed. This is a read-only field.
  - `roles` string[] — A list of assigned roles to this user.
  - `searchUsername` string — An alternate username (typically an email address) to use when performing backend (Ex: Elasticsearch) data searches and updates.
  - `status` string — The login status of this user.
  - `totpStatus` string — The TOTP MFA status for this user. This is a read-only field.
  - `updateTime` string — The date and time that this user was last modified. This is a read-only field.
  - `webauthnStatus` string — The WebAuthn (Passwordless) status for this user. This status field is not ready for production use. This is a read-only field.

## Other responses

- `401` — Request was not properly authenticated
- `405` — User module not configured on server
- `500` — Internal SOC error; review SOC logs

---

[API](https://skmtc.net/security-onion-solutions/apis/security-onion-connect-api.md) · [All operations](https://skmtc.net/security-onion-solutions/apis/security-onion-connect-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/security-onion-solutions/security-onion-connect-api/versions/0576ce393f8d/schema)