API showdown
/
Train Travel API
/
Admin
/
Resource Types

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

Resource Types

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

Operations

Retrieve resource types

Request

This operation is used to discover the types of resources available on a SCIM service provider (e.g., Users and Groups). Each resource type defines the endpoints, the core schema URI that defines the resource, and any supported schema extensions.

Note: The attributes defining a resource type can be found in Section 6 of [RFC7643]

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

Responses

Successful GET operation

Bodyapplication/jsonArray [
schemasArray of stringsrequired
idstring

The resource type's server unique id.

namestringrequired

The resource type name.

descriptionstring

The resource type's human-readable description.

endpointstringrequired

The resource type's HTTP-addressable endpoint relative to the Base URL of the service provider.

schemastringrequired

The resource type's primary/base schema URI

schemaExtensionsArray of objects(SchemaExtension)
]
Response
application/json
[
  {
    "schemas": [ … ],
    "id": "User",
    "name": "User",
    "endpoint": "/Users",
    "description": "User Account",
    "schema": "urn:ietf:params:scim:schemas:core:2.0:User",
    "schemaExtensions": [ … ],
    "meta": { … }
  },
  {
    "schemas": [ … ],
    "id": "Group",
    "name": "Group",
    "endpoint": "/Groups",
    "description": "Group",
    "schema": "urn:ietf:params:scim:schemas:core:2.0:Group",
    "meta": { … }
  }
]

Retrieve resource type by name

Request

This operation is used to retireve an individual resource by his name (e.g., User and Group).

Path
namestringrequired

The name of the resource type.

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

Responses

Successful GET operation

Bodyapplication/json
schemasArray of stringsrequired
Example: ["urn:ietf:params:scim:schemas:core:2.0:ResourceType"]
idstring

The resource type's server unique id.

Example: "User"
namestringrequired

The resource type name.

Example: "User"
descriptionstring

The resource type's human-readable description.

Example: "User"
endpointstringrequired

The resource type's HTTP-addressable endpoint relative to the Base URL of the service provider.

Example: "/Users"
schemastringrequired

The resource type's primary/base schema URI

Example: "urn:ietf:params:scim:schemas:core:2.0:User"
schemaExtensionsArray of objects(SchemaExtension)
Example: [{"schema":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","required":true}]
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:ResourceType"
  ],
  "id": "User",
  "name": "User",
  "endpoint": "/Users",
  "description": "User",
  "schema": "urn:ietf:params:scim:schemas:core:2.0:User",
  "schemaExtensions": [
    { … }
  ],
  "meta": {
    "location": "https://example.com/v2/ResourceTypes/User",
    "resourceType": "ResourceType"
  }
}

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