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.
Includes shared Community operations and Enterprise-only endpoints. Optional features such as SCIM also require configuration.
309 operations
| Method | Endpoint | Availability | Transport profile |
|---|---|---|---|
| GET | /info/Get signed server information | CE + EE | No session envelope |
| PUT | /secret/Create secret | CE + EE | Session SecretBox |
| POST | /secret/Update secret | CE + EE | Session SecretBox |
| GET | /secret/{secret_id}/Get secret | CE + EE | Session SecretBox |
| POST | /api-key-access/secret/Get secret using an API key | CE + EE | No session envelope |
| PUT | /api-key-access/secret/Update secret using an API key | CE + EE | No session envelope |
| GET | /scim/2.0/{scim_provider_id}/SchemasList SCIM schemas | Enterprise only | No session envelope |
| POST | /authentication/prelogin/Get login hashing parameters | CE + EE | No session envelope |
| POST | /authentication/login/Sign in | CE + EE | Public-key login exchange |
| POST | /authentication/logout/Sign out | CE + EE | Session SecretBox |
| POST | /authentication/ga-verify/Verify authenticator code | CE + EE | Session SecretBox |
| POST | /authentication/duo-verify/Verify Duo challenge | CE + EE | Session SecretBox |
| POST | /authentication/webauthn-verify/Verify WebAuthn challenge | CE + EE | Session SecretBox |
| PUT | /authentication/webauthn-verify/Start WebAuthn challenge | CE + EE | Session SecretBox |
| POST | /authentication/yubikey-otp-verify/Verify YubiKey OTP challenge | CE + EE | Session SecretBox |
| POST | /authentication/ivalt-verify/Verify iVALT challenge | CE + EE | Session SecretBox |
| POST | /authentication/activate-token/Activate session token | CE + EE | Session SecretBox |
| GET | /authentication/sessions/List active sessions | CE + EE | Session SecretBox |
| POST | /authentication/register/Register account | CE + EE | No session envelope |
| POST | /authentication/unregister/Request account deletion | CE + EE | No session envelope |
| PUT | /authentication/unregister/Confirm account deletion | CE + EE | No session envelope |
| POST | /authentication/verify-email/Verify email address | CE + EE | No session envelope |
| PUT | /user/update/Update account | CE + EE | Session SecretBox |
| PUT | /user/upgrade-hashing/Upgrade account hashing | CE + EE | Session SecretBox |
| DELETE | /user/ga/Delete authenticator | CE + EE | Session SecretBox |
| GET | /user/ga/List authenticators | CE + EE | Session SecretBox |
| POST | /user/ga/Activate authenticator | CE + EE | Session SecretBox |
| PUT | /user/ga/Create authenticator | CE + EE | Session SecretBox |
| DELETE | /user/duo/Delete Duo integration | CE + EE | Session SecretBox |
| GET | /user/duo/List Duo integrations | CE + EE | Session SecretBox |
| POST | /user/duo/Activate Duo integration | CE + EE | Session SecretBox |
| PUT | /user/duo/Create Duo integration | CE + EE | Session SecretBox |
| DELETE | /user/webauthn/Delete WebAuthn credential | CE + EE | Session SecretBox |
| GET | /user/webauthn/List WebAuthn credentials | CE + EE | Session SecretBox |
| POST | /user/webauthn/Activate WebAuthn credential | CE + EE | Session SecretBox |
| PUT | /user/webauthn/Create WebAuthn credential | CE + EE | Session SecretBox |
| DELETE | /user/yubikey-otp/Delete YubiKey | CE + EE | Session SecretBox |
| GET | /user/yubikey-otp/List YubiKeys | CE + EE | Session SecretBox |
| POST | /user/yubikey-otp/Activate YubiKey | CE + EE | Session SecretBox |
| PUT | /user/yubikey-otp/Create YubiKey | CE + EE | Session SecretBox |
| DELETE | /user/ivalt/Delete iVALT integration | CE + EE | Session SecretBox |
| GET | /user/ivalt/List iVALT integrations | CE + EE | Session SecretBox |
| POST | /user/ivalt/Activate iVALT integration | CE + EE | Session SecretBox |
| PUT | /user/ivalt/Create iVALT integration | CE + EE | Session SecretBox |
| POST | /user/search/Search users | CE + EE | Session SecretBox |
| GET | /user/policy/Get effective account policies | CE + EE | Session SecretBox |
| DELETE | /user/delete/Delete account | CE + EE | Session SecretBox |
| POST | /user/security-report/Submit security report | CE + EE | Session SecretBox |
| GET | /user/status/Get account status | CE + EE | Session SecretBox |
| GET | /avatar-image/{user_id}/{avatar_id}/Get avatar image | CE + EE | No session envelope |
| DELETE | /avatar/Delete avatar | CE + EE | Session SecretBox |
| GET | /avatar/List avatars | CE + EE | Session SecretBox |
| POST | /avatar/Upload avatar | CE + EE | Session SecretBox |
| GET | /session-key/Get session key | CE + EE | Session SecretBox |
| POST | /password/Start password recovery | CE + EE | No session envelope |
| PUT | /password/Complete password recovery | CE + EE | No session envelope |
| POST | /recoverycode/Create recovery code | CE + EE | Session SecretBox |
| DELETE | /emergencycode/Delete emergency code | CE + EE | Session SecretBox |
| GET | /emergencycode/List emergency codes | CE + EE | Session SecretBox |
| POST | /emergencycode/Create emergency code | CE + EE | Session SecretBox |
| POST | /emergency-login/Start emergency login | CE + EE | No session envelope |
| PUT | /emergency-login/Complete emergency login | CE + EE | No session envelope |
| POST | /api-key-access/inspect/Inspect API key access | CE + EE | No session envelope |
| GET | /api-key/secret/{api_key_id}/List secrets assigned to an API key | CE + EE | Session SecretBox |
| DELETE | /api-key/secret/Remove secret from an API key | CE + EE | Session SecretBox |
| PUT | /api-key/secret/Add secret to an API key | CE + EE | Session SecretBox |
| POST | /api-key/login/Sign in using an API key | CE + EE | Signed API-key login exchange |
| GET | /api-key/{api_key_id}/Get API key | CE + EE | Session SecretBox |
| DELETE | /api-key/Delete API key | CE + EE | Session SecretBox |
| GET | /api-key/List API keys | CE + EE | Session SecretBox |
| POST | /api-key/Update API key | CE + EE | Session SecretBox |
| PUT | /api-key/Create API key | CE + EE | Session SecretBox |
| POST | /link-share-access/Get link-shared content | CE + EE | No session envelope |
| PUT | /link-share-access/Update link-shared content | CE + EE | No session envelope |
| GET | /link-share/{link_share_id}/Get link share | CE + EE | Session SecretBox |
| DELETE | /link-share/Delete link share | CE + EE | Session SecretBox |
| GET | /link-share/List link shares | CE + EE | Session SecretBox |
| POST | /link-share/Update link share | CE + EE | Session SecretBox |
| PUT | /link-share/Create link share | CE + EE | Session SecretBox |
| DELETE | /datastore/Delete datastore | CE + EE | Session SecretBox |
| GET | /datastore/List datastores | CE + EE | Session SecretBox |
| POST | /datastore/Update datastore | CE + EE | Session SecretBox |
| PUT | /datastore/Create datastore | CE + EE | Session SecretBox |
| GET | /datastore/{datastore_id}/Get datastore | CE + EE | Session SecretBox |
| DELETE | /file/link/Delete file link | CE + EE | Session SecretBox |
| POST | /file/link/Move file link | CE + EE | Session SecretBox |
| DELETE | /file/Delete file | CE + EE | Session SecretBox |
| PUT | /file/Create file | CE + EE | Session SecretBox |
| GET | /file/{file_id}/Start file download | CE + EE | Session SecretBox |
| GET | /shard/List available shards | CE + EE | Session SecretBox |
| POST | /file-repository-right/accept/Accept file-repository invitation | CE + EE | Session SecretBox |
| POST | /file-repository-right/decline/Decline file-repository invitation | CE + EE | Session SecretBox |
| DELETE | /file-repository-right/Delete file repository right | CE + EE | Session SecretBox |
| POST | /file-repository-right/Update file repository right | CE + EE | Session SecretBox |
| PUT | /file-repository-right/Create file repository right | CE + EE | Session SecretBox |
| DELETE | /group-file-repository-right/Delete group file repository right | CE + EE | Session SecretBox |
| POST | /group-file-repository-right/Update group file repository right | CE + EE | Session SecretBox |
| PUT | /group-file-repository-right/Create group file repository right | CE + EE | Session SecretBox |
| PUT | /file-repository/download/Get repository download URL | CE + EE | File-transfer SecretBox |
| PUT | /file-repository/upload/Get repository upload URL | CE + EE | File-transfer SecretBox |
| GET | /file-repository/{file_repository_id}/Get file repository | CE + EE | Session SecretBox |
| DELETE | /file-repository/Delete file repository | CE + EE | Session SecretBox |
| GET | /file-repository/List file repositories | CE + EE | Session SecretBox |
| POST | /file-repository/Update file repository | CE + EE | Session SecretBox |
| PUT | /file-repository/Create file repository | CE + EE | Session SecretBox |
| DELETE | /bulk-secret/link/Delete multiple secret links | CE + EE | Session SecretBox |
| POST | /bulk-secret/link/Move multiple secret links | CE + EE | Session SecretBox |
| DELETE | /secret/link/Delete secret link | CE + EE | Session SecretBox |
| POST | /secret/link/Move secret link | CE + EE | Session SecretBox |
| PUT | /bulk-secret/Create multiple secrets | CE + EE | Session SecretBox |
| POST | /bulk-secret-read/Get multiple secrets | CE + EE | Session SecretBox |
| GET | /secret/history/{secret_id}/List secret history | CE + EE | Session SecretBox |
| GET | /history/{secret_history_id}/Get secret history entry | CE + EE | Session SecretBox |
| GET | /share/rights/{share_id}/Get access rights for a share | CE + EE | Session SecretBox |
| POST | /share/right/accept/Accept share invitation | CE + EE | Session SecretBox |
| POST | /share/right/decline/Decline share invitation | CE + EE | Session SecretBox |
| DELETE | /share/right/Delete share right | CE + EE | Session SecretBox |
| GET | /share/right/List share rights | CE + EE | Session SecretBox |
| POST | /share/right/Update share right | CE + EE | Session SecretBox |
| PUT | /share/right/Create share right | CE + EE | Session SecretBox |
| GET | /share/right/{user_share_right_id}/Get share right | CE + EE | Session SecretBox |
| DELETE | /share/link/Delete share link | CE + EE | Session SecretBox |
| POST | /share/link/Move share link | CE + EE | Session SecretBox |
| PUT | /share/link/Create share link | CE + EE | Session SecretBox |
| GET | /share/List shares | CE + EE | Session SecretBox |
| POST | /share/Create share | CE + EE | Session SecretBox |
| PUT | /share/Update share | CE + EE | Session SecretBox |
| GET | /share/{share_id}/Get share | CE + EE | Session SecretBox |
| DELETE | /group/Delete group | CE + EE | Session SecretBox |
| GET | /group/List groups | CE + EE | Session SecretBox |
| POST | /group/Update group | CE + EE | Session SecretBox |
| PUT | /group/Create group | CE + EE | Session SecretBox |
| GET | /group/rights/List group share rights | CE + EE | Session SecretBox |
| GET | /group/rights/{group_id}/List share rights for a group | CE + EE | Session SecretBox |
| GET | /group/{group_id}/Get group | CE + EE | Session SecretBox |
| POST | /membership/accept/Accept group invitation | CE + EE | Session SecretBox |
| POST | /membership/decline/Decline group invitation | CE + EE | Session SecretBox |
| DELETE | /membership/Delete group membership | CE + EE | Session SecretBox |
| POST | /membership/Update group membership | CE + EE | Session SecretBox |
| PUT | /membership/Create group membership | CE + EE | Session SecretBox |
| GET | /metadata-datastore/{datastore_id}/Get datastore metadata | CE + EE | Session SecretBox |
| GET | /metadata-share/{share_id}/Get share metadata | CE + EE | Session SecretBox |
| POST | /management-command/Run management command | CE + EE | No session envelope |
| POST | /device-code/Create device approval code | CE + EE | No session envelope |
| POST | /device-code/{device_code}/token/Retrieve approved device session | CE + EE | Device-code Box |
| GET | /device-code/{device_code}/claim/Get device approval details | CE + EE | Session SecretBox |
| PUT | /device-code/{device_code}/claim/Approve device code | CE + EE | Session SecretBox |
| GET | /healthcheck/Check server health | CE + EE | No session envelope |
| GET | /admin/authorization/Get administrative access | CE + EE | Session SecretBox |
| GET | /admin/capability/List administrative capabilities | CE + EE | Session SecretBox |
| GET | /admin/identity-provider/tenant/List identity-provider tenants | Enterprise only | Session SecretBox |
| PUT | /admin/identity-provider/group-tenant/Update identity-provider group tenants | Enterprise only | Session SecretBox |
| GET | /admin/tenant/{tenant_id}/Get tenant | CE + EE | Session SecretBox |
| DELETE | /admin/tenant/Delete tenant | CE + EE | Session SecretBox |
| GET | /admin/tenant/List tenants | CE + EE | Session SecretBox |
| POST | /admin/tenant/Create tenant | CE + EE | Session SecretBox |
| PUT | /admin/tenant/Update tenant | CE + EE | Session SecretBox |
| DELETE | /admin/tenant-membership/Remove tenant member | CE + EE | Session SecretBox |
| POST | /admin/tenant-membership/Add tenant member | CE + EE | Session SecretBox |
| GET | /admin/administrative-role/{role_id}/Get role | CE + EE | Session SecretBox |
| DELETE | /admin/administrative-role/Delete role | CE + EE | Session SecretBox |
| GET | /admin/administrative-role/List roles | CE + EE | Session SecretBox |
| POST | /admin/administrative-role/Create role | CE + EE | Session SecretBox |
| PUT | /admin/administrative-role/Update role | CE + EE | Session SecretBox |
| GET | /admin/administrative-role-assignment/{assignment_id}/Get role assignment | CE + EE | Session SecretBox |
| DELETE | /admin/administrative-role-assignment/Delete role assignment | CE + EE | Session SecretBox |
| GET | /admin/administrative-role-assignment/List role assignments | CE + EE | Session SecretBox |
| POST | /admin/administrative-role-assignment/Create role assignment | CE + EE | Session SecretBox |
| PUT | /admin/administrative-role-assignment/Update role assignment | CE + EE | Session SecretBox |
| GET | /admin/info/Get administration dashboard | CE + EE | Session SecretBox |
| GET | /admin/user/{user_id}/Get user | CE + EE | Session SecretBox |
| DELETE | /admin/user/Delete user | CE + EE | Session SecretBox |
| GET | /admin/user/List users | CE + EE | Session SecretBox |
| POST | /admin/user/Create user | CE + EE | Session SecretBox |
| PUT | /admin/user/Update user | CE + EE | Session SecretBox |
| DELETE | /admin/user-share-right/Delete user share right | CE + EE | Session SecretBox |
| PUT | /admin/user-share-right/Update user share right | CE + EE | Session SecretBox |
| DELETE | /admin/yubikey-otp/Delete YubiKey | CE + EE | Session SecretBox |
| DELETE | /admin/webautn/Delete WebAuthn | CE + EE | Session SecretBox |
| DELETE | /admin/google-authenticator/Delete ga | CE + EE | Session SecretBox |
| DELETE | /admin/recovery-code/Delete recovery code | CE + EE | Session SecretBox |
| GET | /admin/recovery-code/List recovery codes | CE + EE | Session SecretBox |
| DELETE | /admin/emergency-code/Delete emergency code | CE + EE | Session SecretBox |
| GET | /admin/emergency-code/List emergency codes | CE + EE | Session SecretBox |
| DELETE | /admin/duo/Delete duo | CE + EE | Session SecretBox |
| DELETE | /admin/ivalt/Delete iVALT | CE + EE | Session SecretBox |
| DELETE | /admin/session/Delete session | CE + EE | Session SecretBox |
| GET | /admin/session/List sessions | CE + EE | Session SecretBox |
| GET | /admin/security-report/{security_report_id}/Get security report | CE + EE | Session SecretBox |
| GET | /admin/security-report/List security reports | CE + EE | Session SecretBox |
| GET | /admin/group/{group_id}/Get group | CE + EE | Session SecretBox |
| DELETE | /admin/group/Delete group | CE + EE | Session SecretBox |
| GET | /admin/group/List groups | CE + EE | Session SecretBox |
| POST | /admin/group/Create group | Enterprise only | Session SecretBox |
| PUT | /admin/group/Update group | CE + EE | Session SecretBox |
| DELETE | /admin/group-share-right/Delete group share right | CE + EE | Session SecretBox |
| POST | /admin/group-share-right/Create group share right | Enterprise only | Session SecretBox |
| PUT | /admin/group-share-right/Update group share right | CE + EE | Session SecretBox |
| DELETE | /admin/link-share/Delete link share | CE + EE | Session SecretBox |
| DELETE | /admin/membership/Delete membership | CE + EE | Session SecretBox |
| GET | /admin/membership/List memberships | CE + EE | Session SecretBox |
| PUT | /admin/membership/Update membership | CE + EE | Session SecretBox |
| GET | /admin/stats/browser/Get browser statistics | CE + EE | Session SecretBox |
| GET | /admin/stats/device/Get device statistics | CE + EE | Session SecretBox |
| GET | /admin/stats/os/Get operating-system statistics | CE + EE | Session SecretBox |
| POST | /admin/fileserver-cluster/configuration/Generate file-server cluster configuration | CE + EE | Session SecretBox |
| GET | /admin/fileserver-cluster/{cluster_id}/Get file-server cluster | CE + EE | Session SecretBox |
| DELETE | /admin/fileserver-cluster/Delete file-server cluster | CE + EE | Session SecretBox |
| GET | /admin/fileserver-cluster/List file-server clusters | CE + EE | Session SecretBox |
| POST | /admin/fileserver-cluster/Create file-server cluster | CE + EE | Session SecretBox |
| PUT | /admin/fileserver-cluster/Update file-server cluster | CE + EE | Session SecretBox |
| GET | /admin/fileserver-shard/{shard_id}/Get file-server shard | CE + EE | Session SecretBox |
| DELETE | /admin/fileserver-shard/Delete file-server shard | CE + EE | Session SecretBox |
| GET | /admin/fileserver-shard/List file-server shards | CE + EE | Session SecretBox |
| POST | /admin/fileserver-shard/Create file-server shard | CE + EE | Session SecretBox |
| PUT | /admin/fileserver-shard/Update file-server shard | CE + EE | Session SecretBox |
| DELETE | /admin/fileserver-cluster-shard-link/Delete fileserver cluster shard link | CE + EE | Session SecretBox |
| POST | /admin/fileserver-cluster-shard-link/Create fileserver cluster shard link | CE + EE | Session SecretBox |
| PUT | /admin/fileserver-cluster-shard-link/Update fileserver cluster shard link | CE + EE | Session SecretBox |
| GET | /admin/fileserver/{fileserver_id}/Get file server | CE + EE | Session SecretBox |
| GET | /admin/fileserver/List file servers | CE + EE | Session SecretBox |
| GET | /admin/stats/two-factor/Get multifactor statistics | CE + EE | Session SecretBox |
| GET | /admin/ldap/user/List LDAP users | Enterprise only | Session SecretBox |
| DELETE | /admin/ldap/group/map/Delete LDAP group mapping | Enterprise only | Session SecretBox |
| POST | /admin/ldap/group/map/Create LDAP group mapping | Enterprise only | Session SecretBox |
| PUT | /admin/ldap/group/map/Update LDAP group mapping | Enterprise only | Session SecretBox |
| DELETE | /admin/ldap/group/Delete LDAP group | Enterprise only | Session SecretBox |
| GET | /admin/ldap/group/List LDAP groups | Enterprise only | Session SecretBox |
| POST | /admin/ldap/group/Sync LDAP groups | Enterprise only | Session SecretBox |
| DELETE | /admin/scim/group/map/Delete SCIM group mapping | Enterprise only | Session SecretBox |
| POST | /admin/scim/group/map/Create SCIM group mapping | Enterprise only | Session SecretBox |
| PUT | /admin/scim/group/map/Update SCIM group mapping | Enterprise only | Session SecretBox |
| DELETE | /admin/scim/group/Delete SCIM group | Enterprise only | Session SecretBox |
| GET | /admin/scim/group/List SCIM groups | Enterprise only | Session SecretBox |
| DELETE | /admin/saml/group/map/Delete SAML group mapping | Enterprise only | Session SecretBox |
| POST | /admin/saml/group/map/Create SAML group mapping | Enterprise only | Session SecretBox |
| PUT | /admin/saml/group/map/Update SAML group mapping | Enterprise only | Session SecretBox |
| DELETE | /admin/saml/group/Delete SAML group | Enterprise only | Session SecretBox |
| GET | /admin/saml/group/List SAML groups | Enterprise only | Session SecretBox |
| POST | /admin/saml/group/Sync SAML groups | Enterprise only | Session SecretBox |
| DELETE | /admin/oidc/group/map/Delete OIDC group mapping | Enterprise only | Session SecretBox |
| POST | /admin/oidc/group/map/Create OIDC group mapping | Enterprise only | Session SecretBox |
| PUT | /admin/oidc/group/map/Update OIDC group mapping | Enterprise only | Session SecretBox |
| DELETE | /admin/oidc/group/Delete OIDC group | Enterprise only | Session SecretBox |
| GET | /admin/oidc/group/List OIDC groups | Enterprise only | Session SecretBox |
| GET | /admin/policy/{policy_id}/Get policy | Enterprise only | Session SecretBox |
| DELETE | /admin/policy/user/map/Delete policy user map | Enterprise only | Session SecretBox |
| POST | /admin/policy/user/map/Create policy user map | Enterprise only | Session SecretBox |
| DELETE | /admin/policy/group/map/Delete policy group map | Enterprise only | Session SecretBox |
| POST | /admin/policy/group/map/Create policy group map | Enterprise only | Session SecretBox |
| DELETE | /admin/policy/Delete policy | Enterprise only | Session SecretBox |
| GET | /admin/policy/List policies | Enterprise only | Session SecretBox |
| POST | /admin/policy/Create policy | Enterprise only | Session SecretBox |
| PUT | /admin/policy/Update policy | Enterprise only | Session SecretBox |
| POST | /admin/user-wipe/Wipe user account | Enterprise only | Session SecretBox |
| GET | /admin/user-password-reset/{user_id}/Get user password-reset material | Enterprise only | Session SecretBox |
| PUT | /admin/user-password-reset/{user_id}/Reset user password | Enterprise only | Session SecretBox |
| POST | /admin/gateway-cluster/configuration/Generate gateway cluster configuration | Enterprise only | Session SecretBox |
| DELETE | /admin/gateway-cluster/user/map/Delete gateway cluster user map | Enterprise only | Session SecretBox |
| POST | /admin/gateway-cluster/user/map/Create gateway cluster user map | Enterprise only | Session SecretBox |
| DELETE | /admin/gateway-cluster/group/map/Delete gateway cluster group map | Enterprise only | Session SecretBox |
| POST | /admin/gateway-cluster/group/map/Create gateway cluster group map | Enterprise only | Session SecretBox |
| GET | /admin/gateway-cluster/{cluster_id}/Get gateway cluster | Enterprise only | Session SecretBox |
| DELETE | /admin/gateway-cluster/Delete gateway cluster | Enterprise only | Session SecretBox |
| GET | /admin/gateway-cluster/List gateway clusters | Enterprise only | Session SecretBox |
| POST | /admin/gateway-cluster/Create gateway cluster | Enterprise only | Session SecretBox |
| PUT | /admin/gateway-cluster/Update gateway cluster | Enterprise only | Session SecretBox |
| GET | /admin/gateway/{gateway_id}/Get gateway | Enterprise only | Session SecretBox |
| GET | /admin/gateway/List gateways | Enterprise only | Session SecretBox |
| PUT | /fileserver/alive/Send file-server heartbeat | CE + EE | File-server SecretBox |
| PUT | /fileserver/upload/authorize/Authorize chunk upload | CE + EE | File-server SecretBox |
| PUT | /fileserver/download/authorize/Authorize chunk download | CE + EE | File-server SecretBox |
| PUT | /fileserver/download/revoke/Revoke chunk download | CE + EE | File-server SecretBox |
| GET | /fileserver/chunks/cleanup/List chunks pending deletion | CE + EE | File-server SecretBox |
| POST | /fileserver/chunks/cleanup/Confirm chunk deletion | CE + EE | File-server SecretBox |
| DELETE | /server-secret/Remove server-held user keys | Enterprise only | Session SecretBox |
| POST | /server-secret/Store server-held user keys | Enterprise only | Session SecretBox |
| POST | /job/staff-missing-group-secret/Provide group keys for staff | Enterprise only | Session SecretBox |
| POST | /job/membership-missing-group-secret/Provide group keys for a membership | Enterprise only | Session SecretBox |
| POST | /job/user-missing-admin-secret/Provide user recovery keys | Enterprise only | Session SecretBox |
| POST | /job/group-missing-admin-secret/Provide group recovery keys | Enterprise only | Session SecretBox |
| GET | /job/List pending key-provisioning jobs | Enterprise only | Session SecretBox |
| POST | /saml/login/Complete SAML login | Enterprise only | Double-boxed SSO login |
| GET | /saml/{saml_provider_id}/metadata/Get SAML service-provider metadata | Enterprise only | No session envelope |
| POST | /saml/{saml_provider_id}/initiate-login/Start SAML login | Enterprise only | No session envelope |
| POST | /saml/{saml_provider_id}/acs/Process SAML assertion | Enterprise only | No session envelope |
| GET | /saml/{saml_provider_id}/sls/Process SAML logout | Enterprise only | No session envelope |
| POST | /oidc/login/Complete OIDC login | Enterprise only | Double-boxed SSO login |
| GET | /oidc/proxy-redirect/{oidc_state_token_id}/Redirect OIDC login | Enterprise only | No session envelope |
| POST | /oidc/{oidc_provider_id}/initiate-login/Start OIDC login | Enterprise only | No session envelope |
| GET | /oidc/{oidc_provider_id}/callback/Process OIDC callback | Enterprise only | No session envelope |
| POST | /oidc/{oidc_provider_id}/backchannel-logout/Process OIDC backchannel logout | Enterprise only | No session envelope |
| GET | /scim/2.0/{scim_provider_id}/UsersList SCIM users | Enterprise only | No session envelope |
| POST | /scim/2.0/{scim_provider_id}/UsersCreate SCIM user | Enterprise only | No session envelope |
| DELETE | /scim/2.0/{scim_provider_id}/Users/{user_id}Delete SCIM user | Enterprise only | No session envelope |
| GET | /scim/2.0/{scim_provider_id}/Users/{user_id}Get SCIM user | Enterprise only | No session envelope |
| PATCH | /scim/2.0/{scim_provider_id}/Users/{user_id}Update SCIM user | Enterprise only | No session envelope |
| PUT | /scim/2.0/{scim_provider_id}/Users/{user_id}Replace SCIM user | Enterprise only | No session envelope |
| GET | /scim/2.0/{scim_provider_id}/GroupsList SCIM groups | Enterprise only | No session envelope |
| POST | /scim/2.0/{scim_provider_id}/GroupsCreate SCIM group | Enterprise only | No session envelope |
| DELETE | /scim/2.0/{scim_provider_id}/Groups/{scim_group_id}Delete SCIM group | Enterprise only | No session envelope |
| GET | /scim/2.0/{scim_provider_id}/Groups/{scim_group_id}Get SCIM group | Enterprise only | No session envelope |
| PATCH | /scim/2.0/{scim_provider_id}/Groups/{scim_group_id}Update SCIM group | Enterprise only | No session envelope |
| PUT | /scim/2.0/{scim_provider_id}/Groups/{scim_group_id}Replace SCIM group | Enterprise only | No session envelope |
| PUT | /gateway/alive/Send gateway heartbeat | Enterprise only | Gateway SecretBox |
| GET | /gateway/clusters/List available gateway clusters | Enterprise only | Session SecretBox |
| POST | /gateway/launch/Create gateway connection | Enterprise only | Session SecretBox |
| PUT | /gateway/launch/trade/Exchange gateway launch code | Enterprise only | Gateway SecretBox |
| POST | /gateway/launch/status/Check gateway connection status | Enterprise only | Gateway SecretBox |
Loading API reference…