Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Remote SSO Configuration API

The SSO Configuration API from Remote — 2 operation(s) for sso configuration.

Remote SSO Configuration API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SSO Configuration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 2 paths, and defines 15 schemas. It is described by OpenAPI 3.0.0, at version 0.1.0.

Requests are made against 2 base URLs: https://gateway.remote.com/, https://gateway.remote-sandbox.com/.

3 operations 2 paths 15 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1.0
Base URL
https://gateway.remote.com/v1/
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 7

Remote SSO Configuration API declares 7 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (ClientToken). It accepts HTTP bearer tokens (CustomerAPIToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 77 scopes. It supports OAuth 2.0 (OAuth2Assertion) using the clientCredentials flow, exposing 21 scopes. It supports OAuth 2.0 (OAuth2AuthorizationCode) using the authorizationCode flow, exposing 73 scopes. It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 18 scopes. By default, every request must be authenticated.

  • BasicAuth — Authenticate using the basic authentication for partners. Use the CLIENTID as login and CLIENTSECRET as password.
  • ClientToken — Authenticate a partner using only the the provided clienttoken. This authentication method only allows accessing marketing endpoints.
  • CustomerAPIToken — Authenticate using API Key generated by the customer in their Integration Settings page.
  • OAuth2 — Authenticate using OAuth 2.0 protocol.
  • OAuth2Assertion — Authenticate as the employee using the urn:ietf:params:oauth:grant-type:jwt-bearer grant in the OAuth2 protocol.
  • OAuth2AuthorizationCode — Authenticate as the token authorizer using authorizationcode / refreshtoken grants in the OAuth 2.0 protocol.
  • OAuth2ClientCredentials — Authenticate using clientcredentials grant in the OAuth 2.0 protocol.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

SSO Configuration 3
GET
/v1/sso-configuration/details
Show the SSO Configuration Details
get_v1_sso-configuration_details → 200400401404429
GET
/v1/sso-configuration
Show the current SSO Configuration
get_v1_sso-configuration → 200400401404429
POST
/v1/sso-configuration
Create the SSO Configuration
post_v1_sso-configuration body → 201400401404409422429

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are CreateSSOConfigurationResult (5 properties), SSOConfiguration (4 properties), ParameterError (3 properties), CreateSSOConfigurationParams (3 properties). Each schema is shown below with its type and property counts.

ParameterError
object
3 properties 3 required
UnauthorizedResponse
object
Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorizati…
1 property 1 required
SSOConfiguration
object
A complete SSO configuration for a company, including both Remote-generated values (ssourl, audienceuri) and company-provided values (domain, identityprovideru…
4 properties 4 required
SSOConfigurationDetailsResponse
object
SSO Configuration Details response
1 property
CreateSSOConfigurationParams
object
Parameters for setting up SAML SSO for a company. Requires the email domain, identity provider URL, and the IdP's SAML signing certificate.
3 properties 3 required
UnprocessableEntityResponse
object
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
SSOConfigurationResponse
object
SSO Configuration response
1 property
SSOConfigurationDetails
object
The SSO configuration details needed to set up your identity provider (IdP) to connect with Remote.
2 properties 2 required
BadRequestResponse
object
Returned when the request is malformed or contains invalid parameters. The message may be a simple string or a structured object with a code and detailed messa…
CreateSSOConfigurationResult
object
5 properties 5 required
TooManyRequestsResponse
object
Returned when the API rate limit has been exceeded (HTTP 429). Wait before retrying. Check the Retry-After response header for the recommended wait time.
1 property
CreateSSOConfigurationResponse
object
1 property 1 required
ConflictResponse
object
Returned when the request conflicts with the current state of a resource (HTTP 409). For example, trying to create a resource that already exists or performing…
1 property
ActionError
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-sso-configuration-api-openapi.yml Raw ↑

Other APIs Remote publishes across the network.

Remote Address Details API
Remote Administrative Details API
Remote Background Checks API
Remote Bank Account Details API
Remote Basic Information API
Remote Benefit Offers API
Remote Benefit Offers By Employment API
Remote Benefit Renewals API
Remote Benefits API
Remote Billing Address Details API
Remote Billing API
Remote Billing Documents API