Integration APIs

On the Account Settings > Settings screen, you can connect to an API endpoint to help you integrate Secure Print into your print environment.

Available APIs

User Import API - Enables bulk importing of user data, including card registrations, via CSV files. Ideal for onboarding large groups without manual registration.
User Removal API - Allows administrators to delete users and their associated data (e.g., cards, PINs, passcodes) from the system for deprovisioning purposes.
User Registration Removal API- Targets the removal of specific login registrations (PIN, card, mobile) without deleting the entire user record, supporting credential updates or re-registration scenarios.

Note: Access to the data is secure and requires authentication per request made.

To use the APIs:

Turn on Enable Integration APIs to connect to the API endpoint. This creates an Authorization Key, which will give you access to the API.
Select an API to open the dialog box that shows the information on how to use the selected API. Refer to the examples below.

Note: The following examples use the curl utility command line. Use single quotes for Mac or Linux, and double quotes for Windows for your curl commands.

Note: Enter the file path of your CSV file. Take note of the required fields.

Note: When working with PowerShell for HTTP requests , use PowerShell 7 or later.

Secure Print User Import API

The User Import API enables bulk importing of user data including card registrations via CSV files. This API is ideal for onboarding large groups of users without requiring manual registration.

For sites with Active Directory Authentication Provider

Note: Each line in the CSV file includes the following comma-separated fields: Username, Domain, CardID, LastName, and FirstName. The required fields are Username, Domain, and CardID.

HP US

curl -X POST 'https://api.insights.hpondemand.com/ext-import-api/active-directory-users/import' -H 'Authorization: bearer <Authorization Key>' -H 'Content-Type: multipart/form-data' -F 'UsernameColumnName=Username' -F 'DomainColumnName=Domain' -F 'CardColumnName=Card' -F 'FirstNameColumnName=FirstName' -F 'LastNameColumnName=LastName' -F 'DataPrivacyRegionColumnName=DataPrivacyRegion' -F 'File=@<CSV File Path>;type=application/vnd.ms-excel'

Example

curl -X POST 'https://api.insights.hpondemand.com/ext-import-api/active-directory-users/import' -H "Authorization: bearer ee8a77fa8007d9a66ed457dd68802054f965c7198e1458787ddbde1eb6a01fc4" -H "Content-Type: multipart/form-data" -F "UsernameColumnName=Username" -F "DomainColumnName=Domain" -F "CardColumnName=Card" -F "FirstNameColumnName=FirstName" -F "LastNameColumnName=LastName" -F "DataPrivacyRegionColumnName=US-W-2" -F 'File=@D:\email.csv;type=application/vnd.ms-excel'

HP EU

curl -X POST 'https://api-eu.insights.hpondemand.com/ext-import-api/active-directory-users/import' -H 'Authorization: bearer <Authorization Key>' -H 'Content-Type: multipart/form-data' -F 'UsernameColumnName=Username' -F 'DomainColumnName=Domain' -F 'CardColumnName=Card' -F 'FirstNameColumnName=FirstName' -F 'LastNameColumnName=LastName' -F 'DataPrivacyRegionColumnName=DataPrivacyRegion' -F 'File=@<CSV File Path>;type=application/vnd.ms-excel'

Example

curl -X POST 'https://api-eu.insights.hpondemand.com/ext-import-api/active-directory-users/import' -H "Authorization: bearer ee8a77fa8007d9a66ed457dd68802054f965c7198e1458787ddbde1eb6a01fc4" -H "Content-Type: multipart/form-data" -F "UsernameColumnName=Username" -F "DomainColumnName=Domain" -F "CardColumnName=Card" -F "FirstNameColumnName=FirstName" -F "LastNameColumnName=LastName" -F "DataPrivacyRegionColumnName=EU-C-1" -F 'File=@D:\email.csv;type=application/vnd.ms-excel'

For sites with OpenID or Internal Authentication

Note: For card Each line in the CSV file includes the following comma-separated fields: EmailAddress, CardID, FirstName, and LastName . EmailAddress and CardID are required fields. Firstname and Lastname are optional fields.

HP US

curl -X POST 'https://api.insights.hpondemand.com/ext-import-api/users/import' -H 'Authorization: bearer <Authorization Key>' -H 'Content-Type: multipart/form-data' -F 'EmailColumnName=Email' -F 'CardColumnName=Card' -F 'FirstNameColumnName=FirstName' -F 'LastNameColumnName=LastName' -F 'UserGroupsColumnName=UserGroups' -F 'DataPrivacyRegionColumnName=DataPrivacyRegion' -F 'File=@<CSV File Path>;type=application/vnd.ms-excel'

HP EU

curl -X POST 'https://api-eu.insights.hpondemand.com/ext-import-api/users/import' -H 'Authorization: bearer <Authorization Key>' -H 'Content-Type: multipart/form-data' -F 'EmailColumnName=Email' -F 'CardColumnName=Card' -F 'FirstNameColumnName=FirstName' -F 'LastNameColumnName=LastName' -F 'UserGroupsColumnName=UserGroups' -F 'DataPrivacyRegionColumnName=DataPrivacyRegion' -F 'File=@<CSV File Path>;type=application/vnd.ms-excel'

