DEVELOPER REFERENCE OPENAPI 3.1

Your integration.
Every layer explained.

Explore Psono's API with the encrypted wire format and the logical payload side by side. Choose your edition, inspect an operation, and download the contract.

EDITION AVAILABILITY

Community Edition

Import this editionYAML ↓JSON ↓

Community Edition operations are also available in Enterprise. Switch editions to see Enterprise-only endpoints.

223 operations
MethodEndpointAvailabilityTransport profile
GET/info/Get signed server informationCE + EENo session envelope
PUT/secret/Create secretCE + EESession SecretBox
POST/secret/Update secretCE + EESession SecretBox
GET/secret/{secret_id}/Get secretCE + EESession SecretBox
POST/api-key-access/secret/Get secret using an API keyCE + EENo session envelope
PUT/api-key-access/secret/Update secret using an API keyCE + EENo session envelope
POST/authentication/prelogin/Get login hashing parametersCE + EENo session envelope
POST/authentication/login/Sign inCE + EEPublic-key login exchange
POST/authentication/logout/Sign outCE + EESession SecretBox
POST/authentication/ga-verify/Verify authenticator codeCE + EESession SecretBox
POST/authentication/duo-verify/Verify Duo challengeCE + EESession SecretBox
POST/authentication/webauthn-verify/Verify WebAuthn challengeCE + EESession SecretBox
PUT/authentication/webauthn-verify/Start WebAuthn challengeCE + EESession SecretBox
POST/authentication/yubikey-otp-verify/Verify YubiKey OTP challengeCE + EESession SecretBox
POST/authentication/ivalt-verify/Verify iVALT challengeCE + EESession SecretBox
POST/authentication/activate-token/Activate session tokenCE + EESession SecretBox
GET/authentication/sessions/List active sessionsCE + EESession SecretBox
POST/authentication/register/Register accountCE + EENo session envelope
POST/authentication/unregister/Request account deletionCE + EENo session envelope
PUT/authentication/unregister/Confirm account deletionCE + EENo session envelope
POST/authentication/verify-email/Verify email addressCE + EENo session envelope
PUT/user/update/Update accountCE + EESession SecretBox
PUT/user/upgrade-hashing/Upgrade account hashingCE + EESession SecretBox
DELETE/user/ga/Delete authenticatorCE + EESession SecretBox
GET/user/ga/List authenticatorsCE + EESession SecretBox
POST/user/ga/Activate authenticatorCE + EESession SecretBox
PUT/user/ga/Create authenticatorCE + EESession SecretBox
DELETE/user/duo/Delete Duo integrationCE + EESession SecretBox
GET/user/duo/List Duo integrationsCE + EESession SecretBox
POST/user/duo/Activate Duo integrationCE + EESession SecretBox
PUT/user/duo/Create Duo integrationCE + EESession SecretBox
DELETE/user/webauthn/Delete WebAuthn credentialCE + EESession SecretBox
GET/user/webauthn/List WebAuthn credentialsCE + EESession SecretBox
POST/user/webauthn/Activate WebAuthn credentialCE + EESession SecretBox
PUT/user/webauthn/Create WebAuthn credentialCE + EESession SecretBox
DELETE/user/yubikey-otp/Delete YubiKeyCE + EESession SecretBox
GET/user/yubikey-otp/List YubiKeysCE + EESession SecretBox
POST/user/yubikey-otp/Activate YubiKeyCE + EESession SecretBox
PUT/user/yubikey-otp/Create YubiKeyCE + EESession SecretBox
DELETE/user/ivalt/Delete iVALT integrationCE + EESession SecretBox
GET/user/ivalt/List iVALT integrationsCE + EESession SecretBox
POST/user/ivalt/Activate iVALT integrationCE + EESession SecretBox
PUT/user/ivalt/Create iVALT integrationCE + EESession SecretBox
POST/user/search/Search usersCE + EESession SecretBox
GET/user/policy/Get effective account policiesCE + EESession SecretBox
DELETE/user/delete/Delete accountCE + EESession SecretBox
POST/user/security-report/Submit security reportCE + EESession SecretBox
GET/user/status/Get account statusCE + EESession SecretBox
GET/avatar-image/{user_id}/{avatar_id}/Get avatar imageCE + EENo session envelope
DELETE/avatar/Delete avatarCE + EESession SecretBox
GET/avatar/List avatarsCE + EESession SecretBox
POST/avatar/Upload avatarCE + EESession SecretBox
GET/session-key/Get session keyCE + EESession SecretBox
POST/password/Start password recoveryCE + EENo session envelope
PUT/password/Complete password recoveryCE + EENo session envelope
POST/recoverycode/Create recovery codeCE + EESession SecretBox
DELETE/emergencycode/Delete emergency codeCE + EESession SecretBox
GET/emergencycode/List emergency codesCE + EESession SecretBox
POST/emergencycode/Create emergency codeCE + EESession SecretBox
POST/emergency-login/Start emergency loginCE + EENo session envelope
PUT/emergency-login/Complete emergency loginCE + EENo session envelope
POST/api-key-access/inspect/Inspect API key accessCE + EENo session envelope
GET/api-key/secret/{api_key_id}/List secrets assigned to an API keyCE + EESession SecretBox
DELETE/api-key/secret/Remove secret from an API keyCE + EESession SecretBox
PUT/api-key/secret/Add secret to an API keyCE + EESession SecretBox
POST/api-key/login/Sign in using an API keyCE + EESigned API-key login exchange
GET/api-key/{api_key_id}/Get API keyCE + EESession SecretBox
DELETE/api-key/Delete API keyCE + EESession SecretBox
GET/api-key/List API keysCE + EESession SecretBox
POST/api-key/Update API keyCE + EESession SecretBox
PUT/api-key/Create API keyCE + EESession SecretBox
POST/link-share-access/Get link-shared contentCE + EENo session envelope
PUT/link-share-access/Update link-shared contentCE + EENo session envelope
GET/link-share/{link_share_id}/Get link shareCE + EESession SecretBox
DELETE/link-share/Delete link shareCE + EESession SecretBox
GET/link-share/List link sharesCE + EESession SecretBox
POST/link-share/Update link shareCE + EESession SecretBox
PUT/link-share/Create link shareCE + EESession SecretBox
DELETE/datastore/Delete datastoreCE + EESession SecretBox
GET/datastore/List datastoresCE + EESession SecretBox
POST/datastore/Update datastoreCE + EESession SecretBox
PUT/datastore/Create datastoreCE + EESession SecretBox
GET/datastore/{datastore_id}/Get datastoreCE + EESession SecretBox
DELETE/file/link/Delete file linkCE + EESession SecretBox
POST/file/link/Move file linkCE + EESession SecretBox
DELETE/file/Delete fileCE + EESession SecretBox
PUT/file/Create fileCE + EESession SecretBox
GET/file/{file_id}/Start file downloadCE + EESession SecretBox
GET/shard/List available shardsCE + EESession SecretBox
POST/file-repository-right/accept/Accept file-repository invitationCE + EESession SecretBox
POST/file-repository-right/decline/Decline file-repository invitationCE + EESession SecretBox
DELETE/file-repository-right/Delete file repository rightCE + EESession SecretBox
POST/file-repository-right/Update file repository rightCE + EESession SecretBox
PUT/file-repository-right/Create file repository rightCE + EESession SecretBox
DELETE/group-file-repository-right/Delete group file repository rightCE + EESession SecretBox
POST/group-file-repository-right/Update group file repository rightCE + EESession SecretBox
PUT/group-file-repository-right/Create group file repository rightCE + EESession SecretBox
PUT/file-repository/download/Get repository download URLCE + EEFile-transfer SecretBox
PUT/file-repository/upload/Get repository upload URLCE + EEFile-transfer SecretBox
GET/file-repository/{file_repository_id}/Get file repositoryCE + EESession SecretBox
DELETE/file-repository/Delete file repositoryCE + EESession SecretBox
GET/file-repository/List file repositoriesCE + EESession SecretBox
POST/file-repository/Update file repositoryCE + EESession SecretBox
PUT/file-repository/Create file repositoryCE + EESession SecretBox
DELETE/bulk-secret/link/Delete multiple secret linksCE + EESession SecretBox
POST/bulk-secret/link/Move multiple secret linksCE + EESession SecretBox
DELETE/secret/link/Delete secret linkCE + EESession SecretBox
POST/secret/link/Move secret linkCE + EESession SecretBox
PUT/bulk-secret/Create multiple secretsCE + EESession SecretBox
POST/bulk-secret-read/Get multiple secretsCE + EESession SecretBox
GET/secret/history/{secret_id}/List secret historyCE + EESession SecretBox
GET/history/{secret_history_id}/Get secret history entryCE + EESession SecretBox
GET/share/rights/{share_id}/Get access rights for a shareCE + EESession SecretBox
POST/share/right/accept/Accept share invitationCE + EESession SecretBox
POST/share/right/decline/Decline share invitationCE + EESession SecretBox
DELETE/share/right/Delete share rightCE + EESession SecretBox
GET/share/right/List share rightsCE + EESession SecretBox
POST/share/right/Update share rightCE + EESession SecretBox
PUT/share/right/Create share rightCE + EESession SecretBox
GET/share/right/{user_share_right_id}/Get share rightCE + EESession SecretBox
DELETE/share/link/Delete share linkCE + EESession SecretBox
POST/share/link/Move share linkCE + EESession SecretBox
PUT/share/link/Create share linkCE + EESession SecretBox
GET/share/List sharesCE + EESession SecretBox
POST/share/Create shareCE + EESession SecretBox
PUT/share/Update shareCE + EESession SecretBox
GET/share/{share_id}/Get shareCE + EESession SecretBox
DELETE/group/Delete groupCE + EESession SecretBox
GET/group/List groupsCE + EESession SecretBox
POST/group/Update groupCE + EESession SecretBox
PUT/group/Create groupCE + EESession SecretBox
GET/group/rights/List group share rightsCE + EESession SecretBox
GET/group/rights/{group_id}/List share rights for a groupCE + EESession SecretBox
GET/group/{group_id}/Get groupCE + EESession SecretBox
POST/membership/accept/Accept group invitationCE + EESession SecretBox
POST/membership/decline/Decline group invitationCE + EESession SecretBox
DELETE/membership/Delete group membershipCE + EESession SecretBox
POST/membership/Update group membershipCE + EESession SecretBox
PUT/membership/Create group membershipCE + EESession SecretBox
GET/metadata-datastore/{datastore_id}/Get datastore metadataCE + EESession SecretBox
GET/metadata-share/{share_id}/Get share metadataCE + EESession SecretBox
POST/management-command/Run management commandCE + EENo session envelope
POST/device-code/Create device approval codeCE + EENo session envelope
POST/device-code/{device_code}/token/Retrieve approved device sessionCE + EEDevice-code Box
GET/device-code/{device_code}/claim/Get device approval detailsCE + EESession SecretBox
PUT/device-code/{device_code}/claim/Approve device codeCE + EESession SecretBox
GET/healthcheck/Check server healthCE + EENo session envelope
GET/admin/authorization/Get administrative accessCE + EESession SecretBox
GET/admin/capability/List administrative capabilitiesCE + EESession SecretBox
GET/admin/tenant/{tenant_id}/Get tenantCE + EESession SecretBox
DELETE/admin/tenant/Delete tenantCE + EESession SecretBox
GET/admin/tenant/List tenantsCE + EESession SecretBox
POST/admin/tenant/Create tenantCE + EESession SecretBox
PUT/admin/tenant/Update tenantCE + EESession SecretBox
DELETE/admin/tenant-membership/Remove tenant memberCE + EESession SecretBox
POST/admin/tenant-membership/Add tenant memberCE + EESession SecretBox
GET/admin/administrative-role/{role_id}/Get roleCE + EESession SecretBox
DELETE/admin/administrative-role/Delete roleCE + EESession SecretBox
GET/admin/administrative-role/List rolesCE + EESession SecretBox
POST/admin/administrative-role/Create roleCE + EESession SecretBox
PUT/admin/administrative-role/Update roleCE + EESession SecretBox
GET/admin/administrative-role-assignment/{assignment_id}/Get role assignmentCE + EESession SecretBox
DELETE/admin/administrative-role-assignment/Delete role assignmentCE + EESession SecretBox
GET/admin/administrative-role-assignment/List role assignmentsCE + EESession SecretBox
POST/admin/administrative-role-assignment/Create role assignmentCE + EESession SecretBox
PUT/admin/administrative-role-assignment/Update role assignmentCE + EESession SecretBox
GET/admin/info/Get administration dashboardCE + EESession SecretBox
GET/admin/user/{user_id}/Get userCE + EESession SecretBox
DELETE/admin/user/Delete userCE + EESession SecretBox
GET/admin/user/List usersCE + EESession SecretBox
POST/admin/user/Create userCE + EESession SecretBox
PUT/admin/user/Update userCE + EESession SecretBox
DELETE/admin/user-share-right/Delete user share rightCE + EESession SecretBox
PUT/admin/user-share-right/Update user share rightCE + EESession SecretBox
DELETE/admin/yubikey-otp/Delete YubiKeyCE + EESession SecretBox
DELETE/admin/webautn/Delete WebAuthnCE + EESession SecretBox
DELETE/admin/google-authenticator/Delete gaCE + EESession SecretBox
DELETE/admin/recovery-code/Delete recovery codeCE + EESession SecretBox
GET/admin/recovery-code/List recovery codesCE + EESession SecretBox
DELETE/admin/emergency-code/Delete emergency codeCE + EESession SecretBox
GET/admin/emergency-code/List emergency codesCE + EESession SecretBox
DELETE/admin/duo/Delete duoCE + EESession SecretBox
DELETE/admin/ivalt/Delete iVALTCE + EESession SecretBox
DELETE/admin/session/Delete sessionCE + EESession SecretBox
GET/admin/session/List sessionsCE + EESession SecretBox
GET/admin/security-report/{security_report_id}/Get security reportCE + EESession SecretBox
GET/admin/security-report/List security reportsCE + EESession SecretBox
GET/admin/group/{group_id}/Get groupCE + EESession SecretBox
DELETE/admin/group/Delete groupCE + EESession SecretBox
GET/admin/group/List groupsCE + EESession SecretBox
PUT/admin/group/Update groupCE + EESession SecretBox
DELETE/admin/group-share-right/Delete group share rightCE + EESession SecretBox
PUT/admin/group-share-right/Update group share rightCE + EESession SecretBox
DELETE/admin/link-share/Delete link shareCE + EESession SecretBox
DELETE/admin/membership/Delete membershipCE + EESession SecretBox
GET/admin/membership/List membershipsCE + EESession SecretBox
PUT/admin/membership/Update membershipCE + EESession SecretBox
GET/admin/stats/browser/Get browser statisticsCE + EESession SecretBox
GET/admin/stats/device/Get device statisticsCE + EESession SecretBox
GET/admin/stats/os/Get operating-system statisticsCE + EESession SecretBox
POST/admin/fileserver-cluster/configuration/Generate file-server cluster configurationCE + EESession SecretBox
GET/admin/fileserver-cluster/{cluster_id}/Get file-server clusterCE + EESession SecretBox
DELETE/admin/fileserver-cluster/Delete file-server clusterCE + EESession SecretBox
GET/admin/fileserver-cluster/List file-server clustersCE + EESession SecretBox
POST/admin/fileserver-cluster/Create file-server clusterCE + EESession SecretBox
PUT/admin/fileserver-cluster/Update file-server clusterCE + EESession SecretBox
GET/admin/fileserver-shard/{shard_id}/Get file-server shardCE + EESession SecretBox
DELETE/admin/fileserver-shard/Delete file-server shardCE + EESession SecretBox
GET/admin/fileserver-shard/List file-server shardsCE + EESession SecretBox
POST/admin/fileserver-shard/Create file-server shardCE + EESession SecretBox
PUT/admin/fileserver-shard/Update file-server shardCE + EESession SecretBox
DELETE/admin/fileserver-cluster-shard-link/Delete fileserver cluster shard linkCE + EESession SecretBox
POST/admin/fileserver-cluster-shard-link/Create fileserver cluster shard linkCE + EESession SecretBox
PUT/admin/fileserver-cluster-shard-link/Update fileserver cluster shard linkCE + EESession SecretBox
GET/admin/fileserver/{fileserver_id}/Get file serverCE + EESession SecretBox
GET/admin/fileserver/List file serversCE + EESession SecretBox
GET/admin/stats/two-factor/Get multifactor statisticsCE + EESession SecretBox
PUT/fileserver/alive/Send file-server heartbeatCE + EEFile-server SecretBox
PUT/fileserver/upload/authorize/Authorize chunk uploadCE + EEFile-server SecretBox
PUT/fileserver/download/authorize/Authorize chunk downloadCE + EEFile-server SecretBox
PUT/fileserver/download/revoke/Revoke chunk downloadCE + EEFile-server SecretBox
GET/fileserver/chunks/cleanup/List chunks pending deletionCE + EEFile-server SecretBox
POST/fileserver/chunks/cleanup/Confirm chunk deletionCE + EEFile-server SecretBox

Loading API reference…