scim2-fastapi

scim2-fastapi is a FastAPI extension serving a SCIM 2.0 server, as RFC 7643 and RFC 7644 define it. It exposes the resource, search, bulk and discovery endpoints in an APIRouter. It is built upon scim2-server and scim2-models.

The extension serves the SCIM protocol. The FastAPI application that includes it provides the rest:

• a AsyncScimStorage, which reads and writes the resources;

• a ScimProvider, which declares the resource types the server serves and the features it supports;

• authentication and authorization, since the extension leaves every endpoint open.

This documentation addresses Python developers who build a SCIM server with FastAPI. It assumes familiarity with FastAPI applications and their dependencies. It covers what is specific to FastAPI: the storage, the service and the protocol rules are described in the scim2-server documentation.

pip install scim2-fastapi

Choose a path

Overview introduces the parts of a SCIM server built with FastAPI, in the order an application meets them.

Integrate with the application shows how to authenticate the clients, commit the changes of each request, choose the URLs and limit the size of the requests.

Reference lists the complete public API.