---
title: "Retrieves all SSH Users on the cluster"
method: POST
path: "/ssh_user/list"
tags: ["ssh_user"]
---

# Retrieves all SSH Users on the cluster

`POST /ssh_user/list`

Retrieves all SSH Users on the cluster

## Request body

- SshUserListMetadata — All api calls that return a list will have this metadata block as input
  - `filter` string — The filter in FIQL syntax used for the results.
  - `kind` string — The kind name
  - `sort_order` string — The sort order in which results are returned
  - `offset` integer — Offset from the start of the entity list
  - `length` integer — The number of records to retrieve relative to the offset
  - `sort_attribute` string — The attribute to perform sort on

## Response `200`

Success

- SshUserList — SSH User list
  - `entities` SshUserDetails[], required
    - `username` string, required — SSH User name
    - `user_uuid` string, UUID, required — SSH User UUID
    - `access_request_uuid` string, UUID, required — UUID of the access request requesting SSH access
    - `entity_list` object[], required — List of IP addresses to the entity which the user requested access to
      - `entity_ip` string — Entity IP Address
      - `entity_uuid` string — Entity UUID
      - `entity_type` string — Entity IP Address
  - `metadata` SshUserListMetadata, required — All api calls that return a list will have this metadata block as input
    - `filter` string — The filter in FIQL syntax used for the results.
    - `kind` string — The kind name
    - `sort_order` string — The sort order in which results are returned
    - `offset` integer — Offset from the start of the entity list
    - `length` integer — The number of records to retrieve relative to the offset
    - `sort_attribute` string — The attribute to perform sort on

## Other responses

- `default` — Internal Error

---

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