How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Passbolt Shares API

Share resources and folders to users with an exhaustive permission system.

Passbolt Shares API is one of 27 APIs that Passbolt publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shares. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 5.0.0.

Requests are made against a single base URL, https://passbolt.local.

3 operations 3 paths 13 schemas 1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
5.0.0
Base URL
https://passbolt.local
Authentication
HTTP Bearer, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Passbolt Shares API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerHttpAuthentication). An API key is passed in the cookie as passbolt_session (gpgCookieAuthentication).

  • bearerHttpAuthentication — Bearer token using a JWT
  • gpgCookieAuthentication — Session-based authentication. Note that a CSRF token needs to be provided through a header named X-CSRF-Token.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Shares 3

Share resources and folders to users with an exhaustive permission system.

PUT
/share/{foreignModel}/{foreignId}.json
Share a resource or folder.
updateShare 2 params body → 200400401404
GET
/share/search-aros.json
Get AROs for sharing.
indexShareAros 4 params → 200400401404
POST
/share/simulate/{foreignModel}/{foreignId}.json
Simulate sharing a resource or folder.
updateShareDryRun 2 params body → 200400401404

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are userIndexAndView (15 properties), gpgkey (12 properties), groupIndexAndView (10 properties), header (7 properties). Each schema is shown below with its type and property counts.

groupsUsersIndexAndView
object
6 properties 5 required
shareUpdateError
object
1 property
shareUpdate
object
2 properties
permissionUpdate
object
6 properties
userIndexAndView
object
15 properties 8 required
groupIndexAndView
object
10 properties 7 required
shareUpdateDryRun
object
2 properties 2 required
secretAdd
object
3 properties 1 required
shareAros
gpgkey
object
12 properties 13 required
permissionLevel
integer
1 - Read 7 - Update 15 - Owner
role
object
5 properties 5 required
header
object
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

passbolt-shares-api-openapi.yml Raw ↑

Other APIs Passbolt publishes across the network.

Passbolt Authentication (GPGAuth) API
Passbolt Authentication (JWT) API
Passbolt Avatars API
Passbolt Comments API
Passbolt Directory Sync API
Passbolt Favorites API
Passbolt Folders API
Passbolt GPG keys API
Passbolt Groups API
Passbolt Healthcheck API
Passbolt Metadata keys API
Passbolt Metadata private keys API
Where this information came from

This is an independent, third-party profile of Passbolt Shares API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.