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
  • 3 minutes to read

Operation Information

Retrieves details of an Active Directory user object via Adaxes.

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 HTTP Basic Authentication (Username + Password).

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

Tip

The API Endpoint field should be populated with the Adaxes server address & endpoint, in the format: https://adaxes.externally.facing.address/AdaxesSpmlWS/SpmlProvider.ashx.

As Adaxes is an on-premise tool, and not in the cloud, the following rules should be adhered to:

  • The Adaxes SPML endpoint will need configuring in IIS to support Basic Authentication;
  • Traffic to/from the Adaxes SPML endpoint will need to be over SSL - so as to not send Basic auth details without encryption;
  • You will need to configure your firewall to allow traffic over port 443 from the iBridge IP address (87.117.243.10) to the externally-facing IP address of your Adaxes web server.

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 HTTP Basic Authentication (Username + Password) account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Distinguished Name distinguishedName string The distinguished name of the User object you wish to return. Yes None provided

Output Parameters

Display Name ID Type Description
Status status string Return Status
Cn cn string Cn
S AMAccount Name sAMAccountName string S AMAccount Name
Object Category objectCategory string Object Category
Object GUID objectGUID string Object GUID
Description description string Description
Given Name givenName string Given Name
Sn sn string Sn
Initials initials string Initials
Display Name displayName string Display Name
Mail mail string Mail
Mail Nickname mailNickname string Mail Nickname
Telephone Number telephoneNumber string Telephone Number
Mobile mobile string Mobile
Home Phone homePhone string Home Phone
Department department string Department
Title title string Title
Manager manager string Manager
Company company string Company
Physical Delivery Office Name physicalDeliveryOfficeName string Physical Delivery Office Name
W WWHome Page wWWHomePage string W WWHome Page
U SNChanged uSNChanged string U SNChanged
User Principal Name userPrincipalName string User Principal Name
Pwd Last Set pwdLastSet string Pwd Last Set
Account Expires accountExpires string Account Expires
User Account Control userAccountControl string User Account Control
Distinguished Name distinguishedName string Distinguished Name
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document