---
title: "Simulate sharing a resource."
method: POST
path: "/share/simulate/resource/{foreignId}.json"
tags: ["Shares"]
---

# Simulate sharing a resource.

`POST /share/simulate/resource/{foreignId}.json`

## Request

- Base URL: `https://passbolt.local`
- URL: `https://passbolt.local/share/simulate/resource/{foreignId}.json`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/passbolt/apis/passbolt-api/docs/share/simulate/resource/:foreignId.json/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `foreignId` string, uuid, required

## Request body

- ShareUpdate
  - `permissions` PermissionUpdate[]
    - `id` string, uuid
    - `aro` 'User' | 'Group'
    - `aro_foreign_key` string, uuid
    - `type` 1 | 7 | 15: * `1` - Read * `7` - Update * `15` - Owner
    - `delete` boolean
    - `is_new` boolean
  - `secrets` SecretAdd[]: Not required on simulation.
    - `user_id` string, uuid
    - `data` string, required
    - `resource_id` string, uuid

## Response `200`

Operation is successful

- object
  - `header` Header, required
    - `id` string, uuid, required
    - `status` 'success' | 'error', required
    - `servertime` integer, required
    - `action` string, uuid, required
    - `message` string, required
    - `url` string, uri, required
    - `code` integer, required
  - `body` ShareUpdateDryRun, required
    - `added` object[], required
      - `User` object
        - `id` string, uuid
    - `removed` object[], required
      - `User` object
        - `id` string, uuid

## Other responses

- `400`: Bad request
- `401`: Authentication required.
- `404`: Not found

## Changes

- **2026-11-06** `8d72215e2274`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/passbolt/apis/passbolt-api/changes/share/simulate/resource/:foreignId.json/post.md)

---

[API](https://skmtc.dev/passbolt/apis/passbolt-api.md) - [All operations](https://skmtc.dev/passbolt/apis/passbolt-api/llms.txt) - [OpenAPI document](https://skmtc.dev/passbolt/apis/passbolt-api/revisions/8d72215e2274?raw)