---
title: "Add SSH User to the entity"
method: POST
path: "/ssh_user"
tags: ["ssh_user"]
---

# Add SSH User to the entity

`POST /ssh_user`

Add SSH User to the entity

## Request body

- SshUserIntentInput — An intentful representation of a ssh_user
  - `spec` SshUser, required — SSH User Entity
    - `resources` SshUserRequestDetails, required — SSH User Request details
      - `username` string, required — SSH User name
      - `access_request_uuid` string, UUID, required — UUID of the access request requesting SSH access
      - `entity_list` object[], required — List containing entity IP and entity type for each entity
        - `entity_ip` string, required — Entity IP Address
        - `entity_uuid` string — Entity UUID
        - `entity_type` string, required — Entity type
      - `user_key_name` string, required — Name for the user key to add
      - `user_key` string, required — key to add for the user
      - `user_uuid` string, UUID, required — SSH User UUID
      - `user_unix_id` integer — Linux UID for user
  - `api_version` string
  - `metadata` SshUserMetadata, required — The ssh_user kind metadata
    - `last_update_time` string, date-time — UTC date and time in RFC-3339 format when ssh_user was last updated
    - `kind` string, required — The kind name
    - `uuid` string, UUID — ssh_user uuid
    - `spec_version` integer — Version number of the latest spec.
    - `creation_time` string, date-time — UTC date and time in RFC-3339 format when ssh_user was created
    - `spec_hash` string — Hash of the spec. This will be returned from server.
    - `should_force_translate` boolean — Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.
    - `owner_reference` UserReference — The reference to a user
      - `kind` string, required — The kind name
      - `name` string
      - `uuid` string, UUID, required
    - `categories` object — Categories for the ssh_user
    - `name` string — ssh_user name

## Response `202`

Request Accepted

- SshUserIntentResponse — Response object for intentful operations on a ssh_user
  - `status` SshUserDefStatus — SSH User Entity
    - `resources` SshUserDetails, required — SSH User details
      - `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
  - `spec` SshUser — SSH User Entity
    - `resources` SshUserRequestDetails, required — SSH User Request details
      - `username` string, required — SSH User name
      - `access_request_uuid` string, UUID, required — UUID of the access request requesting SSH access
      - `entity_list` object[], required — List containing entity IP and entity type for each entity
        - `entity_ip` string, required — Entity IP Address
        - `entity_uuid` string — Entity UUID
        - `entity_type` string, required — Entity type
      - `user_key_name` string, required — Name for the user key to add
      - `user_key` string, required — key to add for the user
      - `user_uuid` string, UUID, required — SSH User UUID
      - `user_unix_id` integer — Linux UID for user
  - `api_version` string, required
  - `metadata` SshUserMetadata, required — The ssh_user kind metadata
    - `last_update_time` string, date-time — UTC date and time in RFC-3339 format when ssh_user was last updated
    - `kind` string, required — The kind name
    - `uuid` string, UUID — ssh_user uuid
    - `spec_version` integer — Version number of the latest spec.
    - `creation_time` string, date-time — UTC date and time in RFC-3339 format when ssh_user was created
    - `spec_hash` string — Hash of the spec. This will be returned from server.
    - `should_force_translate` boolean — Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.
    - `owner_reference` UserReference — The reference to a user
      - `kind` string, required — The kind name
      - `name` string
      - `uuid` string, UUID, required
    - `categories` object — Categories for the ssh_user
    - `name` string — ssh_user name

## 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)