Skip to main content
DELETE
Retire a test or integration end user without deleting financial history

Authorizations

Authorization
string
header
required

Locus Pro dashboard session (Cognito). High-risk workspace administration requires an owner or admin role and fresh MFA/passkey step-up.

Headers

X-Locus-Step-Up
string<password>

Short-lived raw MFA/passkey step-up token bound to the authenticated Cognito subject. Send it alongside the dashboard Bearer token for workspace-administrator mutations when the base session does not itself prove MFA within the last ten minutes. Never send it with a tenant secret key.

Path Parameters

externalUserId
string
required

Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,199}$

Response

Retirement converged

success
any
required
externalUserId
string
required

Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,199}$
retired
boolean
required
alreadyRetired
boolean
required
accountId
string<uuid> | null
required
revokedTokens
integer
required
Required range: x >= 0
revokedAgentConnections
integer
required
Required range: x >= 0
canceledApprovals
integer
required
Required range: x >= 0
policyReset
boolean
required