1. MagicLink
  • Overview
  • Application Guides
    • Frontend
      • Get Started - React App
      • Get Started - HTML and JS
      • Get Started - Angular JS
      • Get Started - Next JS App
    • Backend
      • Get Started - Node JS
      • Get Started - Golang
      • Get Started - ASP.NET
      • Get Started - JAVA
  • Dashboard
    • API Credentials
    • Organization
    • Social Login
    • Customize Email Template
    • Configure Custom Domain
    • IT Admin Portal
  • Authentication
    • Login Widget
    • Magic Link
    • Google Social Login
    • Multi-Factor Authentication
    • Single Sign-On Overview
    • Setup SSO Connection
  • Security
    • Overview
    • Authentication
      • Password Hashing and Storage
      • Multi-Factor Authentication Methods and Implementation
      • Session Management
    • Attack Protection
      • Bot Detection
      • Breached Password Detection
      • Brute Force Protection
      • Log Events
      • Secure JSON Web Tokens (JWT)
      • Secure OpenID Connect (OIDC)
      • Suspicious IP Throttling
    • Data Security
      • Data Encryption At Rest and In Transit
      • Secure Storage of Secrets (Keys, Credentials)
      • Sensitive Data Handling
    • Infrastructure
      • Security Considerations for Cloud Provider or Deployment Model
      • Threat Modeling
  • API References
    • Authentication
      • MagicLink
        • Email a Magic Link
          POST
        • Resend Email Magic Link
          POST
        • Verify Magic Link
          GET
        • Ping Status
          GET
      • Magic Auth Code
        • Email a Magic Auth Code
        • Resend Magic Auth Code
        • Verify Magic Auth Code
      • Phone Authentication
        • Send Magic Auth Code via SMS
        • Resend Magic Auth Code via SMS
        • Phone Magic Auth Verify
      • PassKey
        • Initiate Passkey Login
        • Passkey Registration Initialize
        • Finish Passkey Authentication
        • Complete Passkey Registration
        • Check User Passkey Authentication Status
        • List User PassKey Credentials
        • Update Passkey Name
        • Delete Associated Passkey
      • GET Auth Status
        GET
    • Token
      • Refresh Token
      • Access Token By Auth Code
    • Mutli-Factor Authentication (MFA)
      • MFA Access Token
      • List of Authenticators
      • MFA Enroll TOTP
      • Initiate MFA
      • QR Code Image API
      • Validate MFA Token
      • Get Backup Code
    • Role And Permission
      • List All Roles
      • List All Permission
      • Create New Role
      • Update Existing Role
      • Update Permission By Permission Id
      • Remove Organization Role By Role Id
      • Remove Organization Permission By Permission Id
    • User Management
      • List All Users
      • GET User By User Id
      • GET User by User Email Address
      • Create a User
      • Update User by User Id
      • Verify User Status By User Id
      • Delete User By User Id
      • Manage User Roles
      • GET Users Organizations
      • GET User Login Logs
    • Organization
      • Add New Organization
      • Get Organization
      • Get All Organization
      • Update Organization
      • Delete Organization
      • GET Configuration By Client Id
      • GET Configuration By Custom Domain
  1. MagicLink

Verify Magic Link

GET
https://api.ssojet.com/api/v1/auth/passwordless/magic-link/verify

Verify Magic Link for Passwordless Authentication#

This endpoint makes an HTTP GET request to verify a magic link for passwordless authentication. The request should include the client_id, state, and magictext as query parameters.

Request Parameters#

client_id (string): The client ID for the authentication.
state (string): The state parameter for the authentication.
magictext (string): The magic text to be verified for authentication.

Response#

The response will include the authentication status and any relevant authentication details.

Request

Query Params
client_id
string 
required
This identifies the application making the request to the SSOJET server. You can find your client ID on the API Keys page in the dashboard
Example:
string
state
string 
required
The state parameter is used to track the status of a user authencation in the REST API. It helps in maintaining the user authencation context and monitoring its progress throughout the request lifecycle
Example:
string
magictext
string 
required
The magic text is a unique code sent to the user's email as part of the magic link authentication process. This text ensures secure and seamless login by verifying the user's identity when they click the link.
Example:
string
Header Params
User-Agent
string 
required
Example:
SSOJET API
Content-Type
string 
optional
Default:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.ssojet.com/api/v1/auth/passwordless/magic-link/verify?client_id=string&client_id=&state=string&magictext=string' \
--header 'User-Agent: SSOJET API' \
--header 'User-Agent;' \
--header 'Content-Type: application/json'

Responses

