Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

Enter at least two characters to search
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Keep typing  - a search needs at least two characters

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

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

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Users / Create Users

  • Article
  • 2 minutes to read

Operation Information

Create one or more users. Provide an array of user objects.

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

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

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

Input Parameters

Display Name ID Type Description Required Supported Values
Users users array Array of user objects to create, e.g. [{ “email”: “a@b.com”, “role”: “global:member” }]. Yes None provided

Output Parameters

Display Name ID Type Description
Success success boolean True when the n8n API returned a 2xx status code.
Status Code statusCode integer HTTP status code returned by the n8n API.
Message message string Error message returned when the request was not successful.
Count count integer Number of items returned. May exceed the 5 flattened results below.
User Id 1 userId1 string The user id 1.
User Email 1 userEmail1 string The user email 1.
Invite Url 1 inviteUrl1 string The invite url 1.
Error 1 error1 string The error 1.
User Id 2 userId2 string The user id 2.
User Email 2 userEmail2 string The user email 2.
Invite Url 2 inviteUrl2 string The invite url 2.
Error 2 error2 string The error 2.
User Id 3 userId3 string The user id 3.
User Email 3 userEmail3 string The user email 3.
Invite Url 3 inviteUrl3 string The invite url 3.
Error 3 error3 string The error 3.
User Id 4 userId4 string The user id 4.
User Email 4 userEmail4 string The user email 4.
Invite Url 4 inviteUrl4 string The invite url 4.
Error 4 error4 string The error 4.
User Id 5 userId5 string The user id 5.
User Email 5 userEmail5 string The user email 5.
Invite Url 5 inviteUrl5 string The invite url 5.
Error 5 error5 string The error 5.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document