API showdown
/
Train Travel API
/
Admin
/
Schemas

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

Schemas

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

Operations

Retrieve schemas

Request

This operation is used to retrieve information about resource schemas supported by a SCIM service provider. An HTTP GET to the endpoint "/Schemas" will return all supported schemas in ListResponse format.

Note: The contents of each schema returned are described in Section 7 of [RFC7643].

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

Responses

Successful GET operation

Bodyapplication/json
schemasArray of stringsrequired
Default ["urn:ietf:params:scim:api:messages:2.0:ListResponse"]
Example: ["urn:ietf:params:scim:api:messages:2.0:ListResponse"]
totalResultsinteger

The total number of results returned by the list.

Example: 2
itemsPerPageinteger

The number of resources returned in a list response page.

Example: 10
startIndexinteger

The 1-based index of the first result in the current set of list results.

resourcesArray of objects
Example: [{"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":[{"schema":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","required":true}],"meta":{"location":"https://example.com/v2/ResourceTypes/User","resourceType":"ResourceType"}},{"schemas":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"],"id":"Group","name":"Group","endpoint":"/Groups","description":"Group","schema":"urn:ietf:params:scim:schemas:core:2.0:Group","meta":{"location":"https://example.com/v2/ResourceTypes/Group","resourceType":"ResourceType"}}]
Response
application/json
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 2,
  "itemsPerPage": 10,
  "description": 1,
  "resources": [
    { … },
    { … }
  ]
}

Retrieve specific schema

Request

This operation is used to retrieve individual schema definitions by his schema URI.

For example: /Schemas/urn:ietf:params:scim:schemas:core:2.0:User

Note: The contents of schema returned are described in Section 7 of [RFC7643].

Path
idstringrequired

The specific schema ID.

Example: urn:ietf:params:scim:schemas:core:2.0:Group
curl -i -X GET \
  https://innovario.apishowdown.com/_mock/catalog/api-showdown/api-hub/admin/openapi/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful GET operation

Bodyapplication/json
idanyrequired

The unique URI of the schema. When applicable, service providers must specify the URI, e.g., "urn:ietf:params:scim:schemas:core:2.0:User". Unlike most other schemas, which use some sort of Globally Unique Identifier (GUID) for the "id", the schema "id" is a URI so that it can be registered and is portable between different service providers and clients.

Example: "urn:ietf:params:scim:schemas:core:2.0:Group"
nameany

The schema's human-readable name. When applicable, service providers must specify the name, e.g., "User" or "Group".

Example: "Group"
descriptionany

The schema's human-readable description. When applicable, service providers must specify the description.

Example: "Group"
attributesArray of objects(Attribute)

A complex type that defines service provider attributes and their qualities via the following set of sub-attributes:

Example: [{"name":"displayName","type":"string","multiValued":false,"required":false,"caseExact":false,"mutability":"readWrite","returned":"default","uniqueness":"none"},{"name":"members","type":"complex","multiValued":true,"required":false,"mutability":"readWrite","returned":"default","subAttributes":[{"name":"value","type":"string","multiValued":false,"required":false,"caseExact":false,"mutability":"immutable","returned":"default","uniqueness":"none"},{"name":"$ref","type":"reference","referenceTypes":["User","Group"],"multiValued":false,"required":false,"caseExact":false,"mutability":"immutable","returned":"default","uniqueness":"none"},{"name":"type","type":"string","multiValued":false,"required":false,"caseExact":false,"canonicalValues":["User","Group"],"mutability":"immutable","returned":"default","uniqueness":"none"}]}]
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
{
  "id": "urn:ietf:params:scim:schemas:core:2.0:Group",
  "name": "Group",
  "description": "Group",
  "attributes": [
    { … },
    { … }
  ],
  "meta": {
    "resourceType": "Schema",
    "location": "https://example.com/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group"
  }
}

Users

Retrieve, add, modify Users.

Operations

Groups

Retrieve, add, modify Groups.

Operations

Bulk operations

Bulk updates to one or more resources.

Operations