Integration Authentication — Proposed Guide

Planned API — Reference Only

Integration Authentication: Provider authorization must be scoped to the intended organization and records. Remizen API authorization and provider-side…

Overview

Provider authorization must be scoped to the intended organization and records. Remizen API authorization and provider-side consent are separate grants.

Key concepts

Distinguish the consenting actor, provider tenant and integration owner. Track revocation independently of record synchronization.

Implementation considerations

Do not enter provider credentials here. No OAuth consent redirect, credential storage or token exchange is implemented.

Illustrative data model

This local fixture shows a possible representation for the concepts above. It is not an endpoint response, production configuration or a claim that the described capability is implemented.

JSON fixture

Fictional concept fixture

{
  "reference_only": true,
  "topic": "Integration Authentication",
  "integration_id": "integration_example_123",
  "provider_tenant_id": "provider_tenant_example_123",
  "scope": [
    "expenses:read"
  ],
  "grant_id": "grant_example_123"
}

Design review checklist

Document which organization owns the integration authentication representation and which actor may view or change it.
Test the boundaries of integration id, provider tenant id, scope, grant id using synthetic values, including missing or inconsistent references.
Before future implementation, obtain an approved contract and review failure behavior. This documentation does not authorize production activation.

Proposed data types

Illustrative field dictionary
Name	Type	Description
integration_id	string	Stable fictional integration reference; not a secret and not evidence that a resource exists.
provider_tenant_id	string	Stable fictional provider tenant reference; not a secret and not evidence that a resource exists.
scope	array<string>	Illustrative minimum-access grant names, not issued or finalized production scopes.
grant_id	string	Stable fictional grant reference; not a secret and not evidence that a resource exists.

Integration Architecture

Integrations

Integration Configuration