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

Ideas Portal Users / Create

  • Article
  • 3 minutes to read

Operation Information

Creates an Idea Portal User in Aha!.

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

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 oAuth 2.0 in the Type pick list;
  • Give the oAuth 2.0 KeySafe key a Title (this is the name / identifier for the oAuth 2.0 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
Client Id string Application Client Id
Client Secret string Application Client Secret
oAuth Scope string Application oAuth Scope
Authorize URL string Application Authorize URL
Access URL string Application Access UR
Response Type string Application Response Type
Additional Params string Application Additional Params
Additional Access Token Params string Application Additional Access Token Request Params
Grant Type string Application Grant Type
Refresh URL string Application Refresh URL
Refresh Grant Type string Application Refresh Grant Type
Refresh Body string Application Refresh Body
Revoke URL string Token Revoke URL
Token string Authentication Token
Refresh Token string Refresh Token
API Endpoint string Optional API Endpoint

Tip

In order to integrate with Aha!, you will first need to register Hornbill as an authorized application within your Aha! instance.

To do this, visit the Personal Settings page in your Aha! account, then click on the Developer option on the left-hand menu, and then click the OAuth Applications tab. Once the tab had loaded, click the Register OAuth Application button.

This will present you with a form containing 2 inputs:

  • In the first input, give the registered application a name. i.e. Hornbill
  • In the second input, enter the following: https://admin.hornbill.com/oauthcallback.php
  • Click the Create button
  • Once the application has been registered, Aha! will provide you with the information you need to populate the above fields.

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

Input Parameters

Display Name ID Type Description Required Supported Values
Idea Portal ID portal_id string Numeric ID of the Idea Portal Yes None provided
Email address of the portal user. The email address does not need to be of a user of Aha! email string Email Yes None provided
First Name first_name string First name of the portal user No None provided
Last Name last_name string Last name of the portal user No None provided
Permission permission boolean Whether the portal user is an employee/partner No None provided
Enabled enabled boolean Whether the portal user is active No None provided
Maximum Endorsement Override max_endorsement_override number The vote allocation for this specific user No None provided

Output Parameters

Display Name ID Type Description
Status status string Return Status (ok/fail)
Error error string Any returned errors
ID id string Portal User ID
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document