Glossary
Overview
This glossary defines the terms used throughout the Interact developer documentation. Where a concept has gone by several names, the heading gives the canonical term you should use.
App Development Kit
A toolset within the Developer Framework for building custom apps that integrate with Interact and supplement its existing functionality.
Authentication token
The bearer token used by SCIM v2.0 and General Profile Sources. For SCIM v2.0 it is sent in the Authorization header; for General Profile Sources it is sent in the X-ApiKey header. See Authentication overview.
Custom connector
A connector you build yourself to push data into Interact through an API, such as a Workplace Search custom connector that adds external documents to the search index. Contrast with a native connector.
Developer Framework
The part of Interact that lets you customise and extend your intranet with your own JavaScript, CSS and apps. Examples in these docs are samples, not officially supported by Interact Technical Support, and should be reviewed and tested by your development team before use.
EntityId / URN
A unique identifier for a resource. In SAML, the EntityId identifies the Service Provider or Identity Provider; in SCIM, schemas are identified by a URN (Uniform Resource Name), such as urn:ietf:params:scim:schemas:core:2.0:User.
External Identities
A permissions mechanism in Workplace Search. You attach a list of External Identities to a document and to a user, and a user can only see documents that share an External Identity with them. This works separately from other Interact groups and permissions.
Identity Provider (SAML)
In a SAML single sign-on exchange, the system that authenticates the user and asserts their identity to the Service Provider. See also Service Provider.
Microsoft 365
Microsoft's cloud productivity suite. Use this name rather than Office 365 or O365.
Microsoft Entra ID
Microsoft's cloud identity service, formerly Azure AD. Interact provides a native connector that pulls profile information from Microsoft Entra ID (formerly Azure AD). After first mention, use Entra ID.
Native connector
A connector supplied by Interact that pulls profile information from a known source, such as Active Directory or Microsoft Entra ID. Contrast with a custom connector.
Page Composer
The Interact feature for building and arranging intranet page content from blocks and widgets.
Placeholder
A value you replace with your own, shown in {{double_brace}} form — for example {{intranet_url}} or {{auth_token}}. Replace the whole placeholder, including the braces, with your value before running an example.
Power User
A defined Interact role with administrative access, including the ability to generate API credentials and configure profile sources in Control Panel.
Profile source
A configured source of user profile data in Interact. A native connector pulls data from a known system; the Profile Sources API and SCIM v2.0 let third parties push profile data into Interact.
SCIM
System for Cross-domain Identity Management v2.0, a standard for user and group provisioning (RFC 7642, 7643, 7644). Interact supports SCIM v2.0 with schema extensions for its profile fields, and it is the preferred method for profile synchronisation.
Secret key
The per-connector credential used by the Workplace Search API, sent in the X-ApiKey header. Never expose it in client-side code. See Authentication overview.
Service Provider (SAML)
In a SAML single sign-on exchange, the system that relies on the Identity Provider to authenticate users — in this context, Interact. See also Identity Provider.
UMI
The user-management import system in Interact. The UMI Connector Service queries a source and produces a structured XML file, and the UMI Processor Service imports that file's user data into Interact.
Workplace Search
Interact's technology for adding documents from any system to the intranet search index so they appear in quick search, general search, content widgets and more. Formerly known as Enterprise Search.