Sign in

v4

OpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB
Workspace API

Update SSO configuration

patch/workspaces/{workspace_domain}/sso

Path parameters

workspace_domainstring required
Example:my-company

The human-readable ID of the workspace

Request body

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_urlstring

The SSO URL / SAML endpoint / Identity provider Single sign-on URL. Set when type is SAML.

issuerstring

Issuer URI, IDP Entity ID, SSO issuer, provider issuer, AD identifier or the base URL of the OpenID Connect (OIDC) server.

certificatestring

The x509 certificate content. Set when type is SAML.

signature_methodstring

Set when type is SAML. Examples: sha1, sha256, sha512

digest_methodstring

Set when type is SAML. Examples: sha1, sha256, sha512

client_idstring

The client ID of the identity provider application.

client_secretstring

The client secret of the identity provider application.

require_sso_for_all_membersboolean

Require SSO authentication.

Response

urlstring

API endpoint to GET this object

html_urlstring

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_urlstring

The SSO URL / SAML endpoint / Identity provider Single sign-on URL. Set when type is SAML.

issuerstring

Issuer URI, IDP Entity ID, SSO issuer, provider issuer, AD identifier or the base URL of the OpenID Connect (OIDC) server.

certificatestring

The x509 certificate content. Set when type is SAML.

signature_methodstring

Set when type is SAML. Examples: sha1, sha256, sha512

digest_methodstring

Set when type is SAML. Examples: sha1, sha256, sha512

require_sso_for_all_membersboolean

Require SSO authentication.