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

Add New Organization

POST
https://api.ssojet.com/api/v1/organization

Create a New Organization#

This endpoint allows you to create a new organization within the application by sending an HTTP POST request to the specified URL. You need to provide the necessary details for the organization in the request body, including the organization name, description, and other relevant information. Upon successful creation, the API returns the ID and details of the newly created organization.

Request#

Method: POST
URL: https://api.ssojet.com/api/v1/organization?client_id=string
Headers:
Content-Type: application/json

Request Body#

Type: JSON
{
    "Name":"string",
    "WhiteListDomain":"string array",
    "AllowProfilesOutsideOrganization":boolean
}

Response#

The response for this request is a JSON schema. Please refer to the API documentation for the JSON schema of the response.
    {
        "id": "66571f9edbf3b4061789ea5c",
        "name": "test",
        "WhiteListDomain":["example.com"],
        "allow_profiles_outside_organization": false,
        "sso_connection_token": "org_token_cpbhv7k2c46s715je8g0.6915cc022b494a499a4a21b65e6975a2.Jrj7KfKbkfC***********",
        "domain": "",
        "WorkspaceName": "",
        "is_active": true
    }
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
Content-Type
string 
required
Example:
application/json
User-Agent
string 
optional
Default:
SSOjet/1.0.0 (https://ssojet.com)
Body Params application/json
Name
string 
required
WhiteListDomains
array[string]
required
AllowProfilesOutsideOrganization
boolean 
required
Example
{
  "Name": "example_wrokspace",
  "WhiteListDomains": [
    "example.com"
  ],
  "AllowProfilesOutsideOrganization": true
}

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 POST 'https://api.ssojet.com/api/v1/organization?client_id=string&client_id=' \
--header 'User-Agent: SSOjet/1.0.0 (https://ssojet.com)' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Name":"example_wrokspace",
    "WhiteListDomains":["example.com"],
    "AllowProfilesOutsideOrganization":true
}'

Responses

🟢200Add New Organization
application/json
Body
id
string 
required
name
string 
required
WhiteListDomain
array[string]
required
allow_profiles_outside_organization
boolean 
required
sso_connection_token
string 
required
domain
string 
required
WorkspaceName
string 
required
is_active
boolean 
required
Example
{
  "id": "66571f9edbf3b4061789ea5c",
  "name": "test",
  "WhiteListDomain": [
    "example.com"
  ],
  "allow_profiles_outside_organization": false,
  "sso_connection_token": "org_token_cpbhv7k2c46s715je8g0.6915cc022b494a499a4a21b65e6975a2.Jrj7KfKbkfC***********",
  "domain": "",
  "WorkspaceName": "",
  "is_active": true
}
Modified at 2024-07-22 11:04:03
Previous
GET User Login Logs
Next
Get Organization
Built with