---
title: "POST /share-item"
method: POST
path: "/share-item"
tags: ["General"]
---

# POST /share-item

`POST /share-item`

## Request

- Base URL: `https://api.akeyless.io`
- URL: `https://api.akeyless.io/share-item`
- Auth: none declared

## Request body

- ShareItem
  - `accessibility` string: for personal password manager
  - `action` string, required: Action to be performed on the item [start/stop/describe]
  - `emails` string[]: List of emails to start/stop sharing the secret with
  - `item-name` string, required: Item name
  - `json` boolean: Set output format to JSON
  - `share-type` string: Share type [email/token]
  - `shared-token-id` string[]: Shared token ids in order to stop sharing a secret
  - `token` string: Authentication token (see `/auth` and `/configure`)
  - `ttl` integer: TTL of the Availability of the shared secret in seconds
  - `uid-token` string: The universal identity token, Required only for universal_identity authentication
  - `view-once` boolean: ViewOnlyOnce Shared secrets can only be viewed once [true/false]

## Response `200`

shareItemResponse wraps response body.

- ShareItemOutput
  - `email_error` object
  - `items_error` ResponseStopShareItem[]
    - `errors` EmailError[]
      - `email` string
      - `error` string
      - `token` string
    - `item_name` string
  - `s_token` string
  - `shared_token_id` string
  - `shared_users` string[]
  - `shared_users_full_info` SharingItemFullInfo[]
    - `assigners` RuleAssigner[]
      - `access_id` string
      - `unique_id` string
    - `capabilities` string[]: The approved/denied capabilities in the path
    - `cb` integer
    - `is_limit_access` boolean: flag that indicate that this rule is allowed to be access RemainingAccess of times.
    - `item_id` integer: The item id this rule directly refers to (when applicable)
    - `name` string
    - `number_of_access_used` integer
    - `number_of_allowed_access` integer
    - `path` string: The path the rule refers to
    - `start_time` integer
    - `ttl` integer
    - `type` string
  - `sharing_url` string

## Other responses

- `default`: errorResponse wraps any error to return it as a JSON object with one "error" field.

---

[API](https://skmtc.dev/akeyless/apis/account-settings.md) - [All operations](https://skmtc.dev/akeyless/apis/account-settings/llms.txt) - [OpenAPI document](https://skmtc.dev/akeyless/apis/account-settings/revisions/6beb28d274ac?raw)