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

Consumers / Create

  • Article
  • 3 minutes to read

Operation Information

Hornbill Integration Bridge method for creating a Consumer in the ServiceNow CSM Plugin. See the Now documentation for more information: https://developer.servicenow.com/dev.do#!/reference/api/washingtondc/rest/consumer-api#consumer-POST.

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 ServiceNow 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 ServiceNow Authentication in the Type pick list;
  • Give the ServiceNow Authentication KeySafe key a Title (this is the name / identifier for the ServiceNow 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
Instance Name string ServiceNow Instance Name
Username string Authentication Username
Password string Authentication Password

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

Input Parameters

Display Name ID Type Description Required Supported Values
Active active boolean True / false is the user active No None provided
Business Phone business_phone string The business phone number of the Consumer No None provided
City city string The city of the Consumer No None provided
Country country string The country of the Consumer No None provided
Email email string The email of the Consumer No None provided
First Name first_name string The first name of the Consumer No None provided
Gender gender string The gender of the Consumer No None provided
Home Phone home_phone string The home phone number of the Consumer No None provided
Last Name last_name string The last name of the Consumer No None provided
Middle Name middle_name string The middle name of the Consumer No None provided
Mobile Phone mobile_phone string The mobile phone numbr of the Consumer No None provided
Full Name name string The full name of the Consumer No None provided
Notes notes string Any notes relating to the Consumer No None provided
Notification notification string Should the consumer receive notifications No Disabled, Enabled
Preferred Language preferred_language string The preferred language of the Consumer No None provided
Prefix prefix string The prefix of the Consumer No None provided
State state string The state of the Consumers address No None provided
Street street string The street of the Consumers address No None provided
Suffix suffix string The suffix of the Consumer No None provided
Title title string The title of the Consumer No None provided
Zip/Post Code zip string The ZIP/Post Code of the Consumers address No None provided

Output Parameters

Display Name ID Type Description
Consumer Sys ID sys_id string The system ID of the Consumer
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document