Versions Compared

Old Version 1

changes.mady.by.user Ricardo Fonseca

Saved on

compared with

New Version 2

changes.mady.by.user Ricardo Fonseca

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


REST API Seeds configuration guidelines can be found here.

Azure Identity ServiceNow Connector Seeds "type" must always be specified as "azure-identityservicenow".

Azure Identity ServiceNow Connector Seeds "seed" can be any string.

Properties specific to the Azure Identity to the ServiceNow Connector Seeds are described below.


Easy Heading Free
navigationTitleOn this Page
navigationExpandOptionexpand-all-by-default

Azure Identity Credentials Properties

FieldRequiredDefaultMultipleNotesExample
propertiesNo-NoConfiguration object
lowerCase

includeArticlesNofalseNoIf set to true
, all extracted identities are stored in lowercase
, knowledge articles will be crawled and, optionally, attachments for those articles can be crawled too.true / false
addEveryoneGroup
articlesDisplayUrlBaseNo"/kb_view.do?sysparm_article="NoThe base display URL for articles."/kb_view.do?sysparm_article="
useKBSecurityNofalseNoIf set to true
, adds an "Everyone" group for all user identities
, ACLs for articles and attachment are retrieved (requires server configuration).true / false
patternFieldYes-NoThe field to be used when including/excluding articles: 0 = Article Number, 1 = Title.
0 / 1
includesANo-YesThe patterns to be used to include articles for the crawl."includesA": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]
excludesANo-Yesthe patterns to be used to exclude articles for the crawl."excludesA": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]
includeKAItemsAttachmentsNofalseNoIf set to true, knowledge articles' attachments will be crawled.true / false
includeArticlesAttachmentsRegexNofalseNoIf set to true, include/exclude patterns filtering will be allowed for articles' attachments.true / false
addEveryoneExceptExternalGroup
useMimeTypeNofalseNoIf set to true,
adds the "Everyone except external users" group for all user identities.true / false
the connector will match the patterns using the mime type  of the attachment instead of the file name.true / false
includedArticlesAttachmentsFileNameNo-YesThe patterns to be used to include article attachments for the crawl."includedArticlesAttachmentsFileName": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]
excludedArticlesAttachmentsFileNameNo-YesThe patterns to be used to exclude article attachments for the crawl."excludedArticlesAttachmentsFileName": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]
includeCatalogItemsNofalseNoIf set to true, catalog items will be crawled.true / false
includeCatalogModelFieldsNofalseNoIf set to true, includes the key fields of the model associated to the catalog item.true / false
patternFieldCatalogYes-NoThe field to be used when including/excluding catalog items: 2 = Catalog Title, 3 = Short Description.
2 / 3
includesCNo-YesThe patterns to be used to include catalog items for the crawl."includesC": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]
excludesCNo-YesThe patterns to be used to exclude catalog items for the crawl."excludesC": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]
includeCatalogItemsAttachmentsNofalseNoIf set to true, catalog items' attachments will be crawled.true / false
includeCatalogItemsAttachmentsRegexNofalseNoIf set to true nclude/exclude patterns filtering will be allowed for catalog items' attachments.true / false
useMimeTypeForCatalogNofalseNoIf set to true, the connector will match the patterns using the mime type  of the attachment instead of the file name.true / false
includedCatalogItemsAttachmentsFileNameNo-YesThe patterns to be used to include catalog attachments for the crawl."includedCatalogItemsAttachmentsFileName": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]
excludedCatalogItemsAttachmentsFileNameNo-YesThe patterns to be used to exclude catalog attachments for the crawl."excludedCatalogItemsAttachmentsFileName": [ { "pattern": ".*filter1.*" }, { "pattern": ".*filter2.*" } ]
userRegexNo-NoRegular expression to filter users to add if the "addEveryoneExceptExternalGroup" is set to true.".*companyAGroup.*"

Usage example

Code Block
themeRDark
titlePOST /aspire/_api/credentialsseeds
{
	"seed": "testSeedservicenow_seed",
	"type": "azure-identityServiceNow",
	"description": "AzureIdentitySeedServiceNow Test Seed",
	"connector": "b3aee82802ab6c29-06ff61e3-4a0542ff-b6a59c4f-29c22f79255552811d0c2c38",
	"connection": "57218d6be3f76fd9-62ed9517-485e430a-9dac9064-8423d06dddfg9cf447473ddd",
	"workflows": [],
	"tags": [],
	"properties": {
		"seed": "servicenow_seed",
		"includeArticles": true,
		"articlesDisplayUrlBase": "/kb_view.do?sysparm_article=",
		"useKBSecurity": false,
		"patternField": "1",
		"includesA": [
			{
				"pattern": ".*Sales.*"
			}
		],
		"excludesA": [
			{
				"pattern": ".*Technology.*"
			}
		],
		"includeKAItemsAttachments": true,
		"includeArticlesAttachmentsRegex": true,
		"useMimeType": false,
		"includedArticlesAttachmentsFileName": [],
		"excludedArticlesAttachmentsFileName": [
			{
				"pattern": ".*2021.*"
			},
			{
				"pattern": ".*2022.*"
		"lowerCase	}
		],
		"includeCatalogItems": true,
		"addEveryoneGroupincludeCatalogModelFields": false,
		"patternFieldCatalog": "2",
		"includesC": [
			{
				"pattern": ".*Sales.*"
			}
		],
		"excludesC": [
			{
				"pattern": ".*Technology.*"
			}
		],
		"includeCatalogItemsAttachments": true,
		"addEveryoneExceptExternalGroupincludeCatalogItemsAttachmentsRegex": true,
		"useMimeTypeForCatalog": false,
		"includedCatalogItemsAttachmentsFileName": [],
		"excludedCatalogItemsAttachmentsFileName": [
			{
				"pattern": "*.2021.*"
			},
		"userRegex	{
				"pattern": ".*companyBGroup2022.*"
			}
		]
	}
}