Create SSO provider configuration for organization

Creates a new SSO provider configuration for the specified organization.

POST /organizations/{organizationId}/ssoProvider

Create SSO provider configuration for organization

cURL

curl --request POST \
  --url https://app.dynamicauth.com/api/v0/organizations/{organizationId}/ssoProvider \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientId": "<string>",
  "clientSecret": "<string>",
  "ssoDomain": "<string>",
  "emailDomain": "<string>",
  "provider": "okta"
}
'

import requests

url = "https://app.dynamicauth.com/api/v0/organizations/{organizationId}/ssoProvider"

payload = {
    "clientId": "<string>",
    "clientSecret": "<string>",
    "ssoDomain": "<string>",
    "emailDomain": "<string>",
    "provider": "okta"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    clientId: '<string>',
    clientSecret: '<string>',
    ssoDomain: '<string>',
    emailDomain: '<string>',
    provider: 'okta'
  })
};

fetch('https://app.dynamicauth.com/api/v0/organizations/{organizationId}/ssoProvider', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.dynamicauth.com/api/v0/organizations/{organizationId}/ssoProvider",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'clientId' => '<string>',
    'clientSecret' => '<string>',
    'ssoDomain' => '<string>',
    'emailDomain' => '<string>',
    'provider' => 'okta'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.dynamicauth.com/api/v0/organizations/{organizationId}/ssoProvider"

	payload := strings.NewReader("{\n  \"clientId\": \"<string>\",\n  \"clientSecret\": \"<string>\",\n  \"ssoDomain\": \"<string>\",\n  \"emailDomain\": \"<string>\",\n  \"provider\": \"okta\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.dynamicauth.com/api/v0/organizations/{organizationId}/ssoProvider")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clientId\": \"<string>\",\n  \"clientSecret\": \"<string>\",\n  \"ssoDomain\": \"<string>\",\n  \"emailDomain\": \"<string>\",\n  \"provider\": \"okta\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dynamicauth.com/api/v0/organizations/{organizationId}/ssoProvider")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"clientId\": \"<string>\",\n  \"clientSecret\": \"<string>\",\n  \"ssoDomain\": \"<string>\",\n  \"emailDomain\": \"<string>\",\n  \"provider\": \"okta\"\n}"

response = http.request(request)
puts response.read_body

201

{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "clientId": "<string>",
  "maskedClientSecret": "<string>",
  "organizationId": "95b11417-f18f-457f-8804-68e361f9164f",
  "ssoDomain": "<string>",
  "emailDomain": "<string>",
  "provider": "okta",
  "enforceOnlySSO": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "redirectUrl": "<string>",
  "ssoDomainVerifiedAt": "2023-11-07T05:31:56Z",
  "ssoDomainVerificationChallenge": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "No jwt provided!"
}

{
  "error": "Access Forbidden"
}

