Skip to content

SSOService

Manages SSO (Single Sign-On) provider configuration for enterprise identity federation via SAML 2.0.

MethodDescription
CheckSSOByDomainCheck if a domain has SSO configured
CreateSSOProviderCreate a new SSO provider
GetSSOProviderGet SSO provider details
DeleteSSOProviderDelete an SSO provider

Check if a given email domain has an SSO provider configured. Used during the login flow to redirect users to their IdP.

Authorization: Public (no authentication required)

FieldTypeDescription
domainstringEmail domain to check (e.g., company.com).
FieldTypeDescription
has_ssoboolWhether SSO is configured for this domain.
provider_namestringSSO provider name (if configured).

TypeScript (Connect-Web)

const response = await ssoClient.checkSSOByDomain({
domain: "company.com",
});
if (response.hasSso) {
// Redirect to SSO login flow
}

Go (gRPC)

resp, err := ssoClient.CheckSSOByDomain(ctx, &pidgrv1.CheckSSOByDomainRequest{
Domain: "company.com",
})
if resp.HasSso {
// Redirect to SSO login flow
}

Create a new SSO provider for the organization.

Authorization: Requires MANAGE_SSO permission

FieldTypeDescription
namestringProvider name. Max 200 characters.
typeSSOProviderTypeProvider type (SAML).
domainstringEmail domain for routing.
metadata_urlstringSAML metadata URL. Max 2048 characters.
metadata_xmlstringSAML metadata XML (alternative to URL).
attribute_mappingsSSOAttributeMapping[]Attribute mappings.
FieldTypeDescription
providerSSOProviderThe created SSO provider.

Get SSO provider details for the organization.

Authorization: Requires VIEW_SSO permission

Empty request. Returns the organization’s SSO provider.

FieldTypeDescription
providerSSOProviderThe SSO provider.

Delete the organization’s SSO provider. Users will fall back to passkey/email OTP authentication.

Authorization: Requires MANAGE_SSO permission

Empty request.

Empty response on success.

FieldTypeDescription
idstringUnique identifier.
namestringProvider name.
typeSSOProviderTypeProvider type.
domainstringEmail domain.
metadata_urlstringSAML metadata URL.
attribute_mappingsSSOAttributeMapping[]Attribute mappings.
created_atTimestampCreation timestamp.
FieldTypeDescription
saml_attributestringSAML assertion attribute name.
pidgr_fieldstringPidgr user profile field to map to.
ValueDescription
SAMLSAML 2.0 identity provider