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 Group

  • Article
  • 2 minutes to read

Operation Information

Adds one or more users to an organizational group in VMware Cloud Services.

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 VMware Cloud Services Platform.

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 VMware Cloud Services Platform in the Type pick list;
  • Give the VMware Cloud Services Platform KeySafe key a Title (this is the name / identifier for the VMware Cloud Services Platform 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
Organization ID string The full ID of your organization
Token string The API token for your account

Tip

VMware CSP requires an API Token to be created, that can then be used by these Hornbill integration operations. See the token generation documentation for more information on creating these.

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 VMware Cloud Services Platform account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Group ID groupId string The UUID of the group you wish to add the user(s) to Yes None provided
Users userNames array The usernames of the users you wish to add to the group Yes None provided
Invited By invitedBy string Invited By, specify the actual user who is inviting No None provided
Notify Users notifyUsers boolean Publish email notification to group members No None provided

Output Parameters

Display Name ID Type Description
Status Code status string The status of the operation, ok/failed
Error Message error string Any error message returned by Workspace One
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document