{
  "error": "Resources already exists for this Object",
  "payload": {
    "email": "[e-mail]",
    "embeddedWalletName": "<string>",
    "mergeConflicts": {
      "fromUser": {
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
        "verifiedCredentials": [
          {
            "id": "95b11417-f18f-457f-8804-68e361f9164f",
            "signInEnabled": true,
            "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
            "chain": "<string>",
            "refId": "95b11417-f18f-457f-8804-68e361f9164f",
            "signerRefId": "95b11417-f18f-457f-8804-68e361f9164f",
            "email": "[e-mail]",
            "name_service": {
              "avatar": "<string>",
              "name": "<string>"
            },
            "public_identifier": "<string>",
            "wallet_name": "<string>",
            "wallet_properties": {
              "turnkeySubOrganizationId": "95b11417-f18f-457f-8804-68e361f9164f",
              "turnkeyPrivateKeyId": "95b11417-f18f-457f-8804-68e361f9164f",
              "turnkeyHDWalletId": "95b11417-f18f-457f-8804-68e361f9164f",
              "isAuthenticatorAttached": true,
              "turnkeyUserId": "95b11417-f18f-457f-8804-68e361f9164f",
              "isSessionKeyCompatible": true
            },
            "oauth_username": "<string>",
            "oauth_display_name": "<string>",
            "oauth_account_id": "<string>",
            "phoneNumber": "9171113333",
            "phoneCountryCode": "1",
            "isoCountryCode": "US",
            "oauth_account_photos": [
              "<string>"
            ],
            "oauth_emails": [
              "<string>"
            ],
            "oauth_metadata": {},
            "previous_users": [
              "95b11417-f18f-457f-8804-68e361f9164f"
            ],
            "embedded_wallet_id": "<string>",
            "wallet_additional_addresses": [
              {
                "address": "<string>",
                "publicKey": "<string>"
              }
            ],
            "lastSelectedAt": "2023-11-07T05:31:56Z",
            "verifiedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "lastVerifiedCredentialId": "95b11417-f18f-457f-8804-68e361f9164f",
        "sessionId": "95b11417-f18f-457f-8804-68e361f9164f",
        "alias": "An example name",
        "country": "US",
        "email": "[e-mail]",
        "firstName": "An example name",
        "jobTitle": "An example name",
        "lastName": "An example name",
        "phoneNumber": "<string>",
        "policiesConsent": true,
        "tShirtSize": "An example name",
        "team": "An example name",
        "username": "An example name",
        "firstVisit": "2023-11-07T05:31:56Z",
        "lastVisit": "2023-11-07T05:31:56Z",
        "newUser": true,
        "metadata": {},
        "btcWallet": "<string>",
        "kdaWallet": "<string>",
        "ltcWallet": "<string>",
        "ckbWallet": "<string>",
        "kasWallet": "<string>",
        "dogeWallet": "<string>",
        "emailNotification": true,
        "discordNotification": true,
        "newsletterNotification": true,
        "lists": [
          "<string>"
        ],
        "scope": "superuser marketing operations",
        "missingFields": [
          {
            "name": "<string>",
            "required": true,
            "enabled": true,
            "unique": true,
            "verify": true,
            "validationRules": {
              "unique": true,
              "regex": "^0x",
              "validOptions": [
                {
                  "label": "small"
                },
                {
                  "label": "medium"
                },
                {
                  "label": "large"
                }
              ],
              "checkboxText": "Agree to the terms and conditions"
            },
            "label": "<string>",
            "position": 123
          }
        ]
      },
      "conflicts": [
        {
          "field": {
            "name": "<string>",
            "required": true,
            "enabled": true,
            "unique": true,
            "verify": true,
            "validationRules": {
              "unique": true,
              "regex": "^0x",
              "validOptions": [
                {
                  "label": "small"
                },
                {
                  "label": "medium"
                },
                {
                  "label": "large"
                }
              ],
              "checkboxText": "Agree to the terms and conditions"
            },
            "label": "<string>",
            "position": 123
          },
          "fromUser": {
            "userId": "95b11417-f18f-457f-8804-68e361f9164f",
            "value": "An example name"
          },
          "currentUser": {
            "userId": "95b11417-f18f-457f-8804-68e361f9164f",
            "value": "An example name"
          }
        }
      ]
    },
    "additionalMessages": [
      "<string>"
    ]
  }
}

{
  "error": "Internal Server Error"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId · string · required

ID of organization

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

clientId · string · required

Client ID for the SSO provider

Maximum string length: 255

clientSecret · string · required

Client secret for the SSO provider

Maximum string length: 255

ssoDomain · string · required

SSO domain for the provider

Maximum string length: 255

emailDomain · string · required

Email domain for the company emails to be used for SSO

Maximum string length: 255

provider · enum<string> · required

Available options: okta

Response

201

application/json

Successfully created SSO provider configuration

id · string · required

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

clientId · string · required

Client ID for the SSO provider

maskedClientSecret · string · required

Masked client secret for the SSO provider

organizationId · string · required

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

ssoDomain · string · required

SSO domain for the provider

emailDomain · string · required

Email domain for the company emails to be used for SSO

provider · enum<string> · required

Available options: okta

enforceOnlySSO · boolean · required

Whether SSO is enforced for this domain

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

redirectUrl · string

Redirect URL for the SSO provider

ssoDomainVerifiedAt · string<date-time>

Timestamp when the SSO domain was verified by Dynamic API. This will be present when the SSO domain ownership has been verified by setting a TXT record in DNS.

ssoDomainVerificationChallenge · string

TXT record challenge string for the SSO domain verification. This will be provided when the SSO provider domain ownership needs to be verified by setting a TXT record in DNS.