Who manages what

  • Encrisoft registers partner clients, issues their credentials and can revoke a client.
  • Customer owners and admins approve, review and revoke installations for their organisation.
  • Partners keep their client credentials secure and stop calling when access is revoked.

Approve an installation

During the developer preview there is no installation screen in the Encrisoft app. Installations are managed through the Encrisoft API by an owner or admin with the integrations.manage permission. Creating an installation also requires a recent step-up re-authentication. Your Encrisoft contact can guide you through it.

  1. List the partner clients your organisation can install with GET /api/v1/integrations/mcp/clients.
  2. Create the installation with POST /api/v1/integrations/mcp/installations, choosing the scopes and the number of days until it expires.
  3. Give the returned installation id to the partner through a secure channel.
POST /api/v1/integrations/mcp/installations request body
{
  "clientId": "mcpc_…",
  "scopes": ["organisation:read", "training_catalogue:read"],
  "expiresInDays": 30
}
  • clientId: the partner client’s ID from the clients list.
  • scopes: one or more of the client’s allowed scopes.
  • expiresInDays: a whole number from 1 to 90.

The installation records the scopes, a status of ACTIVE, EXPIRED or REVOKED, its expiry and creation times, and the administrator who approved it.

Common errors

  • 400: scopes are empty or outside the client’s allowed scopes, or the expiry is outside 1 to 90 days.
  • 403: you lack integrations.manage, or the step-up re-authentication is missing or too old.
  • 404: the partner client does not exist or is not active.
  • 409: this client already has an active installation for your organisation. Revoke it first.

Review installations

List your organisation’s installations with GET /api/v1/integrations/mcp/installations.

Revoke access

Revoke an installation with DELETE /api/v1/integrations/mcp/installations/{id}. Revocation is idempotent and takes effect on the partner’s next call: new token requests fail with invalid_grant and tool calls fail with unauthorized.

Renew an installation

An installation cannot be extended. When it is close to expiry, revoke it (or let it expire) and create a new one, then give the partner the new installation ID.

When the approving administrator changes

Access depends on the administrator who approved the installation. If that person is deactivated, leaves the organisation or is no longer an owner or admin, the installation stops working: token requests fail with invalid_grant and tool calls return unauthorized. If they remain an owner or admin but lose a permission a tool needs, calls to that tool return forbidden. To restore access, another owner or admin revokes the installation and approves a new one.

Protect partner client credentials

  • The client secret is shown only once. Store it straight in a secret manager.
  • Never put the secret in source code, configuration files in version control, logs, URLs, tickets or chat.
  • If a secret may have been exposed, contact Encrisoft immediately so the client can be revoked.
  • The preview has no in-place secret rotation. Encrisoft replaces credentials by revoking the client and registering a new one, and each customer must then approve an installation for the new client.