Documentation

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

Jira Cloud / Get User Account ID

Operation Information

Retrieves the Account ID for a Jira Cloud User.

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 Jira Cloud Authentication.

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 Jira Cloud Authentication in the Type pick list;
  • Give the Jira Cloud Authentication KeySafe key a Title (this is the name / identifier for the Jira Cloud Authentication 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
Endpoint Name string Jira Cloud Endpoint Name
Username string Authentication Username
API Token string Atlassian API Token generated against the above user.

Tip

The Endpoint Name field should be populated with the Jira Cloud Endpoint that you wish to connect to. This can be taken from the Jira Cloud URL, as so: https://[Endpoint Name].atlassian.net.

See the Atlassian website for details on creating API tokens.

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 Jira Cloud Authentication account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Username username string Username of the user you wish to return Yes None provided

Output Parameters

Display Name ID Type Description
Status status string Operation Status - can be ok/fail
Errors errors string Any error(s) returned by the operation
Account ID accountId string None provided
In This Document