Exploring credentials, connections, and aliases
Summarize
Summary of Exploring credentials, connections, and aliases
In the ServiceNow AI Platform, all application integrations require properly configured connections, credentials, and aliases to securely and efficiently access external resources. Understanding these components is essential before running any integration.
Show less
Key Concepts
- Connection: Defines the integration endpoint details such as IP addresses, protocols, or database specifics.
- Credential: Contains authentication information like IDs and passwords needed for the connection.
- Alias: Acts as a reusable naming convention that ties together connection and credential information, simplifying integration setups across different environments (e.g., QA, development, production).
The platform supports two types of aliases: Credential Aliases (credential data only) and Connection and Credential Aliases (full integration information). Additionally, child aliases can be created under parent aliases to manage multiple connections within the same integration, each with its own credentials.
Benefits
- Centralized management of credentials for external services.
- Reuse of connection and credential information across multiple platform features, reducing repetitive configuration.
- Enables non-administrators to utilize predefined connections securely.
- Improves security by controlling access and centralizing sensitive data.
Features Utilizing Connections, Credentials, and Aliases
- Flow Designer
- IntegrationHub
- Cloud Management
- Discovery
- Orchestration
- Service Mapping
Aliases can be configured via the Connections and Credentials module or within the Integration Hub dashboard (which requires a separate subscription).
CREDENTAIL Synchronization on MID Servers
MID Servers synchronize credentials from the ServiceNow instance to speed up network device access during operations like Discovery and Service Mapping. This synchronization occurs when a credentialsreload job runs, transferring credential data including custom fields via SOAP calls.
To optimize performance and control synchronization scope, you can adjust system properties that exclude custom fields or limit recursion depth when traversing reference tables in credentials:
- com.snc.credentialsuserfields: Set to
falseto exclude custom fields during sync (default istrue). - com.snc.credentialsrecursiondepth: Controls how many reference table levels to traverse (default value is 3).
Security and Data Separation
- Scope Protections: You can assign connection and credential records to specific scopes to protect them from unauthorized access and interaction.
- Domain Separation: Supported for Credentials and Connections, allowing logical grouping of data and control over user access based on domains.
Configuration Templates
Administrators and users with the flowdesigner role can use configuration templates to set up spoke integrations with third-party systems through a single, customizable form, streamlining integration processes.
All application integrations in the ServiceNow AI Platform use connections, credentials, and aliases to enable applications to access resources.
Before you can execute an application integration in the ServiceNow AI Platform, you must create and configure connection information, corresponding credentials, and add an alias. To understand how ServiceNow defines these terms:
- Connection
- A connection is an integration with a system, such as an IP address or endpoint with protocols. It contains specific details, such as database particulars, when integrating with a database.
- Credential
- A credential is the authentication data required to make the connection, such as an ID and password.
- Alias
- An alias is a naming convention, or tag, that ties to a set of
connections or credentials on your instance. An alias contains the necessary connection
and credential information to make an application integration. Rather than enter that
information every time you integrate, you can use an alias. For example, you can
designate an alias to house your QA, development, and production credentials for the
same application integration. The alias resolves the application integration for each
environment. The ServiceNow AI Platform distinguishes different types of aliases:
- Credential Alias
- This alias associates to credential data only, and resolves during runtime.
- Connection and Credential Alias
- This alias associates to connection information and the credential data required to complete the integration, and resolves during runtime.
Within connection and credential aliases, you can also create additional aliases called child aliases. Child aliases allow you to create multiple connections within the same application integration. When you create a child alias, the alias you created it under becomes a parent alias. While child aliases inherit properties from their parent alias, child aliases carry their own connection and credential information.
Benefits to using Connections, Credentials, and Aliases
- Central location to store and manage credentials to an external service
- Define once and reuse for multiple platform features
- Minimize configuration of other platform features
- Allow non-administrators to use predefined connections and credentials
- Increased security
Features using Connections, Credentials, and Aliases
- Flow Designer
- IntegrationHub
- Cloud Management
- Discovery
- Orchestration
- Service Mapping
- Using the Connections and Credentials module. See Create a Connection & Credential alias.
- In the Connections dashboard of Integration Hub. See Add a connection.Note:Integration Hub requires a separate subscription. For more information, see Request Integration Hub.
Credential synchronization on MID Servers
Each MID Serverin your network synchronized with the instance keeps a copy of every credential that you create. The Management, Instrumentation, and Discovery (MID) Server is a Java application that enables communication and the movement of data between a ServiceNow instance and external applications, data sources, and services. This synchronization speeds up the reading of credentials when applications like Discovery or Service Mapping need to access multiple devices on the network. The MID Servers synchronize when they find a credentials_reload job in the ECC Queue. The reload job instructs the MID Server to make a SOAP call to the instance to get the entire list of credentials in the Credentials [discovery_credentials] table, including all the field values. To learn more, see MID Server.
| Property | Description |
|---|---|
com.snc.credentials_user_fields |
Includes all customized fields in credential sync. Set this property to false
if you do not want to include the fields that you added to credential forms.
|
com.snc.credentials_recursion_depth |
Defines the number of tables to traverse when the credential-sync mechanism
collects fields from reference tables. Lower this number if you are experiencing
performance issues and you have customized credential forms that include reference
fields to tables that also have reference fields.
|