Central Auth APIMagic Link

Sign In With Magic Link

Sign in with magic link

Authentication

AuthorizationBearer
Bearer token authentication

Request

This endpoint expects an object.
emailstringRequired
Email address to send the magic link
namestring or nullOptional

User display name. Only used if the user is registering for the first time. Eg: “my-name”

callbackURLstring or nullOptional
URL to redirect after magic link verification
newUserCallbackURLstring or nullOptional
URL to redirect after new user signup. Only used if the user is registering for the first time.
errorCallbackURLstring or nullOptional
URL to redirect after error.
metadatamap from strings to any or nullOptional
Additional metadata to pass to sendMagicLink.

Response

Success
statusboolean

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error