Docs

SDK guide

SDK usage should match the actual shield-sdk surface before examples are expanded into production docs.

Details

Clear claims, explicit boundaries

Install

Install the local or published SDK package according to your release process. Example package names must be confirmed against shield-sdk before publication.

Login decision

Call the SDK from a trusted backend with actor, device, IP and environment context, then map allow, deny, review or step-up outcomes in your application.

Action decision

Use action decisions for sensitive operations such as permission changes or API key issuance. Keep the action name stable so policies remain auditable.

// Server-side example only; align names with shield-sdk before publishing.
const decision = await shield.loginDecision({ actorId, ipAddress, deviceId });
if (decision.outcome === "deny") blockLogin();