Init new interaction

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

mcp.json 
{
  "Logto API references MCP server": {
    "url": "https://openapi.logto.io/mcp"
  }
}
Close
PUT /api/experience

Init a new experience interaction with the given interaction type. Any existing interaction data will be cleared. When the login prompt carries a step-up authentication context (an authenticated session that does not satisfy the requested acr_values), the interaction pins the session subject. If the session already satisfies the class the step-up pursues and the request forces no fresh authentication, the interaction is finished with the session's context untouched and a redirect URL is returned. If the pinned user has no method that can reach that class, the interaction is finished with unmet_authentication_requirements and a redirect URL is returned instead.

application/json

Body Required

  • interactionEvent string Required

    Values are SignIn, Register, or ForgotPassword.

  • captchaToken string

Responses

  • 200 application/json

    The step-up interaction was finished without UI and a redirect URL is returned. Either the session already satisfies the class the step-up pursues, so acr, amr, and auth_time stay as recorded, or the pinned user has no method that can reach it and the request is answered with unmet_authentication_requirements; follow redirectTo to return to the application.

    Hide response attribute Show response attribute object
    • redirectTo string Required
  • 204

    A new experience interaction has been successfully initiated.

  • 400

    A step-up interaction was requested with a non-sign-in event, or the session has no subject to pin.

  • 404

    The pinned subject of the step-up interaction no longer exists.

  • 422

    The captcha verification failed.

PUT /api/experience 
curl \
 --request PUT 'https://[tenant_id].logto.app/api/experience' \
 --header "Content-Type: application/json" \
 --data '{
  "interactionEvent": "SignIn",
  "captchaToken": "string"
}'
Request examples 
{
  "interactionEvent": "SignIn",
  "captchaToken": "string"
}
Response examples (200) 
{
  "redirectTo": "string"
}