Create Credential

Field	Required	Default	Multiple	Notes	Example
type	Yes	-	No	The value must be "confluence-identities".	"confluence-identities"
description	Yes	-	No	Name of the credential object.	"My RDB Credential"
properties	Yes	-	No	Configuration object
user	Yes	-	No	Username.	"admin"
password	Yes	-	No	Password or the token in case of Cloud	"adminPassword"
domain	No	-	No	Domain used to log in to Confluence. If the domain is not required by the environment, it is ignored.	"CompanyDomain"
userFormsAuth	No	false	No	Use login.action POST action to authenticate instead of using BASIC Authorization headers (only for On-Premise version)	false
cookieTimeout	No	3000	No	Cookie Timeout (in secs)	2000

Example

POST aspire/_api/credentials

{
    "type": "confluence-identities",
    "description": "My Confluence Credential",
    "properties": {
        "user": "admin",
        "password": "adminPassword"
    }
}

Create Connection

Field	Required	Default	Multiple	Notes	Example
type	Yes	-	No	The value must be "confluence-identities".	"confluence-identities"
description	Yes	-	No	Name of the connection object.	"My Confluence Connection"
throttlePolicy	No	-	No	ID of the throttle policy that applies to this connection object.	"6b235b333a1b"
routingPolicies	No	[ ]	Yes	The IDs of the routing policies that this connection will use.	["17f75ce7d0c7", "d42780003b36"]
credential	Yes	-	No	ID of the credential	"6b235b333a1b"
properties	Yes	-	No	Configuration object
url	Yes	-	No	URL to access the Confluence server in the form of: http://{servername}{:port} In some Confluence installations you must add '/confluence' to the end of the server name – e.g., http://wiki.local.search/confluence. The connector uses the REST API to communicate with Confluence. To verify REST, append /rest/api/space at the end of the URL. Test it in a browser.	"http://confluence.company.com/"
cloud	No	false	No	Select if your server is in the Cloud.	true

