API showdown
/
Train Travel API
/
Admin
/
Service Provider Configuration
/
Retrieve service provider config

ReachFive SCIM API (latest)

BETA RELEASE

A beta release is the first offering of the feature and may not be fully available to all customers. Contact your ReachFive representative for more details.

The SCIM protocol is an application-level REST protocol for provisioning and managing identity data on the web. It supports creating, discovering, retrieving, and modifying core identity resources.

Note: For more on SCIM, please see here.

For more ReachFive documentation.
Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://www.reachfive.com/contact-us

E-mail

documentation@reachfive.com

License

Apache 2.0

Terms of Service

Languages
Servers
Mock server

https://innovario.apishowdown.com/_mock/catalog/api-showdown/api-hub/admin/openapi/

Authentication

All SCIM endpoints require a token authentication.

You'll need to start the SCIM configuration from the ReachFive Console to obtain an API Key to use as bearer token.

See SCIM on the console

Service Provider Configuration

Describes the SCIM specification features available on service provider.

Operations

Retrieve service provider config

Request

This operation returns a JSON structure that describes the SCIM specification features available on a service provider.

The response is a JSON object using a "schemas" attribute of "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig".

Note: The attributes returned in the JSON object are defined in Section 5 of [RFC7643].

curl -i -X GET \
  https://innovario.apishowdown.com/_mock/catalog/api-showdown/api-hub/admin/openapi/scim/v2/ServiceProviderConfig \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful GET operation

Bodyapplication/json
documentationUristring

An HTTP-addressable URL pointing to the service provider's human-consumable help documentation.

Example: "http://example.com/help/scim.html"
patchobjectrequired

A complex type that specifies PATCH configuration options. See Section 3.5.2 of [RFC7644].

Example: {"supported":true}
patch.​supportedbooleanrequired

A Boolean value specifying whether or not the operation is supported.

Example: true
bulkobjectrequired

A complex type that specifies bulk configuration options. See Section 3.7 of [RFC7644].

Example: {"supported":true,"maxOperations":1000,"maxPayloadSize":1048576}
bulk.​supportedbooleanrequired

A Boolean value specifying whether or not the operation is supported.

Example: true
bulk.​maxOperationsintegerrequired

An integer value specifying the maximum number of operations.

Example: 1000
bulk.​maxPayloadSizeintegerrequired

An integer value specifying the maximum payload size in bytes.

Example: 1048576
filterobjectrequired

A complex type that specifies FILTER options. See Section 3.4.2.2 of [RFC7644].

Example: {"supported":true,"maxResults":200}
filter.​supportedbooleanrequired

A Boolean value specifying whether or not the operation is supported.

Example: true
filter.​maxResultsintegerrequired

An integer value specifying the maximum number of resources returned in a response.

Example: 200
changePasswordobjectrequired

A complex type that specifies configuration options related to changing a password.

Example: {"supported":true}
changePassword.​supportedbooleanrequired

A Boolean value specifying whether or not the operation is supported.

Example: true
sortobjectrequired

A complex type that specifies Sort configuration options.

Example: {"supported":true}
sort.​supportedbooleanrequired

A Boolean value specifying whether or not sorting is supported.

Example: true
etagobjectrequired

A complex type that specifies ETag configuration options.

Example: {"supported":true}
etag.​supportedbooleanrequired

A Boolean value specifying whether or not the operation is supported.

Example: true
authenticationSchemesArray of objectsrequired

A multi-valued complex type that specifies supported authentication scheme properties. To enable seamless discovery of configurations, the service provider SHOULD, with the appropriate security considerations, make the authenticationSchemes attribute publicly accessible without prior authentication.

Example: [{"name":"OAuth Bearer Token","description":"Authentication scheme using the OAuth Bearer Token Standard","specUri":"http://www.rfc-editor.org/info/rfc6750","documentationUri":"http://example.com/help/oauth.html","type":"oauthbearertoken","primary":true},{"name":"HTTP Basic","description":"Authentication scheme using the HTTP Basic Standard","specUri":"http://www.rfc-editor.org/info/rfc2617","documentationUri":"http://example.com/help/httpBasic.html","type":"httpbasic"}]
authenticationSchemes[].​typestringrequired

The authentication scheme. This specification defines the values "oauth", "oauth2", "oauthbearertoken", "httpbasic", and "httpdigest".

authenticationSchemes[].​namestringrequired

The common authentication scheme name, e.g., HTTP Basic.

authenticationSchemes[].​descriptionstringrequired

A description of the authentication scheme.

authenticationSchemes[].​specUristring

An HTTP-addressable URL pointing to the authentication scheme's specification.

authenticationSchemes[].​documentationUristring

An HTTP-addressable URL pointing to the authentication scheme's usage documentation.

resourceTypestring

The name of the resource type of the resource.

createdstring(date-time)

The "DateTime" that the resource was added to the service provider.

lastModifiedstring(date-time)

The most recent DateTime that the details of this resource were updated at the service provider.

locationstring

The URI of the resource being returned.

versionstring

The version of the resource being returned.

Response
application/json
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"
  ],
  "documentationUri": "http://example.com/help/scim.html",
  "patch": {
    "supported": true
  },
  "bulk": {
    "supported": true,
    "maxOperations": 1000,
    "maxPayloadSize": 1048576
  },
  "filter": {
    "supported": true,
    "maxResults": 200
  },
  "changePassword": {
    "supported": true
  },
  "sort": {
    "supported": true
  },
  "etag": {
    "supported": true
  },
  "authenticationSchemes": [
    { … },
    { … }
  ],
  "meta": {
    "location": "https://example.com/v2/ServiceProviderConfig",
    "resourceType": "ServiceProviderConfig",
    "created": "2010-01-23T04:56:22Z",
    "lastModified": "2011-05-13T04:42:34Z"
  }
}

Resource Types

Discover the types of resources available on SCIM service provider (e.g., Users and Groups).

Operations

Schemas

Retrieve information about resource schemas supported by a SCIM service provider.

Operations

Users

Retrieve, add, modify Users.

Operations

Groups

Retrieve, add, modify Groups.

Operations

Bulk operations

Bulk updates to one or more resources.

Operations