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 Users API

User are entities with the ability to interact with the application.

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

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

This API exposes 6 operations across 3 paths, and defines 23 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.

6 operations 3 paths 23 schemas 2 DELETE2 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 Users 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 6

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

Users 6

User are entities with the ability to interact with the application.

GET
/users.json
Get multiple users.
indexUsers 11 params → 200400401403
POST
/users.json
Create a user.
addUser body → 200400401
GET
/users/{userId}.json
Get a user.
viewUser 2 params → 200400401403404
PUT
/users/{userId}.json
Update a user.
updateUser 1 param body → 200400401404
DELETE
/users/{userId}.json
Delete a user.
deleteUser 1 param → 200400401404
DELETE
/users/{userId}/dry-run.json
Dry run a user deletion.
dryRunDeleteUser 1 param → 200400401404

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are resourceV4IndexAndView (20 properties), userIndexAndView (15 properties), folderV4IndexAndView (14 properties), gpgkey (12 properties). Each schema is shown below with its type and property counts.

e2eeMetadataBasedId
folderV5IndexAndView
resourceV5IndexAndView
groupsUsersIndexAndView
object
6 properties 5 required
userDelete
object
1 property
userDeleteDryRun
object
1 property
e2eeMetadataBased
object
3 properties 3 required
folderV4IndexAndView
object
14 properties 8 required
secretIndex
object
6 properties 6 required
userIndexAndView
object
15 properties 8 required
userAdd
object
3 properties 2 required
groupIndexAndView
object
10 properties 7 required
e2eeMetadataBasedCommon
userUpdate
object
3 properties
headerWithPagination
object
8 properties 8 required
resourceV4IndexAndView
object
20 properties 13 required
gpgkey
object
12 properties 13 required
permissionIndexAndView
object
10 properties 8 required
permissionLevel
integer
1 - Read 7 - Update 15 - Owner
resourceType
object
8 properties 8 required
role
object
5 properties 5 required
favorite
object
6 properties 6 required
header
object
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

passbolt-users-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 Users 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.