How to forcefully close an interaction?

[david-shiko]

Is there an endpoint like api/experience/interaction/abort?

[starkmarkus]

As far as I can tell, there is no explicit endpoint like:

POST /api/experience/interaction/abort

or

DELETE /api/experience/interaction

in the current Experience API.

The closest existing behavior seems to be starting a new experience interaction:

PUT /api/experience

with a body like:

{
  "interactionEvent": "SignIn"
}

The docs say that initializing a new interaction clears any existing interaction data. So if your goal is “discard the current in-progress interaction and start over”, this is probably the current API-level workaround.

That said, if by “forcefully close” you mean “terminate the interaction and return to the application with an OAuth/OIDC error such as access_denied”, then I do not think the Experience API currently exposes a dedicated abort/cancel endpoint for that. In that case, the usual frontend behavior would be to stop the custom experience flow and redirect the user yourself, depending on your app’s UX.

So my current understanding is:

• explicit abort endpoint: probably not available;
• reset current interaction: use PUT /api/experience, which starts a new interaction and clears existing data;
• OAuth-style cancel/deny redirect: likely needs custom frontend handling or would be a feature request for the Experience API.