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

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

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

Authentication

The User Import - Azure utility uses API keys to authenticate all API calls into Hornbill instances. It uses KeySafe to store Microsoft Entra ID credentials securely.

API keys

The User Import - Azure utility requires specific permissions to interact with your Hornbill instance. You must configure your API Key rules to include the following Hornbill Platform APIs. You can also add IP rules to increase security.

Required API key rules

  • activity:profileImageSet
  • admin:keysafeGetKey
  • admin:sysOptionGet
  • admin:userAddGroup
  • admin:userAddRole
  • admin:userCreate
  • admin:userDeleteGroup
  • admin:userProfileSet
  • admin:userSetAccountStatus
  • admin:userUpdate
  • data:entityAddRecord
  • data:entityGetRecord
  • data:entityUpdateRecord
  • data:queryExec
  • session:getSystemLicenseInfo

KeySafe

The import utility requires authentication credentials stored in KeySafe to access Microsoft Entra ID data.

Review the KeySafe documentation before you store credentials.

Register an Entra ID application

Before you create a KeySafe key, you must obtain details from an App Registration in your Microsoft Entra ID tenant. If you do not have administrative access to Azure, contact your Microsoft Entra ID administrator for assistance.

Registration steps

  1. Sign in to the Azure portal.
  2. Go to Microsoft Entra ID.
  3. Select App registrations from the side menu.
  4. Select New Registration.
  5. Enter a name for the application. App Name and Account Type
  6. Select the appropriate account type. We reccomend selecting 'Multiple Entra ID tenants' at this phase.
  7. Select Register.
  8. Select API permissions from the menu to apply the required permissions. Application API Example
  9. Grant the following Application Permissions:
    • Group.Read.All
    • GroupMember.Read.All
    • Team.ReadBasic.All
    • TeamMember.Read.All
    • User.Read.All
  10. Grant the following Delegated Permission:
    • User.Read
  11. Select Grant admin consent to confirm the permission settings.
  12. Go to the Overview section.
  13. Copy the Application (client) ID and the Directory (tenant) ID.
  14. Select Certificates & secrets from the menu.
  15. Select New client secret. App Secret Example
  16. Enter a description, select an expiry date, and select Add.
  17. Copy the Value of the client secret.

Create a KeySafe key

Use the Client ID, Tenant ID, and Client Secret from your Microsoft Entra ID app registration to create the KeySafe key in Hornbill.

KeySafe creation steps

  1. In Hornbill, go to Configuration > Platform Configuration > KeySafe.
  2. Select + Create New Key.
  3. Select Azure Imports as the key type.
  4. Enter a Title for the KeySafe key.
  5. Optional: Enter a Description.
  6. Enter the Tenant ID, Client ID, and Client Secret values you copied from the Azure portal.
  7. Select Create Key.

Expected Result

The key appears in your KeySafe list. You can now restrict access to this key so only the API key created for your service account can use it. For more information, see the KeySafe documentation regarding access control.

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document