Authorization
Use a server-side API key with the listed grants and permitted resource access.
identities:manageRequest headers
X-Api-Keyrequired- Your server-side integration credential.
Idempotency-Keyrequired- Stable key for this intended action. Reuse it for retries of the same request.
Content-Typeapplication/json- Encode the request body as JSON.
Request body
subjectstring · required- Stable user ID in this integration. Never use an email address as the identity key.
loginModestring · required- The loginMode values for this request.Allowed: tenant, managed
emailstring · optional- Invitation contact for managed sign-in. Verification alone does not grant resource access.
Response
Returns the authorized resource or result for this operation. List results use items, nextCursor, and hasMore.
Behavior to account for
Provisioning access is separate from issuing sessions. Requested resources must already lie within the integration’s administratively approved resource and delegation policy.
Errors
Authentication failures return 401 or 403. Inaccessible resources return 404. Business and idempotency conflicts return 409. Rate limits return 429 with retry guidance.
Error handling guide