Skip to content

What is the SCIM API?

The File Access Manager SCIM API provides access to the File Access Manager platform. The API is standards-based, built upon the RESTful SCIM 2.0 specification. You can use this API to access File Access Manager API endpoints, which allow you to programmatically interact with objects within the File Access Manager.

SCIM Protocol

SCIM (System for Cross-Domain Identity Management) is an HTTP-based protocol that makes managing identities in multi-domain scenarios easier to support through a standardized RESTful API service. It provides a platform-neutral schema and extension model for representing users, groups, and other resource types in JSON format.

We implement SCIM with the following restrictions:

Filter operators

Currently, we only support the "and" logical operator between filter expressions ("or" is not supported).

Filter special characters

If filter expression values include the reserved URL characters " '$-_.+!*'(),' ", they need to be changed to their encoded value.

Sorting

Currently, we do not support SCIM Sorting capabilities (SortBy and SortOrder). Each method implements its own sorting by default.

Getting Started

For more information about the SCIM 2.0 specification, as described in SCIM Protocol above:

  1. Ensure you have File Access Manager version 8.0 or higher installed.
  2. Read the File Access Manager documentation.
  3. Participate in the forums. Ask questions, read about requested and upcoming functionality, and assist others.