populateUserEmail	No	false	No	Confluence provides a prototype API to retrieve a user's email. Check this box if the API should be used to populate the user's email field. The email will be populated in the displayUrl field in the Aspire output object.	true
ignoredErrorCodes	No	-	No	A comma delimited list of HTTP response status codes, which should be ignored and not reported as errors while retrieving user emails or checking groups' existence.
scanExcludedItems	No	false	No	Select so that the scanner will scan sub items of container items excluded by a pattern (because it matches an exclude pattern or because it doesn't match an include pattern).	true

connectionTimeout	No	15000	No	Maximum time to wait (in milliseconds) for the connection	30000
readTimeout	No	30000	No	Maximum time to wait for read (in milliseconds)	40000
retries	No	3	No	Maximum number of retries for a failed document	1
retryDelay	No	15000	No	Retry delay (in milliseconds)	30000
maxRetryDelay	No	600000	No	Maximum retry delay (in milliseconds)	500000
retryDelayMultiplier	No	1.0	No	Retry delay multiplier	1.5

resultSetLimit	No	100	No	The maximum number of records to be retrieved at a time per page through the Confluence REST API.	200
logRestAPI	No	false	No	Select to Log REST API requests details on the INFO level.	true

Example

POST aspire/_api/connections

{
   "type": confluence-identities,
   "description": "Confluence identities",
   "properties": {
          "url": "http://localhost:8090",
          "populateUserEmail": false,
          "ignoredErrorCodes": "",
          "scanExcludedItems": false,
          "resultSetLimit": "100",
          "connectionTimeout": "15000",
          "readTimeout": "30000",
          "retries": "3",
          "retryDelay": "15000",
          "maxRetryDelay": "600000",
          "retryDelayMultiplier": "1.0",
          "logRestAPI": false
      }
}

Update Connection

Field	Required	Default	Multiple	Notes	Example
id	Yes	-	No	ID of the connection to update	"d442adcab4b0",
description	No	-	No	Name of the connection object.	"My RDB Connection"
throttlePolicy	No	-	No	ID of the throttle policy that applies to this connection object.	"b3a9-6b235b333a1b"
routingPolicies	No	[ ]	Yes	The IDs of the routing policies that this connection will use.	["17f75ce7d0c7", "d42780003b36"]
credential	No	-	No	ID of the credential	"6b235b333a1b"
properties	No	-	No	Configuration object
(see create connection)

Example

PUT aspire/_api/connections/89d6632a-a296-426c-adb0-d442adcab4b0

{
   "id": "89d6632a-a296-426c-adb0-d442adcab4b0",
   "description": "Confluence identities",
    "properties": {
          "url": "http://localhost:8090",
          "populateUserEmail": false,
          "ignoredErrorCodes": "",
          "scanExcludedItems": false,
          "resultSetLimit": "100",
          "connectionTimeout": "15000",
          "readTimeout": "30000",
          "retries": "3",
          "retryDelay": "15000",
          "maxRetryDelay": "600000",
          "retryDelayMultiplier": "1.0",
          "logRestAPI": false
      }
}

Create Connector

For the creation of the Connector object using the Rest API, please refer to this page

Update Connector

For the update of the Connector object using the Rest API, check this page

Create Seed

Field	Required	Default	Multiple	Notes	Example
type	Yes	-	No	The value must be "confluence-identities".	"confluence-identities"
description	Yes	-	No	Name of the seed object.	"My Confluence"
connector	Yes	-	No	The ID of the connector to be used with this seed. The connector type must match the seed type.	"e3ca414b0d31"
connection	Yes	-	No	The ID of the connection to be used with this seed. The connection type must match the seed type.	"e4a663fe9ee6"
workflows	No	[ ]	Yes	The IDs of the workflows that will be executed for the documents crawled.	["5696c3f0bda4"]
throttlePolicy	No	-	No	ID of the throttle policy that applies to this seed object.	"6b235b333a1b"
routingPolicies	No	[ ]	Yes	The IDs of the routing policies that this seed will use.	["17f75ce7d0c7", "d42780003b36"]
tags	No	[ ]	Yes	The tags of the seed. These can be used to filter the seed.	["tag1", "tag2"]
properties	Yes	-	No	Configuration object
includeUsers	No	true	No	Select to include users in the crawl.	false
allUsersGroup	No	-	Yes	The group(s) that contains all Confluence server users - uses comma delimited values for multiple entries. Drives the selection of the entire set of users.	"confluence-users"

includeGroups	Yes	true	No	Select to include groups in the crawl.	false
groupsSelection	No	-	No	The group(s) that should be included - use comma delimited values for multiple entries. Nothing here means all groups.
publishScopeType	No	groupsAndMembers	Yes	Group related entities that should be sent for processing to the connector workflow: groupsOnly - Publish groups only; membersOnly - Publish members only; groupsAndMembers - Publish groups and members	"membersOnly"

includes	No	[ ]	Yes	Patterns to match against document URL, if any of them match, the document will be included in the crawl.	[ ".pdf$", ".docx$" ]
excludes	No	[ ]	Yes	Patterns to match against document URL, if any of them match, the document will be excluded from the crawl.	[ ".png$", ".jpeg$" ]

Example

POST aspire/_api/seeds

{
  "type": "confluence-identities",
  "description": "Confluence identities",
    "properties": {
          "includeUsers": true,
          "allUsersGroup": "confluence-users",
          "includeGroups": true,
          "groupsSelection": "",
          "publishScopeType": "groupsAndMembers",
          "includes": [],
          "excludes": []
      }
}

Update Seed

Field	Required	Default	Multiple	Notes	Example
id	Yes	-	No	ID of the seed to update	"2f287669-d163-4e35-ad17-6bbfe9df3778"
(see the "Create seed" for other fields)

Example

PUT aspire/_api/seeds/2f287669-d163-4e35-ad17-6bbfe9df3778

{
  "id": "2f287669-d163-4e35-ad17-6bbfe9df3778",
  "description": "Confluence identities",
    "properties": {
          "includeUsers": true,
          "allUsersGroup": "confluence-users",
          "includeGroups": true,
          "groupsSelection": "",
          "publishScopeType": "groupsAndMembers",
          "includes": [],
          "excludes": []
      }
}

Disable checkingPremium suggestionsDisable checkingPremium suggestionsDisable checkingPremium suggestionsProvided by LanguageToolWordSentenceBetamillisPronounce wordLoading …Disable checkingPremium suggestionsDisable checkingPremium suggestionsDisable checkingPremium suggestionsDisable checkingPremium suggestionsDisable checkingPremium suggestions

Page tree

Create Credential

Example

Create Connection

Example

Update Connection

Example

Create Connector

Update Connector

Create Seed

Example

Update Seed

Example

Contact Us: [email protected]

Page tree

Rest API - Confluence Identities Connector Configuration

Create Credential

Example

Create Connection

Example

Update Connection

Example

Create Connector

Update Connector

Create Seed

Example

Update Seed

Example

Contact Us: [email protected]