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).

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