Secure Print User Removal API

The User Removal API allows administrators to delete users and their associated data (e.g., Card Readers, PINs, passcodes) from the system. This is useful for deprovisioning users who no longer require access.

For sites with Active Directory Authentication Provider

Note: Your CSV file must include Username and Domain fields.

HP US

curl -X POST 'https://api.insights.hpondemand.com/ext-import-api/active-directory-users/remove' -H 'Authorization: bearer <Authorization Key>' -H 'Content-Type: multipart/form-data' -F 'UsernameColumnName=Username' -F 'DomainColumnName=Domain' -F 'File=@<CSV File Path>;type=application/vnd.ms-excel'

HP EU

curl -X POST 'https://api-eu.insights.hpondemand.com/ext-import-api/active-directory-users/remove' -H 'Authorization: bearer <Authorization Key>' -H 'Content-Type: multipart/form-data' -F 'UsernameColumnName=Username' -F 'DomainColumnName=Domain' -F 'File=@<CSV File Path>;type=application/vnd.ms-excel'

For sites with OpenID or Internal Authentication

Note: Your CSV file must include the EmailAddress field.

HP US

curl -X POST 'https://api.insights.hpondemand.com/ext-import-api/users/remove' -H 'Authorization: bearer <Authorization Key>' -H 'Content-Type: multipart/form-data' -F 'EmailColumnName=Email' -F 'File=@<CSV File Path>;type=application/vnd.ms-excel'

HP EU

curl -X POST 'https://api-eu.insights.hpondemand.com/ext-import-api/users/remove' -H 'Authorization: bearer <Authorization Key>' -H 'Content-Type: multipart/form-data' -F 'EmailColumnName=Email' -F 'File=@<CSV File Path>;type=application/vnd.ms-excel'

Secure Print User Registration Removal

The User Registration Removal API allows IT administrators to programmatically remove a batch of print users' login registrations (PIN, Card Reader or Mobile Registration) via a CSV file. This targets the removal of specific registration elements such as Card Readers and PINs, without deleting the full user record. This supports scenarios where users need to re-register or update credential

For sites with Active Directory Authentication Provider

Note: The CSV file requires Username, Domain, and Logins fields as shown in the example below. Logins values are as follows 1=PIN, 2= Proximity Badge, 3= PIN and Proximity Badge, 4=Mobile, 5= Mobile and PIN, 6=Mobile and Card, and 7=Mobile, Card, and PIN.

HP US

curl -X POST 'https://api.insights.hpondemand.com/ext-import-api/active-directory-users/remove-logins' -H 'Authorization: bearer <Authorization Key>' -H 'Content-Type: multipart/form-data' -F 'UsernameColumnName=Username' -F 'DomainColumnName=Domain' -F 'LoginsColumnName=Logins' -F 'File=@<CSV File Path>;type=application/vnd.ms-excel'

HP EU

curl -X POST 'https://api-eu.insights.hpondemand.com/ext-import-api/active-directory-users/remove-logins' -H 'Authorization: bearer <Authorization Key>' -H 'Content-Type: multipart/form-data' -F 'UsernameColumnName=Username' -F 'DomainColumnName=Domain' -F 'LoginsColumnName=Logins' -F 'File=@<CSV File Path>;type=application/vnd.ms-excel'

For sites with OpenID or Internal Authentication

Note: The CSV file requires Logins and Email fields. Logins values are as follows 1=PIN, 2= Proximity Badge, 3= PIN and Proximity Badge, 4=Mobile, 5= Mobile and PIN, 6=Mobile and Card, and 7=Mobile, Card, and PIN.

HP US

curl -X POST 'https://api.insights.hpondemand.com/ext-import-api/users/remove-logins' -H 'Authorization: bearer <Authorization Key>' -H 'Content-Type: multipart/form-data' -F 'EmailColumnName=Email' -F 'LoginsColumnName=Logins' -F 'File=@<CSV File Path>;type=application/vnd.ms-excel'

HP EU

curl -X POST 'https://api-eu.insights.hpondemand.com/ext-import-api/users/remove-logins' -H 'Authorization: bearer <Authorization Key>' -H 'Content-Type: multipart/form-data' -F 'EmailColumnName=Email' -F 'LoginsColumnName=Logins' -F 'File=@<CSV File Path>;type=application/vnd.ms-excel'

Checking the status of the import

The time it takes to complete an import using an API varies, depending on how busy the import service is. After an import, you will see a message similar to the following image. It shows that the import file was submitted, it provides the job GUID, and shows that the job is in a pending state.

You can check the status of an import by copying the importGuid and then running this curl command:

HP US

curl -H 'Authorization: bearer <Authorization Key>' https://api.insights.hpondemand.com/ext-import-api/imports/<ImportGuid>/information

HP EU

curl -H 'Authorization: bearer <Authorization Key>' https://api-eu.insights.hpondemand.com/ext-import-api/imports/<ImportGuid>/information