Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Operators / Create

  • Article
  • 2 minutes to read

Operation Information

Creates a new Uptrends Operator (User) account.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Username + Password.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose Username + Password in the Type pick list;
  • Give the Username + Password KeySafe key a Title (this is the name / identifier for the Username + Password account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Username string Authentication Username
Password string Authentication Password
API Endpoint string Optional API Endpoint

Tip

The API Endpoint field is not required to be populated for this integration - just Username and Password for an Uptrends account with the operation-relevant rights.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Username + Password account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Password Password string Password Yes None provided
Full Name FullName string Full Name Yes None provided
Email Email string Email Yes None provided
Mobile Phone MobilePhone string Mobile Phone Yes None provided
Outgoing Phone Number Id OutgoingPhoneNumberId number Outgoing Phone Number Id No None provided
Is Account Administrator IsAccountAdministrator boolean Is Account Administrator No None provided
Backup Email BackupEmail string Backup Email No None provided
Is On Duty IsOnDuty boolean Is On Duty No None provided
Culture Name CultureName string Culture Name No None provided
SMS Provider SmsProvider string SMS Provider No None provided
Use Numeric Sender UseNumericSender boolean Use Numeric Sender No None provided
Allow Native Login AllowNativeLogin boolean Allow Native Login No None provided
Allow Single Signon AllowSingleSignon boolean Allow Single Signon No None provided
Default Dashboard DefaultDashboard string Default Dashboard - defaults to UseAccountSpecifiedDashboard if not set Yes None provided
Setup Mode SetupMode string Setup Mode No Manual, Invitation

Output Parameters

Display Name ID Type Description
Status status string API Call Status - ok / failed
Error error string API Call Error from Uptrends
Operator GUID operatorGuid string The operator’s GUID
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document