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

Accounts / Get

  • Article
  • 2 minutes to read

Operation Information

This operation will return the details of the Account searched.

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 oAuth 2.0.

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 oAuth 2.0 in the Type pick list;
  • Give the oAuth 2.0 KeySafe key a Title (this is the name / identifier for the oAuth 2.0 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
Client Id string Application Client Id
Client Secret string Application Client Secret
oAuth Scope string Application oAuth Scope
Authorize URL string Application Authorize URL
Access URL string Application Access UR
Response Type string Application Response Type
Additional Params string Application Additional Params
Additional Access Token Params string Application Additional Access Token Request Params
Grant Type string Application Grant Type
Refresh URL string Application Refresh URL
Refresh Grant Type string Application Refresh Grant Type
Refresh Body string Application Refresh Body
Revoke URL string Token Revoke URL
Token string Authentication Token
Refresh Token string Refresh Token
API Endpoint string Optional API Endpoint

Tip

In order for the Authorization to go through correctly the 'API Endpoint' field must be filled in with the URL from your Dynamics instance for example: 'https://[YOUR ORG NUMBER].crm11.dynamics.com'.

  • The Authorize URL should be set to 'https://login.microsoftonline.com/common/oauth2/v2.0/authorize'.
  • The Access URL and Refresh URL should be set to: 'https://login.microsoftonline.com/common/oauth2/v2.0/token'.
  • Set the scope to 'https://org4f1ec541.crm11.dynamics.com/.default offline_access'.

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

Input Parameters

Display Name ID Type Description Required Supported Values
Account ID accountId string None provided No None provided
Account ID Lookup accountIdLookup string If the ID is not known, this field will present a list of available Accounts. No None provided

Output Parameters

Display Name ID Type Description
Status status string Status of the operation
Error error string Any errors returned by the Dynamics operation
Account ID accountId string ID of the Account
Name name string The Name associated with the Account
Account Email Address email string The Email Address associated with the Account
Account URL url string The URL associated with the Account
Account Description accountDescription string The Description of the Account
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document