sFOX API
Sign InOpen Account
Connect API
Connect API
  • Introduction
    • Welcome
    • Getting Started
    • Resources
      • Terminology
      • Systems & Operations
      • Integration Options
    • Guides
      • End User Onboarding & KYC
        • Individuals
        • Businesses
        • Enhanced Due Diligence
  • REST API
    • REST Endpoints
    • Authentication
    • End Users
      • Create End User Account
      • Request Verification Code
      • Confirm Verification Code
      • Create User Auth Token(s)
      • Get End User(s)
      • Get EDD Requests
      • Get EDD Prompts
      • Create EDD Responses
        • Uploading Files as Responses
      • Submit Documents
      • Deactivate User
    • Payments
      • Create Bank Account (Plaid)
      • Create Bank Account
      • Get Bank Account
      • Get Plaid Processors
      • Amend Plaid Processors
      • Verify Bank Account
      • Delete Bank Account
      • Get Wire Instructions
      • Get ACH Agreement Status
      • Request ACH Onboarding
      • Get ACH Deposit Limit
    • Withdrawals
      • Confirm Withdrawal
      • Resend Confirmation Code
      • Cancel Withdrawal
    • Transfers
      • Create Transfer
      • Confirm Transfer
      • Resend Confirmation Code
      • Cancel Transfer
      • Get Transfer Permissions
      • Get Transfer History
    • Monetization
      • Create Setting
      • Update Setting
      • Delete Setting
      • Get Settings
      • Get Permissions
      • Get Monetization History
  • WebSocket API
    • Connecting
    • Authentication
    • Subscribing & Unsubscribing
    • Message Format
    • End Users
      • Onboarding
      • Balances
      • Orders
      • Trades
    • Market Data
      • Order Book
      • Trades
      • Ticker
  • Single Sign-On
    • Overview
      • IdP Initiated SSO
    • IdP Data
    • SAML Response Data
  • Errors
    • Error Codes
Powered by GitBook
On this page
  • Introduction
  • How it works
  1. Single Sign-On

Overview

SSO integrations enable partners to seamlessly authenticate users to sFOX and utilize sFOX's front end

PreviousTickerNextIdP Initiated SSO

Last updated 1 month ago

Introduction

sFOX Connect SSO enables you to:

  1. Onboard and authenticate your users to sFOX

  2. Interact with your users' sFOX accounts (i.e. trading, custody, staking, etc.)

  3. Leverage sFOX's front end application for your users as desired

sFOX Connect supports Identity Provider (IdP) initiated single sign-on (SSO)–a method of authentication that allows your users to log in to sFOX using a single set of credentials. You, the IdP, are responsible for providing the user's identity and providing the necessary authentication credentials to the sFOX application when your user wants to access it.

In an IdP-initiated SSO scenario, the user first logs in to your application (the IdP), which then sends an authentication request to the sFOX application on behalf of your user. sFOX then verifies that the authentication request originated from you and grants your user access without requiring the user to leave your application or enter their credentials again.

sFOX Connect SSO supports Security Assertion Markup Language (SAML) for exchanging authentication and authorization information between the your application (IdP) and sFOX.

How it works

SSO integrations involve using both an iframe and server side component to access the sFOX Connect APIs.

The sFOX Connect flow begins when your user wants to access sFOX's products and features in your app

Example SSO Authentication Screen