Create the SSO Configuration

Creates the SSO Configuration for the company.

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage company resources (company_admin)	-	Manage SSO (sso_configuration:write)

post/v1/sso-configuration

Request

Base URL: https://gateway.remote.com
URL: https://gateway.remote.com/v1/sso-configuration
Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, sso_configuration:write, company_admin, all:write)

Request body

certificatestring binary required

The SAML signing certificate from your identity provider, base64-encoded.

domainstring required

The email domain(s) to route through SSO (e.g., "example.com").

identity_provider_urlstring required

The URL of the SAML identity provider login endpoint.

Example request

{
  "certificate": "c29tZSBjZXJ0aWZpY2F0ZSBleGFtcGxl...",
  "domain": "example.com",
  "identity_provider_url": "example.provider.com"
}

Response

Created

Example response

{
  "data": {
    "audience_uri": "urn:auth:remote-sso:89c4fbb2-some-id-8e4b-280f8795bbd8",
    "certificate": "c29tZSBjZXJ0aWZpY2F0ZSBleGFtcGxl...",
    "domain": "example.com",
    "identity_provider_url": "example.provider.com",
    "sso_url": "https://remote-sso.com/login/callback?connection=89c4fbb2-some-id-8e4b-280f8795bbd8"
  }
}

Changes

No recorded changes to this operation across all 65 revisions of this API.