> This page is for API Reference & Tools.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.moveworks.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.moveworks.com/_mcp/server.

# Update SSO connection

PATCH https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/{id}
Content-Type: application/json

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus `version` with the `num` from your last read and a `change_description`. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole. The `id` goes in the URL; if you also send `id` in the body it must match.

Reference: https://docs.moveworks.com/api-reference/configuration-api/platform-org/sso/update-sso-connection

## Authentication

- `Authorization` header (bearer token, required) — JWT bearer token authentication. Include the Configuration API key in the Authorization header as 'Bearer \<token>'.

## Request

### Path parameters

- `id` (string, required) — The `id` of the SSO connection, as returned when it was created or listed.

### Body (application/json)

This endpoint expects a SSOConfigPatch.

- `version` (SsoVersionPatch, required) — Document version. On update, send back the num from your last read.
- `connector_id` (string, optional) — Connector for your identity provider, such as Okta, Microsoft Entra ID or Ping. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
- `identifier_type` (string, optional) — Type of identifier used to match users at login: EMAIL_ADDR, ITSM_USER_ID or IDM_USER_ID.
- `user_attribute` (string, optional) — User attribute that uniquely identifies the user in the identity provider.
- `saml_config` (SamlConfigPatch, optional) — Settings for logging in with SAML.
- `oidc_config` (OIDCConfigPatch, optional) — Settings for logging in with OpenID Connect (OIDC).

## Response

### 200

The updated SSO connection, at its new version

- `id` (string, optional) — Unique identifier of the SSO configuration, assigned by the server.
- `product` (enum, optional) — Moveworks product this SSO configuration is for: my_moveworks or embedded_ai_assistant. Cannot be changed after creation.
  - Allowed values: `embedded_ai_assistant`, `my_moveworks`
- `connector_id` (string, optional) — Connector for your identity provider, such as Okta, Microsoft Entra ID or Ping. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
- `identifier_type` (string, optional) — Type of identifier used to match users at login: EMAIL_ADDR, ITSM_USER_ID or IDM_USER_ID.
- `user_attribute` (string, optional) — User attribute that uniquely identifies the user in the identity provider.
- `saml_config` (SamlConfig, optional) — Settings for logging in with SAML.
- `oidc_config` (OIDCConfig, optional) — Settings for logging in with OpenID Connect (OIDC).
- `updated_time` (datetime, optional) — When the configuration was last updated.
- `updated_by` (string, optional) — Who last updated the configuration.
- `version` (Version, optional) — Document version. On update, send back the num from your last read.

## Errors

### 400 Bad Request Error

Bad request - the body breaks a rule in the schema (a missing required field, an unknown enum value, an invalid DSL or Data Mapper expression), `version.change_description` is missing, or an id in the body doesn't match the URL

- `error` (ErrorResponseError, required)

### 401 Unauthorized Error

Unauthorized - the `Authorization` header is missing or the token is invalid

- `error` (ErrorResponseError, required)

### 403 Forbidden Error

Forbidden - the API key isn't allowed to change this configuration, or the configuration is frozen for your organization

- `error` (ErrorResponseError, required)

### 404 Not Found Error

Not found - no item with this `id` exists in your organization

- `error` (ErrorResponseError, required)

### 409 Conflict Error

Conflict - `version.num` doesn't match the stored version (someone changed it since your last read; read it again and retry), or the item already exists

- `error` (ErrorResponseError, required)

### 429 Too Many Requests Error

Too many requests - the organization exceeded the Configuration API rate limit. Back off and retry.

- `error` (ErrorResponseError, required)

### 500 Internal Server Error

Internal server error - retry the request

- `error` (ErrorResponseError, required)

## Types

### SsoVersionPatch

- `num` (integer, required) — Version number set by the server. On update, send the num from your last read; a stale num is rejected as a conflict.
- `change_description` (string, required) — A short note describing this change. Required on every create and update.

### SamlConfigPatch

- `url` (string, optional) — Identity provider sign-on (SSO) URL where users are redirected to authenticate.
- `issuer` (string, optional) — Identity provider issuer or entity ID that uniquely identifies the identity provider.
- `disable_authn_request` (boolean, optional) — If true, no SAML authentication request is sent. Set to true when the identity provider is Microsoft Graph.
- `public_cert` (string, optional) — Identity provider public certificate used to verify SAML responses. Secret: omit it, or send *****, to keep the stored value.
- `identifier_format` (string, optional) — SAML NameID format for the assertion subject: emailAddress, persistent, transient or unspecified. Leave unset unless your application requires a specific format.

### OIDCConfigPatch

- `redirect_uri` (string, optional) — Redirect (reply) URL users are sent back to after authenticating with the identity provider, for example https://my.moveworks.com/login/sso/oidc.
- `issuer` (string, optional) — Identity provider issuer URL. Must exactly match the issuer in the provider's OpenID configuration document and must not end with a slash.
- `client_id` (string, optional) — Client ID issued by your identity provider for the Moveworks application.
- `client_secret` (string, optional) — Client secret issued by your identity provider for the Moveworks application. Secret: omit it, or send *****, to keep the stored value.
- `refresh_auth_cookie` (boolean, optional) — If true, an already-authenticated user's token is refreshed instead of repeating the full OIDC authorization flow.
- `pkce_disabled` (boolean, optional) — If true, login does not use PKCE (Proof Key for Code Exchange). Not recommended for security reasons.
- `scopes` (list of string, optional) — Scopes requested during OIDC authentication. Defaults to openid, email and profile if none are specified.
- `debug_logging_enabled` (boolean, optional) — If true, Moveworks records verbose diagnostic logs for the SSO login flow. Enable only while troubleshooting login issues.

