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 SCIM API

The SCIM API from Remote — 4 operation(s) for scim.

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

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

This API exposes 4 operations across 4 paths, and defines 5 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/.

4 operations 4 paths 5 schemas 4 GET

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 SCIM 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 4

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

SCIM 4
GET
/v1/scim/v2/Users/{id}
Get user by ID via SCIM v2.0
get_v1_scim_v2_Users_id 1 param → 200401403404
GET
/v1/scim/v2/Users
List users via SCIM v2.0
get_v1_scim_v2_Users 3 params → 200400401403404
GET
/v1/scim/v2/Groups
List groups via SCIM v2.0
get_v1_scim_v2_Groups 3 params → 200400401403404
GET
/v1/scim/v2/Groups/{id}
Get group by ID via SCIM v2.0
get_v1_scim_v2_Groups_id 1 param → 200401403404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Integrations.Scim.User (10 properties), Integrations.Scim.UserListResponse (5 properties), Integrations.Scim.Group (5 properties), Integrations.Scim.GroupListResponse (5 properties). Each schema is shown below with its type and property counts.

Integrations.Scim.GroupListResponse
object
5 properties 5 required
Integrations.Scim.ErrorResponse
object
4 properties 3 required
Integrations.Scim.Group
object
5 properties 4 required
Integrations.Scim.User
object
10 properties 6 required
Integrations.Scim.UserListResponse
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-scim-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