Skip to main content
A document protected by a Microsoft Purview sensitivity label that applies encryption (Azure Rights Management) reaches the crawler encrypted. The prismeai-crawler service can decrypt it in memory before parsing, so its text is indexed like any other document’s. The stored file is never modified: downloaded again, it is still protected. This feature is in beta, and off by default. Until it is configured, protected documents are refused with MipNotConfigured instead of being indexed as unreadable content. Requirements:
  • Platform, crawler and search engine v27.10.0 or later, with the prismeai-core and prismeai-apps charts of the same release. Application mode alone works from v27.9.1.
  • The Microsoft commercial cloud. The US Government (GCC High) and China (21Vianet) clouds are not supported.

Choose a mode

MIP_MODE sets who asks Microsoft for each document’s key. It has no default, and the crawler never falls back from one mode to the other. Choose delegated unless you must index protected files that do not come from the SharePoint connector (uploads, other connectors, websites): it needs no tenant-wide permission.

Delegated mode

1

Give the crawler its platform identity

The crawler authenticates to the platform with a Kubernetes service account token. With the Helm charts, keep global.platformServiceAccount.enabled: true (the default) in both prismeai-core and prismeai-apps, and set global.apiUrl and global.internalApiUrl in the prismeai-apps values. Without the charts, see PLATFORM_SERVICE_ACCOUNTS in Environment variables and the PLATFORM_TOKEN_* variables below.
2

Allow Rights Management on the SharePoint connector

The SharePoint connections of your knowledge bases must sign in per user (OAuth), usually with the connector’s central client, see SharePoint. On the app registration they use, in Microsoft Entra, add API permissions > Add a permission > Azure Rights Management Services > Delegated permissions > user_impersonation. Grant admin consent if your tenant does not let users consent.Then, in the connector’s configuration app, add https://aadrm.com/user_impersonation to the Scopes of the central client (maintainer view), and to those of any workspace that uses its own Entra client or sets its own Scopes. Scopes replaces the default list, so also list the scopes the connector uses: read-write by default for the central client, read-only for a workspace’s own client (see SharePoint). Refresh tokens must stay enabled. For example, with the read-only scopes:
Each owner of an existing connection reconnects once. Until then, their protected documents are refused with MipOwnerNotConnected.
3

Open the egress from the runtime

Allow the platform runtime pods to reach login.microsoftonline.com and api.aadrm.com on port 443. See Network.
4

Configure the crawler

Set MIP_MODE=delegated, MIP_TENANT_ID, MIP_RMS_SERVICE_ID and MIP_ALLOWED_LABELS on prismeai-crawler, then restart it. See Crawler settings.

Application mode

Content.SuperUser lets its holder obtain the key of any protected document in your tenant, whatever rights the document grants. Microsoft then logs the application, not a person. Grant it to an application registration created for this purpose only, with no other permission. The label allowlist is what bounds it: anyone who can upload a file into a knowledge base can have it decrypted, even a file they may not open.
1

Register an application

In Microsoft Entra, App registrations > New registration: single tenant, no redirect URI. Note its Application (client) ID, and create a client secret under Certificates & secrets.
2

Grant Content.SuperUser

API permissions > Add a permission > Azure Rights Management Services > Application permissions > Content.SuperUser, then Grant admin consent. The tenant’s super-user feature (Enable-AipServiceSuperUserFeature) is not needed.
3

Open the egress from the crawler

Allow the crawler pods to reach login.microsoftonline.com and api.aadrm.com on port 443. See Network.
4

Configure the crawler

Set MIP_MODE=application, MIP_TENANT_ID, MIP_CLIENT_ID, MIP_CLIENT_SECRET, MIP_RMS_SERVICE_ID and MIP_ALLOWED_LABELS on prismeai-crawler, then restart it. See Crawler settings.

Crawler settings

Every MIP_* setting the mode needs is required. If one is missing, nothing is decrypted, and the startup log names what is missing. With Helm, in the prismeai-apps values:
One crawler deployment decrypts the documents of one Microsoft tenant.

Find the identifiers

  • RightsManagementServiceId, from a Windows machine, with an administrator of the rights management service:
  • Label GUIDs: in the Microsoft Purview portal, Information protection > Sensitivity labels, or with Security & Compliance PowerShell (Connect-IPPSSession, then Get-Label | Format-Table DisplayName, Guid). Braces and letter case do not matter.

Which labels are decrypted

  • MIP_ALLOWED_LABELS is the ceiling of the deployment. A label outside it is never decrypted. Add sharepoint-library to also decrypt files that a SharePoint library with IRM protected without a label. Protection applied by a person without a label is never decrypted.
  • Knowledge bases can narrow it. The platform, each organization and each knowledge base can set decryptable labels. In delegated mode, a label must be allowed both there and in MIP_ALLOWED_LABELS; with no list set at any level, MIP_ALLOWED_LABELS alone applies. In application mode the lists do not stop decryption: a document whose label they exclude is indexed but not returned by search.
An indexed document no longer carries its own rights: anyone who can read the knowledge base can read what was decrypted into it. Allow only labels whose protection already lets every reader of the knowledge bases this crawler feeds read the document, such as a label for all employees. The same holds for sharepoint-library, whose audience is the library’s readers.

Network

A TLS-inspecting proxy on these paths breaks decryption: exempt both hosts, or trust its CA with global.extraCABundle in the chart of the pods that reach Microsoft (prismeai-core in delegated mode, prismeai-apps in application mode), see Trusting an extra CA bundle. See also Network Policies.

Verify

After a restart, the crawler logs exactly one of these lines: In application mode, it then checks its access to Microsoft, without requesting any key: Azure RMS credentials accepted or … could not be verified at boot (wrong tenant, client ID or secret, or no egress to login.microsoftonline.com), and Rights-management endpoint reachable or … unreachable (egress or TLS inspection; this check does not use HTTPS_PROXY, so behind a proxy it can warn while decryption works). Admin consent is only checked by the first document: without it, documents are refused with MipAccessDenied. In delegated mode, check Platform token origins, which lists the platform origins the crawler sends its token to. A warning ending with platform calls go unauthenticated means the platform will refuse them: no origin listed, or no token mounted. Then index a protected document whose label is allowed: it becomes searchable, and the key request appears in your Rights Management usage log (Get-AipServiceUserLog) from the next day (UTC).

Troubleshooting

A refused document shows its code in its error, in the knowledge base’s document list. Once the cause is fixed, reindex the document, or click Retry failed documents on its connection. Changing MIP_MODE does not re-check documents already indexed at once: reindex them to apply the new mode now.

Operating requirements and limits

  • Temporary files hold decrypted content. Some conversions write into TMP_MEDIA_FOLDER (default /tmp/prismeai-crawler/). Put it on a tmpfs or an encrypted volume, and keep it out of backups.
  • Images of a protected document are not indexed, only its text.
  • Not decrypted: Double Key Encryption, password-protected files, and PDFs in the older SharePoint IRM format.

Crawler & SearchEngine

Deploying and configuring the crawler

Decryptable labels

Narrowing the labels per platform, organization and knowledge base