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 / Add Role

  • Article
  • 2 minutes to read

Operation Information

Add a role to 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 ID userId string The Unique ID of the User Yes None provided
Role ID roleId string The Unique ID of the Role Yes None provided
Company ID companyId string The Unique ID of the Company Yes None provided
Role Connection Valid From validFrom string The Date Time that the connection applied is valid from in the formatt YYYY-MM-DDTHH:MM:SS.000 Yes None provided
Role Connection Valid To validTill string The Date Time that the connection applied is valid until, in the formatt YYYY-MM-DDTHH:MM:SS.000 Yes 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 user name
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document