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

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}

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 information about a User from Google Workspace.

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 Google Workspace.

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 Google Workspace in the Type pick list;
  • Give the Google Workspace KeySafe key a Title (this is the name / identifier for the Google Workspace account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Click the Create Key button to create your new key;
  • Once the Key is created, you will need to connect to the target service, and your account, in order to authorize the connector app access to the listed operations. Click the Connect button and you will be redirected to the service provider in a popup window;
  • Log in to your account, and then you will be prompted to review the options you are authorizing the Hornbill connector to be allowed to perform using the chosen account;
  • Accept the review and you will be returned to your KeySafe key.

Tip

If you have revoked your Google KeySafe Token with the Revoke Access button, before you can reconnect Hornbill to your Google account you will need to log in to your Google account and remove Hornbill from the list of third-party apps with account access.

If this is not performed prior to reconnecting your account, then Hornbill will only be able to access the account for up to 1 hour before the access token is expired.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just hit the Revoke button in the relevant KeySafe key(s).

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Google Workspace account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
User Key userKey string Identifies the user in the API request. The value can be the user’s primary email address, alias email address, or unique user ID. Yes None provided

Output Parameters

Display Name ID Type Description
Success success boolean Operation Success
Error error string Any error returned from Google
Kind kind string Kind
Id id string Id
Etag etag string Etag
Primary Email primaryEmail string Primary Email
Given Name givenName string Given Name
Family Name familyName string Family Name
Full Name fullName string Full Name
Is Admin isAdmin boolean Is Admin
Is Delegated Admin isDelegatedAdmin boolean Is Delegated Admin
Last Login Time lastLoginTime string Last Login Time
Creation Time creationTime string Creation Time
Agreed To Terms agreedToTerms boolean Agreed To Terms
Suspended suspended boolean Suspended
Archived archived boolean Archived
Change Password At Next Login changePasswordAtNextLogin boolean Change Password At Next Login
IP Whitelisted ipWhitelisted boolean IP Whitelisted
Phone Number phoneWork string Work Phone Number
Language Code languageCode string The preferred language code of the user
Org Unit Path orgUnitPath string Org Unit Path
Is Mailbox Setup isMailboxSetup boolean Is Mailbox Setup
Is Enrolled In2 Sv isEnrolledIn2Sv boolean Is Enrolled In2 Sv
Is Enforced In2 Sv isEnforcedIn2Sv boolean Is Enforced In2 Sv
Include In Global Address List includeInGlobalAddressList boolean Include In Global Address List
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document