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 / Get

  • Article
  • 2 minutes to read

Operation Information

Hornbill iBridge integration to retrieve the details of a user in Entra ID (previously Azure AD).

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 Entra ID User Management.

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 Entra ID User Management in the Type pick list;
  • Give the Entra ID User Management KeySafe key a Title (this is the name / identifier for the Entra ID User Management account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Click the Create Key button to create your new key;
  • Once the Key is created, you will need to connect to the target service, and your account, in order to authorize the connector app access to the listed operations. Click the Connect button and you will be redirected to the service provider in a popup window;
  • Log in to your account, and then you will be prompted to review the options you are authorizing the Hornbill connector to be allowed to perform using the chosen account;
  • Accept the review and you will be returned to your KeySafe key.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just hit the Revoke button in the relevant KeySafe key(s).

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Entra ID User Management account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
UPN or ID UPN string User Principal Name or ID of the user to return Yes None provided

Output Parameters

Display Name ID Type Description
Status status string Was the API call successful?
Error error string Any returned errors
UPN userPrincipalName string User Principal Name
GUID id string User ID
Office Location officeLocation string Office Location
Display Name displayName string The name to display in the address book for the user
Given Name givenName string The given name (first name) of the user
Job Title jobTitle string The users job title
Mail Alias mail string The mail alias for the user
Mobile Tel mobilePhone string The primary cellular telephone number for the user
SurName surname string The user’s surname (family name or last name)
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document