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

Users / Get User

  • Article
  • 2 minutes to read

Operation Information

Retrieves details about a user from Workspace One UEM.

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 VMware Workspace One UEM.

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 VMware Workspace One UEM in the Type pick list;
  • Give the VMware Workspace One UEM KeySafe key a Title (this is the name / identifier for the VMware Workspace One UEM 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
Domain string Your Workspace One UEM domain, for example: https://cn1498.awmdm.com
Region string The region where your Workspace One UEM service is located
Client ID string The Client ID for your Workspace One UEM oAuth Client
Client Secret string The Client Secret for your Workspace One UEM oAuth Client
Access Token string Generated by the integration, please leave this field empty

Tip

VMware Workspace One UEM requires an OAuth Client to be created, that can then be used by these Hornbill integration operations. See the Client creation documentation for more information on creating these.

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 VMware Workspace One UEM account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
User ID id integer The ID of the User you would like to retrieve Yes None provided

Output Parameters

Display Name ID Type Description
Error Message error string Any error message returned by Workspace One UEM
Status Code status string The status of the operation, ok/failed
User UuId uuId string The unique identifier of your User
User Name userName string The registered user name of the device
First Name firstName string The first name of the user
Last Name lastName string The last name of the User
Email email string The email address linked to the user
Display Name displayName string The name that is visible on the user
Mobile Number mobileNumber string The mobile number linked to the user
Group group string The group code the user is under
Role role string The level of access the user has
Number of Enrolled Devices enrolledDevices string The number of devices this user has enrolled
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document