Onboarding Sessions

Delete an onboarding session

DELETE/onboarding-sessions/{id}
onboarding:writedelete_onboarding_sessionDestructiveIdempotent

Soft-deletes the session and the user's answers to every form of its flow, and returns 204. Classifications already awarded stay. It has no dry run (422) and can't be undone through the API. A repeat returns 404. Sends the onboarding_session.deleted webhook, no email. POST /onboarding-sessions/{id}/actions/reset starts over and keeps the record.

Path parameters

  • idstring (uuid)Required#

    The onboarding session's id, a uuid. An unknown id, or a session you cannot see, returns 404.

Responses

204

The onboarding session was deleted.

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/onboarding-sessions/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"