PUT /api/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://bump.sh/logto/doc/logto-experience-api/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Logto Experience API MCP server": {
    "url": "https://bump.sh/logto/doc/logto-experience-api/mcp"
  }
}

PUT /api/interaction

application/json

Body Required

event string Required

Values are SignIn, Register, or ForgotPassword.
identifier object
One of:
object-1 object object-2 object object-3 object object-4 object object-5 object object-6 object object-7 object object-8 object
Hide attributes Show attributes

username string Required

Minimum length is 1.

password string Required

Minimum length is 1.
Hide attributes Show attributes

email string Required

Minimum length is 1.

password string Required

Minimum length is 1.
Hide attributes Show attributes

phone string Required

Minimum length is 1.

password string Required

Minimum length is 1.
Hide attributes Show attributes

email string(regex) Required

Format should match the following pattern: /^\S+@\S+\.\S+$/.

verificationCode string Required

Minimum length is 1.
Hide attributes Show attributes

phone string(regex) Required

Format should match the following pattern: /^\d+$/.

verificationCode string Required

Minimum length is 1.
Hide attributes Show attributes

connectorId string Required

connectorData object Required

arbitrary
Hide attributes Show attributes

connectorId string Required

email string Required
Hide attributes Show attributes

connectorId string Required

phone string Required
profile object
Hide profile attributes Show profile attributes object
- username string(regex)
  
  Format should match the following pattern: /^[A-Z_a-z]\w*$/.
- email string(regex)
  
  Format should match the following pattern: /^\S+@\S+\.\S+$/.
- phone string(regex)
  
  Format should match the following pattern: /^\d+$/.
- connectorId string
- password string

Responses

204

No Content
400

Bad Request
401

Unauthorized
403

Forbidden
422

Unprocessable Content

PUT /api/interaction

curl \
 --request PUT 'https://[tenant_id].logto.app/api/interaction' \
 --header "Content-Type: application/json" \
 --data '{
  "event": "SignIn",
  "identifier": {
    "username": "string",
    "password": "string"
  },
  "profile": {
    "username": "string",
    "email": "string",
    "phone": "string",
    "connectorId": "string",
    "password": "string"
  }
}'

Request examples

{
  "event": "SignIn",
  "identifier": {
    "username": "string",
    "password": "string"
  },
  "profile": {
    "username": "string",
    "email": "string",
    "phone": "string",
    "connectorId": "string",
    "password": "string"
  }
}