---
title: "Update SSO configuration"
method: PATCH
path: "/workspaces/{workspace_domain}/sso"
tags: ["Workspace API"]
---

# Update SSO configuration

`PATCH /workspaces/{workspace_domain}/sso`

## Path parameters

- `workspace_domain` string, required

## Request body

- UpdateSSORequest
  - `type` 'SAML' | 'OIDC' — The type of the SSO to be set
  - `sso_provider_type` 'OKTA' | 'ONE_LOGIN' | 'GOOGLE' | 'AZURE' | 'AWS' | 'CUSTOM' — The provider type for SSO configuration
  - `sso_url` string — The SSO URL / SAML endpoint / Identity provider Single sign-on URL. Set when type is `SAML`.
  - `issuer` string — Issuer URI, IDP Entity ID, SSO issuer, provider issuer, AD identifier or the base URL of the OpenID Connect (OIDC) server.
  - `certificate` string — The x509 certificate content. Set when type is `SAML`.
  - `signature_method` string — Set when type is `SAML`. Examples: `sha1`, `sha256`, `sha512`
  - `digest_method` string — Set when type is `SAML`. Examples: `sha1`, `sha256`, `sha512`
  - `client_id` string — The client ID of the identity provider application.
  - `client_secret` string — The client secret of the identity provider application.
  - `require_sso_for_all_members` boolean — Require SSO authentication.

## Response `200`

- SSOView
  - `url` string — API endpoint to GET this object
  - `html_url` string — Web URL to view this object in Buddy.works
  - `type` 'SAML' | 'OIDC' — The type of the SSO to be set
  - `sso_provider_type` 'OKTA' | 'ONE_LOGIN' | 'GOOGLE' | 'AZURE' | 'AWS' | 'CUSTOM' — The provider type for SSO configuration
  - `sso_url` string — The SSO URL / SAML endpoint / Identity provider Single sign-on URL. Set when type is `SAML`.
  - `issuer` string — Issuer URI, IDP Entity ID, SSO issuer, provider issuer, AD identifier or the base URL of the OpenID Connect (OIDC) server.
  - `certificate` string — The x509 certificate content. Set when type is `SAML`.
  - `signature_method` string — Set when type is `SAML`. Examples: `sha1`, `sha256`, `sha512`
  - `digest_method` string — Set when type is `SAML`. Examples: `sha1`, `sha256`, `sha512`
  - `require_sso_for_all_members` boolean — Require SSO authentication.

---

[API](https://skmtc.net/buddy/apis/buddy-api.md) · [All operations](https://skmtc.net/buddy/apis/buddy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/buddy/buddy-api/versions/2426d67c249a/schema)
