Add user profile

POST /api/experience/profile

Adds user profile data to the current experience interaction.
- For Register: The profile data provided before the identification request will be used to create a new user account.
- For SignIn and Register: The profile data provided after the user is identified will be used to update the user's profile when the interaction is submitted.
- ForgotPassword: Not supported.

application/json

Body object Required

One of:
object-1 object object-2 object object-3 object object-4 object object-5 object

Responses

  • 204

    The profile data has been successfully added to the current experience interaction.

  • 400

    Invalid request.
    - session.not_supported_for_forgot_password: This API can not be used in the ForgotPassword interaction.
    - session.verification_failed: The verification record is not verified.

  • 403

    SignIn interaction only: MFA is enabled for the user but has not been verified. The user must verify the MFA before updating the profile data.

  • 404

    Entity not found.
    - session.identifier_not_found: (SignIn interaction only) The current interaction is not identified yet. All profile data must be associated with a identified user.
    - session.verification_session_not_found: The verification record is not found.

  • 422

    The user profile can not been processed, check error message for more details.
    - The profile data is invalid or conflicts with existing user data.
    - The profile data is already in use by another user account.
    - The email address is enterprise SSO enabled, can only be linked through the SSO connector.

POST /api/experience/profile 
curl \
 -X POST https://[tenant_id].logto.app/api/experience/profile \
 -H "Content-Type: application/json" \
 -d '{"type":"string","value":"string"}'
Request examples 
{
  "type": "string",
  "value": "string"
}
{
  "type": "string",
  "value": "string"
}
{
  "type": "string",
  "verificationId": "string"
}
{
  "type": "string",
  "verificationId": "string"
}
{
  "type": "string",
  "verificationId": "string"
}