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

  • Article
  • 4 minutes to read

Operation Information

Create a User within Unit4.

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 Unit 4.

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 Unit 4 in the Type pick list;
  • Give the Unit 4 KeySafe key a Title (this is the name / identifier for the Unit 4 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 The Unit4 Username you would like to use for this connection
Password string The Password for the User you would like to use for this connection
Server string The Server of your Unit4 instance

Tip

In order to integrate with Unit4, you will need to add your unique Unit4 Username and Password (into the Password field). The Server field is the value shown here - 'https://{{server}}.unit4cloud.com/uk_wxw_prev_web/Default.aspx'. Please only use the value folowing 'https://' and preceeding '.unit4cloud'.

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

Input Parameters

Display Name ID Type Description Required Supported Values
User Name userName string The User Name for the created user Yes None provided
Language Code languageCode string The Language Code for the created user. For example ‘EN’ for English. Yes None provided
Description description string Any additional information about a user. Yes None provided
Default Logon Company defaultLogonCompany string The default logon company No None provided
User ID userId string The unique User ID for the created user No None provided
Phone Numbers phoneNumbers object The Phone Numbers associated with the created User. No None provided
Additional Contact Information additionalContactInfo object Additional Contact Information for a User No None provided
Address Information address object The physical address of the created User. No None provided
Companies and Roles roles array The ID’s and Date-Time fields required to add a list of Roles to a User No None provided
Domain User domainUser string The Domain Name assocaited with the created user. No None provided
Unit4 Id unit4Id string The Unit4 Id associated with the created User No None provided
Disabled Until disabledUntil string The Date-Time that the created user is Disabled Until in the format YYYY-MM-DDTHH:MM:SS.000Z No None provided
Password Expiry Date passwordExpiryDate string The Date-Time that the created users password is valid until in the format YYYY-MM-DDTHH:MM:SS.000Z No None provided
Administrator isAdmin boolean Is the Created User a Admin No None provided
Available In Menu Access availableInMenu boolean Is the created User available in the Menu No None provided
Enabled For Workflow Process enabledForWorkflow boolean Is the Created User permitted to use Workflows No None provided
User Active From dateFrom string The Date-Time that the User was Created on in the format YYYY-MM-DDTHH:MM:SS.000Z No None provided
User Active Until dateTo string The Date-Time that the User can be active until in the format YYYY-MM-DDTHH:MM:SS.000Z No None provided

Output Parameters

Display Name ID Type Description
Error Message error string Any error message returned by jamf
Status Code status string The status of the operation, ok/failed
Computer ID id string The unique identifier number for the created computer
User Name userName string The system name assigned to the created User
Default Log On Company defaultCompany string The Default Log On Company assigned to the created User
Computer ID userStatus string The current Status assigned to the created User
Email Address email string The Email Address of the created user
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document