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 / Get User

  • Article
  • 2 minutes to read

Operation Information

Retrieves the details of a User from Octopus Deploy.

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 Octopus Deploy.

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 Octopus Deploy in the Type pick list;
  • Give the Octopus Deploy KeySafe key a Title (this is the name / identifier for the Octopus Deploy 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
Organisation URL string The URL of your Octopus Deploy deployment.
API Key string An Octopus Deploy API Key that has the correct rights to perform integration actions.

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 Octopus Deploy 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 Requested User’s User Name Yes None provided

Output Parameters

Display Name ID Type Description
Error Message error string Any errors returned by the Freshstatus API
Status Code status string The status of the operation: ok / failed
User ID id string The unique ID of the User you searched for
Displayed Name displayName string The Display Name of the User Requested
Is User Active isActive string The status of the User
Is Service User isService string Displays if the User is a service User
Email Address emailAddress string The Email Address of the requested User
Is Password Editable canPasswordBeEdited string Can the requested Users password be Edited
Is Call Requestor isRequestor string Did the User request the call
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document