Update interaction event

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://openapi.logto.io/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Logto API references MCP server": {
    "url": "https://openapi.logto.io/mcp"
  }
}

PUT /api/experience/interaction-event

Update the current experience interaction event to the given event type. This API is used to switch the interaction event between SignIn and Register. The verification records are kept, but any user already identified in this interaction is discarded, along with everything staged against that identification: the pending profile data, any MFA factor bound in this interaction, and the trusted-device opt-in. Identify the user again before submitting. A verification record answers only for the account it was made against, so it cannot identify a different user after the switch.

application/json

Body Required

interactionEvent string Required

The type of the interaction event. Only SignIn and Register are supported.

Values are SignIn, Register, or ForgotPassword.

Responses

204

The interaction event has been successfully updated.
400

The interaction event is invalid or cannot be updated. Only SignIn and Register are interchangeable. If the current interaction event is ForgotPassword, it cannot be updated.
403

The given interaction event is not enabled in the sign-in experience settings.

PUT /api/experience/interaction-event

curl \
 --request PUT 'https://[tenant_id].logto.app/api/experience/interaction-event' \
 --header "Content-Type: application/json" \
 --data '{
  "interactionEvent": "SignIn"
}'

Request examples

{
  "interactionEvent": "SignIn"
}