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...

Admin / Update User Profile

  • Article
  • 2 minutes to read

Operation Information

Hornbill Integration method for updating a Hornbill users profile. The Hornbill account must be authenticated in KeySafe first.

This is a Free Tier Integration.

Authentication

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

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 Hornbill Authentication in the Type pick list;
  • Give the Hornbill Authentication KeySafe key a Title (this is the name / identifier for the Hornbill Authentication 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
Instance ID or URL string Hornbill Instance ID or API Endpoint URL
ApiKey string Authentication Key

Tip

Please read the Hornbill API Keys documentation to learn how to create and manage API Keys on the Hornbill platform.

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 Hornbill Authentication account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
User ID userId string User Id Yes None provided
First Name firstName string First Name No None provided
Middle Name middleName string Middle Name No None provided
Last Name lastName string Last Name No None provided
Handle handle string Handle No None provided
Job Title jobTitle string Job Title No None provided
Job Description jobDescription string Job Description No None provided
Site ID siteId string The site that the user is based at No None provided
Manager ID managerId string The ID of the users manager No None provided
Work Phone Number workPhone string Work Phone Number No None provided
Work Mobile workMobile string Work Mobile Phone Number No None provided
Email Address email string Email Address No None provided
Gender gender string Gender No None provided
Date of Birth dob string ISO datestampt of the users Date of Birth No None provided
Department ID departmentId string Department ID No None provided
Language language string Language No None provided
Time Zone timeZone string Time Zone No None provided
Country country string Country No None provided

Output Parameters

Display Name ID Type Description
Password password string Password
User Id userId string User Id
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document