Test passwordless connector

POST /api/connectors/{factoryId}/test
OAuth2

Test a passwordless (email or SMS) connector by sending a test message to the given phone number or email address.

Path parameters

  • factoryId string Required

    The unique identifier of the factory.

application/json

Body Required

  • phone string(regex)

    Phone number to send test message to. If this is set, email will be ignored.

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

  • email string(regex)

    Email address to send test message to. If phone is set, this will be ignored.

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

  • config object Required

    Connector configuration object for testing.

    Additional properties are allowed.

Responses

  • 204

    Test message was sent successfully.

  • 400

    Invalid request body (e.g. wrong phone number, email or config).

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Connector not found.

POST /api/connectors/{factoryId}/test 
curl \
 -X POST https://[tenant_id].logto.app/api/connectors/{factoryId}/test \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"phone":"string","email":"string","config":{}}'
Request examples 
{
  "phone": "string",
  "email": "string",
  "config": {}
}