Ping Status

GET Magic Link Staus for Passwordless Authentication

This endpoint retrieves the status of the magic link authentication process.

Request

Method: GET

URL: http://api.ssojet.com/api/v1/auth/passwordless/magic-link/status

Query Parameters:

client_id (string)

state (string)

Response

authenticated (boolean): Indicates if the user is authenticated.

oauth (object): Contains OAuth token information.

access_token (string): The access token for OAuth.

refresh_token (string): The refresh token for OAuth.

expires_at (string): The expiry timestamp for the token.

token_type (string): The type of token.

user (object): Contains user information.

created_at (string): Timestamp of user creation.

updated_at (string): Timestamp of user information update.

issuer (string): The issuer of the user.

user_id (string): The user ID.

identifier (string): The user identifier.

email (string): The user's email address.

last_login_at (string): Timestamp of the user's last login.

Response Status Code

200 OK: Magic link sent successfully.

400 Bad Request: Invalid request.

500 Internal Server Error: An error occurred while processing the request.

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

Header Params

User-Agent

string

required

Example:

SSOJET API

Content-Type

string

optional

Default:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Response

application/json

Body

authenticated

boolean

required

oauth

object

required

access_token

string

required

refresh_token

string

required

expires_at

string

required

token_type

string

required

user

object

required

created_at

string

required

updated_at

string

required

issuer

string

required

user_id

string

required

identifier

string

required

string

required

last_login_at

string

required

Example

{
    "authenticated": true,
    "oauth": {
        "access_token": "v4.local.hclusuET9-zz9vi2Vq1H_kewUf9siJwK9BWBWba3MtOKnKoC-TkgDfK8AIzyTNUrWHXTPeChvnqkQRnnpwkQIhw7pDIdv6EavHayAesbv_2rRYSPVKyp_bpUJJg-yWB5UtNj-CdyA3iRLEj3j0UrSLg-lk9cHk8bEzk0_g0DM9IUXabKDjg14WVLFmyClu63AJUrXXIksuY3eMroWyQlJXZ0DBb7oyc4DTzcWRuQFTycoHnAIr9LmmqZi_FkTUhEOCtW0BFZGlPmK0i2dJE4KOVlfTt9h731JlfTfuheojY",
        "refresh_token": "v4.local.J6r4r9JbGYNoUNv4fLK-A8-zO75-MUqJLATIQ_vWdxb_vfK58sYb7nwrHrZhC71rHH2Z-c_vu-6tgqgzRdg_pR50VDpHhUVc_T9QyVhRUfsAbu8-3x-FG4TjxQ2hT3UI11k8CARFxWVuSv1iVUOizq5oUI5ZbbudqyYHVvzwa59ed1Q9_Z5Y9LDkhMASPDQS41nRUQOchsztTyQuPHZaY0IGnRkLwoPoAyg9fnifr7mVUlQ30kkXOR6MTet5V0wTZkGDx5GwQ_Mv7WBI9RAWWAYKDugKj33ugwbEGHaGQWw",
        "expires_at": "2023-05-18T12:28:22Z",
        "token_type": "Bearer"
    },
    "user": {
        "created_at": "2023-05-18T12:13:22.179Z",
        "updated_at": "2023-05-18T12:13:22.179Z",
        "issuer": "ssojet",
        "user_id": "64661662aadfbd0e2a83172a",
        "identifier": "active@mail7.io",
        "email": "active@mail7.io",
        "last_login_at": "2023-05-18T12:13:22.179Z"
    }
}

GET Magic Link Staus for Passwordless Authentication#

Request#

Response#

Request

Request samples

Responses

GET Magic Link Staus for Passwordless Authentication

Request

Response