Investors

Deactivate an investor

DELETE/investors/{id}
investors:writedelete_investorDestructiveIdempotent

Deactivates the investor: a soft delete that ends their sessions and leaves them out of every list and read. It returns 204; a repeat returns 404. The API cannot reverse it yet. It has no dry run and needs investors:write. Emits investor.deleted and the legacy user.deactivated; sends no email.

Path parameters

  • idstring (uuid)Required#

    The investor's id, a uuid. An unknown investor, or one outside the token's organisation and its client organisations, returns 404.

Responses

204

The investor was deactivated.

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X DELETE https://your-org-domain/kong/core/api/v2/investors/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"