Skip to main content
PATCH
/
v1
/
sso_connections
/
{connectionId}
Update an SSO Connection
curl --request PATCH \
  --url https://api.us.lexful.app/v1/sso_connections/{connectionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-ID: <api-key>' \
  --data '
{
  "name": "<string>",
  "saml_config": {
    "acs_url": "<string>",
    "audience_uri": "<string>",
    "idp_entity_id": "<string>",
    "idp_sso_url": "<string>",
    "x509_certificate": "<string>",
    "attribute_mapping": {}
  },
  "oidc_config": {
    "redirect_url": "<string>",
    "client_id": "<string>",
    "client_secret": "<string>",
    "issuer": "<string>"
  }
}
'
import requests

url = "https://api.us.lexful.app/v1/sso_connections/{connectionId}"

payload = {
"name": "<string>",
"saml_config": {
"acs_url": "<string>",
"audience_uri": "<string>",
"idp_entity_id": "<string>",
"idp_sso_url": "<string>",
"x509_certificate": "<string>",
"attribute_mapping": {}
},
"oidc_config": {
"redirect_url": "<string>",
"client_id": "<string>",
"client_secret": "<string>",
"issuer": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"X-Account-ID": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Account-ID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
saml_config: {
acs_url: '<string>',
audience_uri: '<string>',
idp_entity_id: '<string>',
idp_sso_url: '<string>',
x509_certificate: '<string>',
attribute_mapping: {}
},
oidc_config: {
redirect_url: '<string>',
client_id: '<string>',
client_secret: '<string>',
issuer: '<string>'
}
})
};

fetch('https://api.us.lexful.app/v1/sso_connections/{connectionId}', 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://api.us.lexful.app/v1/sso_connections/{connectionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'saml_config' => [
'acs_url' => '<string>',
'audience_uri' => '<string>',
'idp_entity_id' => '<string>',
'idp_sso_url' => '<string>',
'x509_certificate' => '<string>',
'attribute_mapping' => [

]
],
'oidc_config' => [
'redirect_url' => '<string>',
'client_id' => '<string>',
'client_secret' => '<string>',
'issuer' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Account-ID: <api-key>"
],
]);

$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://api.us.lexful.app/v1/sso_connections/{connectionId}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"saml_config\": {\n \"acs_url\": \"<string>\",\n \"audience_uri\": \"<string>\",\n \"idp_entity_id\": \"<string>\",\n \"idp_sso_url\": \"<string>\",\n \"x509_certificate\": \"<string>\",\n \"attribute_mapping\": {}\n },\n \"oidc_config\": {\n \"redirect_url\": \"<string>\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"issuer\": \"<string>\"\n }\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Account-ID", "<api-key>")
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.patch("https://api.us.lexful.app/v1/sso_connections/{connectionId}")
.header("Authorization", "Bearer <token>")
.header("X-Account-ID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"saml_config\": {\n \"acs_url\": \"<string>\",\n \"audience_uri\": \"<string>\",\n \"idp_entity_id\": \"<string>\",\n \"idp_sso_url\": \"<string>\",\n \"x509_certificate\": \"<string>\",\n \"attribute_mapping\": {}\n },\n \"oidc_config\": {\n \"redirect_url\": \"<string>\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"issuer\": \"<string>\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.us.lexful.app/v1/sso_connections/{connectionId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Account-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"saml_config\": {\n \"acs_url\": \"<string>\",\n \"audience_uri\": \"<string>\",\n \"idp_entity_id\": \"<string>\",\n \"idp_sso_url\": \"<string>\",\n \"x509_certificate\": \"<string>\",\n \"attribute_mapping\": {}\n },\n \"oidc_config\": {\n \"redirect_url\": \"<string>\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"issuer\": \"<string>\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "connection_id": "<string>",
  "name": "<string>",
  "saml_config": {
    "acs_url": "<string>",
    "audience_uri": "<string>",
    "idp_entity_id": "<string>",
    "idp_sso_url": "<string>",
    "x509_certificate": "<string>",
    "attribute_mapping": {}
  },
  "oidc_config": {
    "redirect_url": "<string>",
    "client_id": "<string>",
    "client_secret": "<string>",
    "issuer": "<string>"
  }
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer token

X-Account-ID
string
header
required

Account ID

Path Parameters

connectionId
string
required

SSO connection ID

Body

application/json
name
string

Display name for the SSO connection

Required string length: 1 - 255
saml_config
object
oidc_config
object

Response

Default Response

connection_id
string
required

SSO connection unique identifier

type
enum<string>
required

SSO connection type (SAML or OIDC)

Available options:
saml,
oidc
status
enum<string>
required

SSO connection status

Available options:
active,
inactive,
pending
name
string

Name for the SSO connection

saml_config
object
oidc_config
object