Connectors

Test passwordless connector

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

post/api/connectors/{factoryId}/test

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/connectors/{factoryId}/test
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Path parameters

factoryIdstring required

The unique identifier of the factory.

Request body

phonestring regex

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

emailstring regex

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

configobject required

Connector configuration object for testing.

localestring

Preferred language for the message. If not set, the default language will be used. (Applicable only when custom i18n templates are configured.)

Response

Test message was sent successfully.

Changes

No recorded changes to this operation across all 8 revisions of this API.