Update SSO

  • PATCH
  • /workspaces
  • /:domain
  • /sso

Updates SSO in the workspace.

Request

REQUIRED SCOPES
WORKSPACE
url PARAMETERS
domainrequired string
The workspace domain.
POST PARAMETERS
typeoptional string
The type of the SSO to be set. Available values SAML, OIDC.
sso_urloptional string
The SSO URL / SAML endpoint / Identity provider Single sign-on URL. Set when type is SAML.
issueroptional string
Issuer URI, IDP Entity ID, SSO issuer, provider issuer, AD identifier or the base URL of the OpenID Connect (OIDC) server.
certificateoptional string
The x509 certificate content. Set when type is SAML.
signature_methodoptional string
Available values are sha1, sha256, sha512. Set when type is SAML.
digest_methodoptional string
Available values are sha1, sha256, sha512. Set when type is SAML.
require_sso_for_all_membersoptional boolean
Require SSO authentication.
client_idoptional string
The client ID of the identity provider application.
client_secretoptional string
The client secret of the identity provider application.

Last modified on Sep 23, 2024

{
  "sso_url": "https://login.microsoftonline.com/bbe6af31-7a4f-4c88-b180-ed18ab154b24/saml2",
  "issuer": "https://sts.windows.net/bcde6af31-7a4f-4c88-b180-ed18ab054b44/",
  "certificate": "-----BEGIN CERTIFICATE-----\r\nMIIC8DXCAdigAwIBAgIQKk9e1LkXXX/rMC+MrqGciiXILL\r\nxbLtT2E+SdHXgxKMXsq/\r\n-----END CERTIFICATE-----\r\n",
  "signature_method": "sha256",
  "digest_method": "sha256",
  "require_sso_for_all_members": false
}