1. User Management
  • 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
        • Resend Email Magic Link
        • Verify Magic Link
        • Ping Status
      • 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
    • 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
      • GET User By User Id
        GET
      • GET User by User Email Address
        GET
      • Create a User
        POST
      • Update User by User Id
        PUT
      • Verify User Status By User Id
        POST
      • Delete User By User Id
        DELETE
      • Manage User Roles
        PUT
      • GET Users Organizations
        GET
      • GET User Login Logs
        GET
    • Organization
      • Add New Organization
      • Get Organization
      • Get All Organization
      • Update Organization
      • Delete Organization
      • GET Configuration By Client Id
      • GET Configuration By Custom Domain
  1. User Management

Verify User Status By User Id

POST
https://api.ssojet.com/api/v1/users/{{userId}}/verify

Verify User Status By User Id#

This API endpoint is used to verify a user by updating the user verification status to the specified URL.

Request#

Method: POST
URL: https://api.ssojet.com/api/v1/users/{{userId}}/verify?client_id=string
Headers:
Content-Type: application/json

Request Body#

Type: JSON
Description: Payload for verifying the user.
Attributes:
vefification_status (string, required): The verification status of the user.

Response#

The response for this request is a JSON schema. Please refer to the API documentation for the JSON schema of the response.
Response Status Code
200 OK: Magic link sent successfully.
400 Bad Request: Invalid email format.
500 Internal Server Error: An error occurred while processing the request.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
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
Header Params
accept
string 
required
Example:
*/*
accept-language
string 
required
Example:
en-US,en;q=0.9
content-type
string 
required
Example:
application/json
user-agent
string 
required
Example:
SSOJET API
Content-Type
string 
optional
Default:
application/json
User-Agent
string 
optional
Default:
SSOjet/1.0.0 (https://ssojet.com)
Body Params application/json
verification_status
string 
required
Example
{
  "verification_status": "true/false"
}

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 -g --request POST 'https://api.ssojet.com/api/v1/users/{{userId}}/verify?client_id=string&client_id=' \
--header 'accept: */*' \
--header 'accept-language: en-US,en;q=0.9' \
--header 'user-agent: SSOJET API' \
--header 'User-Agent: SSOjet/1.0.0 (https://ssojet.com)' \
--header 'Content-Type: application/json' \
--data-raw '{
    "verification_status":"true/false"
}'

Responses

⚪0Verify User Status By User Id
application/json
Body
_id
string 
required
account_id
string 
required
connection_id
string 
required
email
string 
required
first_name
string 
required
last_name
string 
required
groups
null 
required
raw_attributes
null 
required
roles
null 
required
passkey_credential
null 
required
phone_id
string 
required
created_at
string 
required
modified_at
string 
required
email_verified
boolean 
required
is_active
boolean 
required
LastLoginAt
null 
required
tenants
null 
required
identities
null 
required
Example
{
  "_id": "6694c133565dfee5166d1cbb",
  "account_id": "668e7e5946b448ab754b44a5",
  "connection_id": "668e7e5946b448ab754b44a6",
  "email": "user@example.com",
  "first_name": "Test1",
  "last_name": "Test1",
  "groups": null,
  "raw_attributes": null,
  "roles": null,
  "passkey_credential": null,
  "phone_id": "",
  "created_at": "2024-07-15T06:26:59.006484498Z",
  "modified_at": "2024-07-15T06:26:59.006484498Z",
  "email_verified": false,
  "is_active": true,
  "LastLoginAt": null,
  "tenants": null,
  "identities": null
}
Modified at 2024-07-22 11:04:03
Previous
Update User by User Id
Next
Delete User By User Id
Built with