PUT /api/interaction

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
  • 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"
  }
}