Skip to main content
Main navigation
Close navigation
Main
RICOH CloudStream API documentation
Trusted device registration
OAuth error codes
Obtain device token
Refresh device or user token
Register device
Request example
User and device tokens
Authorization code flow
API Functions
Data structures
Version History
RICOH CloudStream documentation
Release notes
2025
2024
2023
2022
2021
2020
2019
2018
About CloudStream
Requirements
Security and privacy
Compatible Card Readers
Supported languages
Ricoh hosted cloud addresses
Trademarks
Known issues and limitations
Architecture and solution design
Licensing
Quick start for vendors
Quick start for admins
Setting up Ricoh CloudStream service integration
Admin guide
CloudStream Web UI
Overview
Users menu
Access Control
Authentication providers
Client authentication
Add a custom app in Microsoft Entra ID
Add a custom app in the Auth0 identity platform
Add group synchronization app in the Auth0 identity management
Add a custom app in the Ping identity platform
Edit a custom app in Microsoft Entra ID
Google Workspace service account
External authentication
External Card Repository
LDAP authentication
Microsoft Entra authentication
Synchronizing user card, PIN or department from Microsoft Entra ID
OKTA Authentication
OKTA authentication via LDAP
Google authentication
Enabling user self-registration
Guest users / guest printing
Local groups
Roles
Permissions
Single Sign-On
Microsoft Entra Single Sign-On
Okta Single Sign-On / Logout
PingID Single Sign-On
Users
Printers menu
Embedded Terminals
Secondary Gateway mapping
Embedded Terminals' configuration
Using Card Number Conversion
Terminal Deployment Tool
Brother Terminal
HP Terminals
HP Workpath Gen 2 Cloud Terminal
HP Workpath Gen 1 Embedded Terminal
HP OXPd embedded
Konica Minolta Terminals
Konica Minolta IWS Gen 2 Cloud Terminal
Konica Minolta IWS Cloud Terminal
IWS Cloud Terminal Configuration
Installation from the Marketplace
Installation using the IWS Install Tool
IWS Cloud Terminal usage
Konica Minolta OpenAPI Terminal
Konica Minolta IWS Gen 2 Cloud Terminal with device locking (IWS Service Platform integration)
Application configuration copy through Marketplace
Kyocera Terminal
Lexmark Terminal
Ricoh Terminals
Ricoh Standard Gen 2 Cloud Terminal
Requirements and limitations
Adding Embedded configuration and Ricoh MFD in CloudStream Web UI
Cloud Terminal installation
Registering the Cloud Terminal in the CloudStream Web UI
Post-installation device setup
Setting up Custom-privileges Administrator role
Initial device setup
Ricoh Standard Embedded Terminal
Ricoh PMC Embedded Terminal
Ricoh PMC Applications
Ricoh PMC MS365 Application Registration
Sharp Terminals
Sharp Gen 1 Terminal
Sharp Gen 2 Cloud Terminal
Manual installation
Xerox Terminals
Xerox Gen 2 Cloud Terminal
Xerox Gen 1 Terminal
Xerox WorkCentre 71xx
Xerox WorkCentre 52xx, 72xx, 73xx and 74xx
Xerox WorkCentre 75xx
Xerox WorkCentre 78xx
Xerox WorkCentre 79xx
Xerox Versalink
Using Xerox Remote Logger tool
FUJIFILM BI Terminal
Printers
Print queues
Scan workflows
Connectors
Email (SMTP) connector
Microsoft OneDrive for Business connector
Microsoft SharePoint Online connector
Generic HTTPS connector
Google Drive connector
Scan to download (My documents) connector
Workflows
Workflow variables
Workflow error codes
Workflow processing steps
Access rules
Reports
Enhanced reports
Scheduled reports
Legacy reports
Security section
API access keys
Endpoints menu
Endpoints
Servers
Audit log
Offline Server Cache
Server list
Remote Update of Secondary Gateways
Rate limiting
Thread Pool settings
JVM heap memory configuration
Security options
Password policy
PIN policy
PKI and encryption
Certificates
Privacy
Forgotten password
Settings section
General settings
Messaging
Mobile print
Configure Mobile Print
Creating QR-codes
Mobile apps: configure DNS-SD for _discovermobile
Configure the Mobile Apps with the Mobile Device Management
Web upload
Wide area mobile print
Configure DNS server
Configure Windows DNS
Configure BIND
Verifying DNS configuration
Create Wide area mobile print subdomains
Set search domains on mobile devices
Multiple Wide area mobile print subdomains
One Wide Area Mobile Print sub domain
Email to print
Internal copy with Scan to download trigger: Rules - triggers and automation v1
Locations
Rules - triggers and automation
Trigger examples
Vendor/Customer account
Services
Enable Cloud terminal integration
Search functionality
Notifications
Creating a cloud status widget
Installation files
RICOH CloudStream Client
RICOH CloudStream Client overview
System requirements
Installing RICOH CloudStream Client on Windows
Installing RICOH CloudStream Client on macOS
Installing RICOH CloudStream Client in offline mode
RICOH CloudStream Client configuration
RICOH CloudStream Client authorization
RICOH CloudStream Client log download
RICOH CloudStream Client Auto-update
RICOH CloudStream Client Upgrade
RICOH CloudStream Client troubleshooting
Universal driver settings
RICOH CloudStream Client proxy support
RICOH CloudStream Client Configuration profiles
Windows Protected Print mode
Gateway Guide
YSoft OMNI Bridge
Setting up OMNI Bridge
OMNI Bridge gateway installation and troubleshooting
OMNI Bridge operation manual
Add a secondary gateway server
Gateway on Hardware Appliance
Gateway on Software Appliance
Rocky Linux 9 Software Appliance
Configuring a pre-configured gateway
SAFEQ Cloud Chrome extension
End user guide
Submitting a print job
Using the RICOH CloudStream Client
Using the mobile app
Using the Android mobile app
Using the iOS mobile app
Using the legacy mobile app
Using the SAFEQ Cloud Chrome Extension
Adding IPP print queue manually in Windows
Adding IPP print queue manually in Mac OS
Printing from SAP
Using an MFD
Card registration at the MFD
Using FUJIFILM BI Cloud Terminal
Using HP Workpath Gen 2 Cloud Terminal
Using Konica Minolta IWS Gen 2 Cloud Terminal
Using Ricoh Standard Gen 2 Cloud Terminal
Using Sharp Gen 2 Cloud Terminal
Using Xerox Gen 2 Cloud Terminal
CloudStream Web UI for end users
Registering as a standard user
Registering as a guest
My profile
My documents
Reseting forgotten password
Reference documents
Install KM Cloud Terminal without MarketPlace
Asian fonts support for direct print
Asian fonts support for MS Office documents converted to PDF
Migration of authentication providers and SSO to port 443
Potential EntraID Authentication issues with the v3.48 (Port 443) introduction
Legacy documentation
Server Installation in custom deployment scenario
Server Requirements
Supported Database Versions
Installing Vendor Primary
Installing Customer Primary
Add extra node to primary server cluster
Installing CloudStream unattended/silently
Update a server
Uninstalling CloudStream
Manual database configuration
Scraping application metrics via the Prometheus standard
Technical Introduction
How to..
Configure a primary server cluster
Integrate Mobile Print for CloudStream
Scan To Mail
HP MFDs
Konica Minolta MFDs
Kyocera MFDs
Lexmark MFDs
Ricoh MFDs
Sharp MFDs
Xerox MFDs
How to check VID and PID on cardreader
Put in VID and PID on HP Embedded
Use Equitrac embedded clients with CloudStream
Containers and access controls
Creating containers
Permissions on Containers – Example 1
Permissions on Containers – Example 2
Connect to Azure SSL enabled Postgresql database
Deploy RICOH CloudStream Client using Microsoft Intune
Configure MDM Airprint integration on Microsoft Intune
Disaster Recovery Procedure For Primary Server
Configure Scan to My Email
Use Network connected card readers
RFIdeas – Ethernet 241 configuration & setup with CloudStream
Security Engineering – Switchbridge configuration & setup with CloudStream
Create Print queues with specific output options
Migrate CloudStream bundled PostgreSQL database to external PostgreSQL database
Card enrollment / self-registration
Use your own domain names for CloudStream hosted accounts
Configure CloudStream environment with trusted certificates
Configure denial of service filtering for web UI
Main
Release notes
2025
2024
2023
2022
2021
2020
2019
2018
About CloudStream
Requirements
Security and privacy
Compatible Card Readers
Supported languages
Ricoh hosted cloud addresses
Trademarks
Known issues and limitations
Architecture and solution design
Licensing
Quick start for vendors
Quick start for admins
Setting up Ricoh CloudStream service integration
Admin guide
CloudStream Web UI
Overview
Users menu
Access Control
Authentication providers
Client authentication
Add a custom app in Microsoft Entra ID
Add a custom app in the Auth0 identity platform
Add group synchronization app in the Auth0 identity management
Add a custom app in the Ping identity platform
Edit a custom app in Microsoft Entra ID
Google Workspace service account
External authentication
External Card Repository
LDAP authentication
Microsoft Entra authentication
Synchronizing user card, PIN or department from Microsoft Entra ID
OKTA Authentication
OKTA authentication via LDAP
Google authentication
Enabling user self-registration
Guest users / guest printing
Local groups
Roles
Permissions
Single Sign-On
Microsoft Entra Single Sign-On
Okta Single Sign-On / Logout
PingID Single Sign-On
Users
Printers menu
Embedded Terminals
Secondary Gateway mapping
Embedded Terminals' configuration
Using Card Number Conversion
Terminal Deployment Tool
Brother Terminal
HP Terminals
HP Workpath Gen 2 Cloud Terminal
HP Workpath Gen 1 Embedded Terminal
HP OXPd embedded
Konica Minolta Terminals
Konica Minolta IWS Gen 2 Cloud Terminal
Konica Minolta IWS Cloud Terminal
IWS Cloud Terminal Configuration
Installation from the Marketplace
Installation using the IWS Install Tool
IWS Cloud Terminal usage
Konica Minolta OpenAPI Terminal
Konica Minolta IWS Gen 2 Cloud Terminal with device locking (IWS Service Platform integration)
Application configuration copy through Marketplace
Kyocera Terminal
Lexmark Terminal
Ricoh Terminals
Ricoh Standard Gen 2 Cloud Terminal
Requirements and limitations
Adding Embedded configuration and Ricoh MFD in CloudStream Web UI
Cloud Terminal installation
Registering the Cloud Terminal in the CloudStream Web UI
Post-installation device setup
Setting up Custom-privileges Administrator role
Initial device setup
Ricoh Standard Embedded Terminal
Ricoh PMC Embedded Terminal
Ricoh PMC Applications
Ricoh PMC MS365 Application Registration
Sharp Terminals
Sharp Gen 1 Terminal
Sharp Gen 2 Cloud Terminal
Manual installation
Xerox Terminals
Xerox Gen 2 Cloud Terminal
Xerox Gen 1 Terminal
Xerox WorkCentre 71xx
Xerox WorkCentre 52xx, 72xx, 73xx and 74xx
Xerox WorkCentre 75xx
Xerox WorkCentre 78xx
Xerox WorkCentre 79xx
Xerox Versalink
Using Xerox Remote Logger tool
FUJIFILM BI Terminal
Printers
Print queues
Scan workflows
Connectors
Email (SMTP) connector
Microsoft OneDrive for Business connector
Microsoft SharePoint Online connector
Generic HTTPS connector
Google Drive connector
Scan to download (My documents) connector
Workflows
Workflow variables
Workflow error codes
Workflow processing steps
Access rules
Reports
Enhanced reports
Scheduled reports
Legacy reports
Security section
API access keys
Endpoints menu
Endpoints
Servers
Audit log
Offline Server Cache
Server list
Remote Update of Secondary Gateways
Rate limiting
Thread Pool settings
JVM heap memory configuration
Security options
Password policy
PIN policy
PKI and encryption
Certificates
Privacy
Forgotten password
Settings section
General settings
Messaging
Mobile print
Configure Mobile Print
Creating QR-codes
Mobile apps: configure DNS-SD for _discovermobile
Configure the Mobile Apps with the Mobile Device Management
Web upload
Wide area mobile print
Configure DNS server
Configure Windows DNS
Configure BIND
Verifying DNS configuration
Create Wide area mobile print subdomains
Set search domains on mobile devices
Multiple Wide area mobile print subdomains
One Wide Area Mobile Print sub domain
Email to print
Internal copy with Scan to download trigger: Rules - triggers and automation v1
Locations
Rules - triggers and automation
Trigger examples
Vendor/Customer account
Services
Enable Cloud terminal integration
Search functionality
Notifications
Creating a cloud status widget
Installation files
RICOH CloudStream Client
RICOH CloudStream Client overview
System requirements
Installing RICOH CloudStream Client on Windows
Installing RICOH CloudStream Client on macOS
Installing RICOH CloudStream Client in offline mode
RICOH CloudStream Client configuration
RICOH CloudStream Client authorization
RICOH CloudStream Client log download
RICOH CloudStream Client Auto-update
RICOH CloudStream Client Upgrade
RICOH CloudStream Client troubleshooting
Universal driver settings
RICOH CloudStream Client proxy support
RICOH CloudStream Client Configuration profiles
Windows Protected Print mode
Gateway Guide
YSoft OMNI Bridge
Setting up OMNI Bridge
OMNI Bridge gateway installation and troubleshooting
OMNI Bridge operation manual
Add a secondary gateway server
Gateway on Hardware Appliance
Gateway on Software Appliance
Rocky Linux 9 Software Appliance
Configuring a pre-configured gateway
SAFEQ Cloud Chrome extension
End user guide
Submitting a print job
Using the RICOH CloudStream Client
Using the mobile app
Using the Android mobile app
Using the iOS mobile app
Using the legacy mobile app
Using the SAFEQ Cloud Chrome Extension
Adding IPP print queue manually in Windows
Adding IPP print queue manually in Mac OS
Printing from SAP
Using an MFD
Card registration at the MFD
Using FUJIFILM BI Cloud Terminal
Using HP Workpath Gen 2 Cloud Terminal
Using Konica Minolta IWS Gen 2 Cloud Terminal
Using Ricoh Standard Gen 2 Cloud Terminal
Using Sharp Gen 2 Cloud Terminal
Using Xerox Gen 2 Cloud Terminal
CloudStream Web UI for end users
Registering as a standard user
Registering as a guest
My profile
My documents
Reseting forgotten password
Reference documents
Install KM Cloud Terminal without MarketPlace
Asian fonts support for direct print
Asian fonts support for MS Office documents converted to PDF
Migration of authentication providers and SSO to port 443
Potential EntraID Authentication issues with the v3.48 (Port 443) introduction
Legacy documentation
Server Installation in custom deployment scenario
Server Requirements
Supported Database Versions
Installing Vendor Primary
Installing Customer Primary
Add extra node to primary server cluster
Installing CloudStream unattended/silently
Update a server
Uninstalling CloudStream
Manual database configuration
Scraping application metrics via the Prometheus standard
Technical Introduction
How to..
Configure a primary server cluster
Integrate Mobile Print for CloudStream
Scan To Mail
HP MFDs
Konica Minolta MFDs
Kyocera MFDs
Lexmark MFDs
Ricoh MFDs
Sharp MFDs
Xerox MFDs
How to check VID and PID on cardreader
Put in VID and PID on HP Embedded
Use Equitrac embedded clients with CloudStream
Containers and access controls
Creating containers
Permissions on Containers – Example 1
Permissions on Containers – Example 2
Connect to Azure SSL enabled Postgresql database
Deploy RICOH CloudStream Client using Microsoft Intune
Configure MDM Airprint integration on Microsoft Intune
Disaster Recovery Procedure For Primary Server
Configure Scan to My Email
Use Network connected card readers
RFIdeas – Ethernet 241 configuration & setup with CloudStream
Security Engineering – Switchbridge configuration & setup with CloudStream
Create Print queues with specific output options
Migrate CloudStream bundled PostgreSQL database to external PostgreSQL database
Card enrollment / self-registration
Use your own domain names for CloudStream hosted accounts
Configure CloudStream environment with trusted certificates
Configure denial of service filtering for web UI
On this Page
Release notes
The following pages contain a list of notable changes in RICOH CloudStream.
