Update an SSO connection

curl --request PATCH \
  --url https://api.onecli.sh/v1/org/sso/connections/{connectionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "enabled": true,
  "metadataUrl": "<string>",
  "metadataXml": "<string>",
  "issuer": "<string>",
  "clientId": "<string>",
  "clientSecret": "<string>"
}
'

import requests

url = "https://api.onecli.sh/v1/org/sso/connections/{connectionId}"

payload = {
    "displayName": "<string>",
    "enabled": True,
    "metadataUrl": "<string>",
    "metadataXml": "<string>",
    "issuer": "<string>",
    "clientId": "<string>",
    "clientSecret": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    displayName: '<string>',
    enabled: true,
    metadataUrl: '<string>',
    metadataXml: '<string>',
    issuer: '<string>',
    clientId: '<string>',
    clientSecret: '<string>'
  })
};

fetch('https://api.onecli.sh/v1/org/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.onecli.sh/v1/org/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([
    'displayName' => '<string>',
    'enabled' => true,
    'metadataUrl' => '<string>',
    'metadataXml' => '<string>',
    'issuer' => '<string>',
    'clientId' => '<string>',
    'clientSecret' => '<string>'
  ]),
  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://api.onecli.sh/v1/org/sso/connections/{connectionId}"

	payload := strings.NewReader("{\n  \"displayName\": \"<string>\",\n  \"enabled\": true,\n  \"metadataUrl\": \"<string>\",\n  \"metadataXml\": \"<string>\",\n  \"issuer\": \"<string>\",\n  \"clientId\": \"<string>\",\n  \"clientSecret\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.onecli.sh/v1/org/sso/connections/{connectionId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"<string>\",\n  \"enabled\": true,\n  \"metadataUrl\": \"<string>\",\n  \"metadataXml\": \"<string>\",\n  \"issuer\": \"<string>\",\n  \"clientId\": \"<string>\",\n  \"clientSecret\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/org/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["Content-Type"] = 'application/json'
request.body = "{\n  \"displayName\": \"<string>\",\n  \"enabled\": true,\n  \"metadataUrl\": \"<string>\",\n  \"metadataXml\": \"<string>\",\n  \"issuer\": \"<string>\",\n  \"clientId\": \"<string>\",\n  \"clientSecret\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "type": "saml",
  "status": "<string>",
  "displayName": "<string>",
  "cognitoProviderName": "<string>",
  "config": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

PATCH

org

sso

connections

{connectionId}

Update an SSO connection

curl --request PATCH \
  --url https://api.onecli.sh/v1/org/sso/connections/{connectionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "enabled": true,
  "metadataUrl": "<string>",
  "metadataXml": "<string>",
  "issuer": "<string>",
  "clientId": "<string>",
  "clientSecret": "<string>"
}
'

import requests

url = "https://api.onecli.sh/v1/org/sso/connections/{connectionId}"

payload = {
    "displayName": "<string>",
    "enabled": True,
    "metadataUrl": "<string>",
    "metadataXml": "<string>",
    "issuer": "<string>",
    "clientId": "<string>",
    "clientSecret": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    displayName: '<string>',
    enabled: true,
    metadataUrl: '<string>',
    metadataXml: '<string>',
    issuer: '<string>',
    clientId: '<string>',
    clientSecret: '<string>'
  })
};

fetch('https://api.onecli.sh/v1/org/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.onecli.sh/v1/org/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([
    'displayName' => '<string>',
    'enabled' => true,
    'metadataUrl' => '<string>',
    'metadataXml' => '<string>',
    'issuer' => '<string>',
    'clientId' => '<string>',
    'clientSecret' => '<string>'
  ]),
  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://api.onecli.sh/v1/org/sso/connections/{connectionId}"

	payload := strings.NewReader("{\n  \"displayName\": \"<string>\",\n  \"enabled\": true,\n  \"metadataUrl\": \"<string>\",\n  \"metadataXml\": \"<string>\",\n  \"issuer\": \"<string>\",\n  \"clientId\": \"<string>\",\n  \"clientSecret\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.onecli.sh/v1/org/sso/connections/{connectionId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"<string>\",\n  \"enabled\": true,\n  \"metadataUrl\": \"<string>\",\n  \"metadataXml\": \"<string>\",\n  \"issuer\": \"<string>\",\n  \"clientId\": \"<string>\",\n  \"clientSecret\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/org/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["Content-Type"] = 'application/json'
request.body = "{\n  \"displayName\": \"<string>\",\n  \"enabled\": true,\n  \"metadataUrl\": \"<string>\",\n  \"metadataXml\": \"<string>\",\n  \"issuer\": \"<string>\",\n  \"clientId\": \"<string>\",\n  \"clientSecret\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "type": "saml",
  "status": "<string>",
  "displayName": "<string>",
  "cognitoProviderName": "<string>",
  "config": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Changes an existing connection. Enabling is plan-gated on Cloud. Disabling never is. To switch between SAML and OIDC, delete and recreate. Related guide: User provisioning: SSO and SCIM. Rename, rotate credentials or metadata, or enable/disable. Enabling is plan-gated on Cloud; disabling never is. The type cannot change.

Availability: Cloud · Enterprise (self-hosted). Not available on the Community edition: a self-hosted deployment needs ENTERPRISE_ENABLED=true, otherwise the endpoint answers 403 with error.type: "enterprise_license_required".

Authorizations

Authorization

string

header

required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Path Parameters

connectionId

string

required

Body

application/json

displayName

string

Maximum string length: 100

enabled

boolean

metadataUrl

string<uri>

metadataXml

string

issuer

string<uri>

clientId

string

clientSecret

string

Response

The connection

Credentials never leave the server; config carries only the non-secret parts.

string

type

enum<string>

Available options:

saml,

oidc

status

string

pending until the first successful sign-in, then active; disabled when turned off.

displayName

string

cognitoProviderName

string

The identity-provider name the login page sends users to.

config

object | null

createdAt

string<date-time>

updatedAt

string<date-time>

Workspace

Organization

Enterprise

Platform

Update an SSO connection

Authorizations

Path Parameters

Body

Response