How can we help?
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!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Users / Get
- Article
- 3 minutes to read
Operation Information
Retrieves information about a user from VMware Cloud Services.
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 Cloud Services Platform.
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 Cloud Services Platform in the Type pick list;
- Give the VMware Cloud Services Platform KeySafe key a Title (this is the name / identifier for the VMware Cloud Services Platform 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 |
---|---|---|
Organization ID | string |
The full ID of your organization |
Token | string |
The API token for your account |
Tip
VMware CSP requires an API Token to be created, that can then be used by these Hornbill integration operations. See the token generation 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 Cloud Services Platform 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 you wish to return information about | Yes | None provided |
Output Parameters
Display Name | ID | Type | Description |
---|---|---|---|
Status Code | status |
string |
The status of the operation, ok/failed |
Error Message | error |
string |
Any error message returned by Workspace One |
Account Identifier | acct |
string |
The identifier of the user, configured to log in to the Identity provider |
Address | address |
string |
The Users address |
City | city |
string |
The Users city |
Company | company |
string |
The Users company |
Country | country |
string |
The Users Country |
Customer Number | customerNumber |
string |
The Users Customer Number |
Email Address | email |
string |
The Users email address |
Email Verified | emailVerified |
boolean |
Whether or not the user’s email is verified |
EULA Information | eulaInfo |
string |
The EULA Information |
First Name | firstName |
string |
The Users first name |
Last Name | lastName |
string |
The Users surname |
State of User Account | state |
string |
The Users account state |
Terms & Conditions | tnc |
boolean |
Terms and Conditions |
Trade ID | tradeId |
string |
The trade ID |
User ID | userId |
string |
The Users ID |
Alternative Email | alternativeEmail |
string |
Alternative emails available |
Default Organization ID | defaultOrgId |
string |
The default organization ID |
Is Federated | isFederated |
boolean |
Boolean value for whether or not the user is federated |
Language | language |
string |
The Users langage |
Linked User ID Account | linkedUserIdAccount |
string |
The Users linked account |
Locale | locale |
string |
The Users locale |
Username | username |
string |
The Users username |
Website | website |
string |
The Users website |
Work Phone | workPhone |
string |
The Users work phone number |
Zipcode | zipcode |
string |
The Users zipcode |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}