🟢200Response
text/html
Body
object {0}
Example
<!doctype html><meta charset="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>SSOJet | Successfully verified</title><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="preconnect" href="https://fonts.gstatic.com"><link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=Maven+Pro:wght@700&display=swap" rel="stylesheet"><style>*{box-sizing:border-box}html{font-size:16px;line-height:1.5}body{margin:0;padding:0;font-family:inter,sans-serif;color:#1b1c1e}html,body{min-height:100%}h1,h2,h3,h4,h5,h6{font-family:maven pro,sans-serif}a{text-decoration:none;color:#5e00cf}.text-center{text-align:center}button,input[type=button]{cursor:pointer;transition:color .35s,background-color .35s,border-color .35s,box-shadow .35s,opacity .35s}.p-32{padding:32px}.py-80{padding:80px 0}.card{background-color:#fff;border-radius:12px}.shadow{box-shadow:0 0 12px 4px rgba(0,0,0,4%)}.v-center{display:flex;flex-direction:column;justify-content:center}.main.authentication{display:flex;align-items:center;justify-content:center;background-color:#e7e7e7;height:100vh;min-height:100vh}.main.authentication .card{width:400px;margin:0 auto;padding:60px 40px;min-height:520px}.main.authentication .card .logo{margin-bottom:24px}.main.authentication .card .logo img{max-width:212px}.main.authentication .card .title{margin-bottom:8px;font-size:24px;line-height:32px;font-weight:700}.main.authentication .card form{margin-top:56px}.main.authentication .card form input[type=text],.main.authentication .card form input[type=button]{padding:0 16px;min-height:44px;border-radius:4px;background-color:#e7e7e7;width:100%;border:0;margin-bottom:16px}.main.authentication .card form input[type=text]:hover,.main.authentication .card form input[type=text]:focus{outline-color:#5e00cf}.main.authentication .card form input[type=text]:focus{background-color:#fff}.main.authentication .card form input[type=button]{background-color:#5e00cf;color:#fff;width:100%;margin-bottom:0}.main.authentication .card form input[type=button]:hover,.main.authentication .card form input[type=button]:focus{outline:0;background-color:#430095}.main.authentication .card form p{color:#757a7e;font-size:14px}.main.authentication.verification .card{padding:80px 40px}.main.authentication.verification .card .logo{margin-bottom:56px}::-webkit-input-placeholder{color:#757a7e;font-weight:300}::-moz-placeholder{color:#757a7e;font-weight:300}:-ms-input-placeholder{color:#757a7e;font-weight:300}:-moz-placeholder{color:#757a7e;font-weight:300}svg{height:150px;width:150px}</style><div class="main authentication verification"><div class="card shadow text-center v-center"><div class="logo"><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 150 150"><defs><style>.cls-1{fill:#f8f8f8}.cls-2{fill:#5e00cf}.cls-3{fill:#5e00cf}.cls-4{fill:#5e00cf}</style></defs><g id="Layer_2" data-name="Layer 2"><g id="Layer_1-2" data-name="Layer 1"><rect class="cls-1" width="150" height="150" rx="30" /><path class="cls-2" d="M75 85.83a15.1 15.1.0 01-6.67-1.33v4.67H80v-4A18 18 0 0175 85.83z" /><path class="cls-3" d="M115 65c0-8.75-17.92-15.83-40-15.83S35 56.25 35 65a2.3 2.3.0 000 .37 3.54 3.54.0 000 .46V107.5a6.69 6.69.0 006.67 6.67h66.66A6.69 6.69.0 00115 107.5V65.83a3.54 3.54.0 000-.46A2.3 2.3.0 00115 65zM80 89.17H68.33V84.5A15.1 15.1.0 0075 85.83a18 18 0 005-.66z" /><path class="cls-1" d="M108.33 67.38V71L105 72.6l-6.67 3.28L74.73 87.5 51.67 76l-10-5V67.38A4.9 4.9.0 0145 62.75a4.62 4.62.0 011.55-.25h56.9a4.62 4.62.0 011.55.25A4.9 4.9.0 01108.33 67.38z" /><path class="cls-4" d="M93.17 35.83H56.83A11.86 11.86.0 0045 47.67v25L51.67 76 74.73 87.5l23.6-11.62L105 72.6V47.67A11.86 11.86.0 0093.17 35.83z" /><path class="cls-1" d="M98.33 46.42V75.88L74.73 87.5 51.67 76V46.42a3.93 3.93.0 013.91-3.92H94.42a3.93 3.93.0 013.91 3.92z" /><path class="cls-3" d="M80 85.17v4H68.33V84.5A15.1 15.1.0 0075 85.83 18 18 0 0080 85.17z" /><path class="cls-3" d="M74.39 48.05a13.5 13.5.0 1013.5 13.5 13.51 13.51.0 00-13.5-13.5zm7 9-8.7 10.36a1.06 1.06.0 01-.78.37h0a1 1 0 01-.77-.35l-3.74-4.15a1 1 0 011.52-1.43l2.94 3.27 7.95-9.48A1 1 0 0181.41 57z" /></g></g></svg></div><div class="title">Successfully verified</div><div class="subtitle">Please navigate back to the login page.</div></div></div>
Modified at 2024-07-22 14:31:50
Previous
Resend Email Magic Link
Next
Ping Status
Built with