1. Organization
  • 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 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
        POST
      • Get Organization
        GET
      • Get All Organization
        GET
      • Update Organization
        PUT
      • Delete Organization
        DELETE
      • GET Configuration By Client Id
        GET
      • GET Configuration By Custom Domain
        GET
  1. Organization

GET Configuration By Custom Domain

GET
https://api.ssojet.com/api/v1/config

GET Login Widget Configuration#

This endpoint makes an HTTP GET request to retrieve brandling information for Login widget based on the provided domain. The request should include the 'domain' parameter in the query string.

Request#

Method: GET
Endpoint: https://api.ssojet.com/api/v1/config
Query Parameters:
domain (string, required): The domain for which the configuration information is requested.

Response#

The response for this request is a JSON object representing the configuration information. Below is the JSON schema for the response:
{
    "id": "66854007e390034b3cf72549",
    "name": "ssojet-workspace",
    "client_id": "cli_cq2k021saqbs710j7ftg.edce2d27bcdf48189a1f795eda121a6a.uViYAx9kW4eV5DBYwYkSXT",
    "branding": {
        "branding_schema": "{\"fontStyle\":{\"fontFamily\":\"Arial\",\"fontSize\":\"16\",\"color\":\"#1f2937\",\"fontWeight\":\"normal\",\"fontStyle\":\"normal\",\"textDecoration\":\"underline\"},\"pageConfig\":{\"background\":\"#f9fafc\"},\"inputBox\":{\"text\":{\"color\":\"#1f2937\",\"placeholder\":\"#d1d5db\",\"fontSize\":\"16px\",\"background\":\"#ffffff\"},\"border\":{\"color\":\"#d1d5db\",\"radius\":4,\"width\":1},\"label\":{\"color\":\"#1f2937\",\"size\":\"16px\",\"fontSize\":\"12px\"},\"bgColor\":{\"color\":\"#ffffff\"}},\"socialConfig\":{\"position\":\"bottom\",\"fontSize\":\"11px\",\"fontWeight\":\"400\",\"color\":\"#6b7280\",\"background\":\"#ffffff\",\"borderColor\":\"#d1d5db\",\"borderWidth\":\"4px\"},\"colorConfig\":{\"primary\":\"#4a00ff\",\"secondary\":\"#9ca3af\",\"error\":\"#ff0000\"},\"imageConfig\":{\"logoUrl\":\"https://ssojet.com/dashboard/static/media/logo.b0f03dca.svg\",\"favicon\":\"https://ssojet.com/docs/favicon-32x32.png?v=198a5d5f5a1a7aaebde80634afeb6a3f\",\"brandName\":\"SSOJet\"},\"browserConfigdata\":{\"url\":\"\",\"pageTitle\":\"\"},\"loginBoxConfigData\":{\"backgroundImage\":\"modern\",\"background\":\"#ffffff\",\"borderRadius\":6},\"submitButtonConfigData\":{\"fontSize\":\"12\",\"color\":\"#ffffff\",\"background\":\"#6929c4\",\"borderColor\":\"#4a00ff\"}}",
        "admin_branding_schema": "",
        "brand": "SSOJet",
        "signature": "Team SSOJet",
        "btn_color": "#5e00cf",
        "text_color": "#000",
        "background_image": "",
        "login_box_color": "",
        "background": "#fff",
        "brand_logo": "https://ssojet.com/assets/images/logo.png",
        "favicon": "https://via.placeholder.com/50",
        "font": {
            "url": "https://fonts.googleapis.com/css2?family=Inter&display=swap",
            "family": "Inter"
        },
        "lang": "en",
        "white_label": false,
        "page_title": "",
        "background_style": null,
        "input_style": null,
        "social_button": null,
        "logo_style": null,
        "login_box_style": null,
        "page_submit_button_style": null
    },
    "connection": [
        {
            "provider": "MagicLink",
            "connection_id": "66854007e390034b3cf7254b",
            "is_sso_connection": false,
            "is_oauth_connection": false
        },
        {
            "provider": "MagicLink",
            "connection_id": "66854009e390034b3cf72553",
            "is_sso_connection": false,
            "is_oauth_connection": false
        }
    ],
    "default_redirect_url": "https://auth.ssojet.com",
    "auth_config": {
        "webauthn": false,
        "passkey_auth": false,
        "social": null
    },
    "localization": {
        "language": "English",
        "iso_code": "en",
        "direction": "ltr",
        "login": {
            "heading": "Welcome to ",
            "sub_heading": "Sign in or create a new account for free.",
            "footer": "by clicking login I agree with terms of use and privacy policy.",
            "or": "",
            "button": {
                "text": "Sign in without password"
            },
            "input": {
                "placeholder": "Enter Your Email Address",
                "label": "Email"
            },
            "phone_input": {
                "placeholder": "",
                "label": ""
            }
        },
        "magic_otp": {
            "title_text": "Login to",
            "phone_text": "Enter OTP sent to your phone number",
            "title": "Login to",
            "subtitle": "Hello,Please use the verification code",
            "button": {
                "text": "Submit",
                "resend": "Resend OTP",
                "resend_again": "Didn't receive OTP? Resend again in "
            },
            "error_text": ""
        },
        "webauthn_page": {
            "title_text": "",
            "sub_title_text": "",
            "sub_title_text_1": "",
            "sub_title_text_2": "",
            "button1": {
                "text": ""
            },
            "button2": {
                "text": ""
            }
        },
        "passkeys_page": {
            "title_text": "",
            "sub_title_text": "",
            "sub_title_text_1": "",
            "sub_title_text_2": "",
            "button1": {
                "text": ""
            },
            "button2": {
                "text": ""
            }
        },
        "email_magic": {
            "subjects": [
                "Verify your account - %s",
                "Login into your account - %s",
                "OTP to login into - %s",
                "Verification OTP for secure access - %s"
            ],
            "heading": "Login to",
            "sub_heading": "Hello,Please use the verification code",
            "button": {
                "text": ""
            },
            "Content": "",
            "content": ""
        },
        "email_forgot_password": {
            "subjects": null,
            "heading": "",
            "sub_heading": "",
            "button": {
                "text": ""
            },
            "Content": "",
            "content": ""
        },
        "email_otp": {
            "subjects": [
                "Verify your account - %s",
                "Login into your account - %s",
                "OTP to login into - %s",
                "Verification OTP for secure access - %s"
            ],
            "heading": "Login to",
            "sub_heading": "Hello,Please use the verification code",
            "content": ""
        },
        "verification": {
            "help_text": "Come back here after verifying your email.",
            "help_subtext": "Upon clicking the magic link received in your email, you will be logged in here.",
            "button": {
                "resend": "Resend Email",
                "resend_again": "Didn't receive Email? Resend again in "
            },
            "heading": "Check your mail",
            "sub_heading": "A verification link has been sent to your email address.",
            "warning": "",
            "default_error": ""
        },
        "verified": {
            "heading": "Successfully verified",
            "sub_heading": "Please navigate back to the login page."
        },
        "expired": {
            "heading": "Something went wrong",
            "sub_heading": "Your link has expired. Please request a new magic link. "
        },
        "sms_text": {
            "otp_msg": ""
        }
    },
    "languages_available": [
        {
            "en": "English"
        }
    ]
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
domain
string 
required
Domain Name is required parameter in this API
Example:
string
client_id
string 
required
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/config?domain=string&client_id=' \
--header 'User-Agent: SSOJET API' \
--header 'User-Agent;' \
--header 'Content-Type: application/json'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Modified at 2024-07-22 14:39:46
Previous
GET Configuration By Client Id
Built with