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

Users / Add To Groups

  • Article
  • 2 minutes to read

Operation Information

Adds a User to one or more User Groups on IBM Blueworks Live.

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 IBM Blueworks Live.

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 IBM Blueworks Live in the Type pick list;
  • Give the IBM Blueworks Live KeySafe key a Title (this is the name / identifier for the IBM Blueworks Live 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
URL string URL for the Blueworks Live instance token generation and API Endpoint
Client ID string Application Client ID
Client Secret string Application Client Secret
Token string Authentication Token

Tip

To generate a Service ID in IBM Blueworks Live:

  • Navigate to Admin then Account Information;
  • Ensure Enable API access via Service IDs is ticked;
  • Click Create New, then enter a Name, Description and choose the User Management category, then click Create;
  • A JSON file will be downloaded by your browser. This JSON file contains the Client ID and Client Secret that you need to store the in relevant fields, above.

Please leave the Token field empty.

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

Input Parameters

Display Name ID Type Description Required Supported Values
Username username string The Username of the User Yes None provided
User Groups usergroups array An array of group names to add user to Yes None provided

Output Parameters

Display Name ID Type Description
Status status string Integration call return status (ok/fail)
Error error string Any errors returned from the integration, should the Status be fail
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document