### SamlConfig

- `url` (string, optional) — Identity provider sign-on (SSO) URL where users are redirected to authenticate.
- `issuer` (string, optional) — Identity provider issuer or entity ID that uniquely identifies the identity provider.
- `disable_authn_request` (boolean, optional) — If true, no SAML authentication request is sent. Set to true when the identity provider is Microsoft Graph.
- `public_cert` (string, optional) — Identity provider public certificate used to verify SAML responses. Secret: always returned masked as *****.
- `identifier_format` (string, optional) — SAML NameID format for the assertion subject: emailAddress, persistent, transient or unspecified. Leave unset unless your application requires a specific format.

### OIDCConfig

- `redirect_uri` (string, optional) — Redirect (reply) URL users are sent back to after authenticating with the identity provider, for example https://my.moveworks.com/login/sso/oidc.
- `issuer` (string, optional) — Identity provider issuer URL. Must exactly match the issuer in the provider's OpenID configuration document and must not end with a slash.
- `client_id` (string, optional) — Client ID issued by your identity provider for the Moveworks application.
- `client_secret` (string, optional) — Client secret issued by your identity provider for the Moveworks application. Secret: always returned masked as *****.
- `refresh_auth_cookie` (boolean, optional) — If true, an already-authenticated user's token is refreshed instead of repeating the full OIDC authorization flow.
- `pkce_disabled` (boolean, optional) — If true, login does not use PKCE (Proof Key for Code Exchange). Not recommended for security reasons.
- `scopes` (list of string, optional) — Scopes requested during OIDC authentication. Defaults to openid, email and profile if none are specified.
- `debug_logging_enabled` (boolean, optional) — If true, Moveworks records verbose diagnostic logs for the SSO login flow. Enable only while troubleshooting login issues.

### Version

- `num` (integer, optional) — Version number set by the server. On update, send the num from your last read; a stale num is rejected as a conflict.
- `change_description` (string, optional) — A short note describing this change. Required on every create and update.

### ErrorResponseError

- `code` (string, optional) — A machine-readable error code.
- `message` (string, optional) — What went wrong, and for a rejected field, which rule it broke.

## Examples

### SSO endpoints_updateSsoConnection_example

**Response**

```json
{
  "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
  "product": "embedded_ai_assistant",
  "connector_id": "<connector-uuid>",
  "saml_config": {
    "url": "https://example.com/path",
    "issuer": "<string>",
    "disable_authn_request": true,
    "public_cert": "<PEM certificate>",
    "identifier_format": "emailAddress"
  },
  "updated_time": "2026-11-12T18:04:11Z",
  "updated_by": "admin@example.com",
  "version": {
    "num": 3,
    "change_description": "Update via the Configuration API"
  }
}
```

**SDK Code**

```python SSO endpoints_updateSsoConnection_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/id"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript SSO endpoints_updateSsoConnection_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/id';
const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go SSO endpoints_updateSsoConnection_example
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/id"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby SSO endpoints_updateSsoConnection_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/id")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'

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

```java SSO endpoints_updateSsoConnection_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php SSO endpoints_updateSsoConnection_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/id', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp SSO endpoints_updateSsoConnection_example
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift SSO endpoints_updateSsoConnection_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Change one field of a SSO connection

**Request**

```json
{
  "version": {
    "num": 2,
    "change_description": "Update via the Configuration API"
  }
}
```

**Response**

```json
{
  "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
  "product": "embedded_ai_assistant",
  "connector_id": "<connector-uuid>",
  "saml_config": {
    "url": "https://example.com/path",
    "issuer": "<string>",
    "disable_authn_request": true,
    "public_cert": "<PEM certificate>",
    "identifier_format": "emailAddress"
  },
  "updated_time": "2026-11-12T18:04:11Z",
  "updated_by": "admin@example.com",
  "version": {
    "num": 3,
    "change_description": "Update via the Configuration API"
  }
}
```

**SDK Code**

```python Change one field of a SSO connection
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/id"

payload = { "version": {
        "num": 2,
        "change_description": "Update via the Configuration API"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Change one field of a SSO connection
const url = 'https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"version":{"num":2,"change_description":"Update via the Configuration API"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Change one field of a SSO connection
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/id"

	payload := strings.NewReader("{\n  \"version\": {\n    \"num\": 2,\n    \"change_description\": \"Update via the Configuration API\"\n  }\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(res)
	fmt.Println(string(body))

}
```

```ruby Change one field of a SSO connection
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/id")

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  \"version\": {\n    \"num\": 2,\n    \"change_description\": \"Update via the Configuration API\"\n  }\n}"

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

```java Change one field of a SSO connection
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"version\": {\n    \"num\": 2,\n    \"change_description\": \"Update via the Configuration API\"\n  }\n}")
  .asString();
```

```php Change one field of a SSO connection
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/id', [
  'body' => '{
  "version": {
    "num": 2,
    "change_description": "Update via the Configuration API"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Change one field of a SSO connection
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"version\": {\n    \"num\": 2,\n    \"change_description\": \"Update via the Configuration API\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Change one field of a SSO connection
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["version": [
    "num": 2,
    "change_description": "Update via the Configuration API"
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/platform/sso-connections/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```