Skip to content

Latest commit

 

History

History
87 lines (68 loc) · 4.8 KB

README.md

File metadata and controls

87 lines (68 loc) · 4.8 KB
Raw

SCIMMY

Unit Test Status Coverage Status GitHub Sponsors GitHub License

SCIMMY - SCIM m(ade eas)y

SCIM 2.0 (System for Cross-domain Identity Management) is a set of standards (RFC7643 and RFC7644) designed to simplify resource provisioning and identity management in cloud-based applications and services. SCIMMY aims to make it easier to rapidly implement code that sends and receives data conforming to these standards. It does this by providing a set of tools that can be used to parse incoming, and format outgoing data according to these standards.

Requirements

Installation and Usage

Through NPM:

$ npm install scimmy

In your code:

import SCIMMY from "scimmy";

// Basic usage with provided resource type implementations
SCIMMY.Resources.declare(SCIMMY.Resources.User)
    .ingress((resource, data) => {/* Your handler for creating or modifying user resources */})
    .egress((resource) => {/* Your handler for retrieving user resources */})
    .degress((resource) => {/* Your handler for deleting user resources */});

// Advanced usage with custom resource type implementations
SCIMMY.Resources.declare(class MyResourceType extends SCIMMY.Types.Resource {
    read() {/* Your handler for retrieving resources */}
    write(data) {/* Your handler for creating or modifying resources */}
    dispose() {/* Your handler for deleting resources */}
    /* ...the rest of your resource type implementation */
});
Questions

  • Why use SCIMMY instead of some other SCIM-related package?

    • Many of the SCIM-related packages available seem to target specific cloud services like GitHub, act as API bridges, or only implement certain parts of the spec (like SCIM-PATCH or scim2-parse-filter). That's all well and good, but SCIMMY aims to implement the entire spec and integrate the protocol directly into your code.
    • As retrieval/consumption of resources from your data model is left up to you to implement, you should be able to use other SCIM-related packages in conjunction with SCIMMY!

  • Will this work with cloud service X/Y/Z?

    • Hopefully, but if not, feel free to open an issue with details of the cloud service you are integrating with. SCIMMY has been tested against Microsoft Entra ID (formerly Azure AD), which didn't appear to have any issues.

  • What about the actual SCIM protocol HTTP endpoints?

    • That's up to you, as we can't be sure exactly how you'd like to integrate SCIM in your code, however we have provided a package with express middleware which uses SCIMMY to implement the endpoints, called SCIMMY Routers

API

SCIMMY exports a singleton class which provides the following interfaces:

  • SCIMMY.Config
    • SCIM Service Provider Configuration container store.
  • SCIMMY.Types
    • SCIMMY classes for implementing schemas and resource types.
  • SCIMMY.Messages
    • Implementations of non-resource SCIM "message" schemas, such as ListResponse and PatchOp.
  • SCIMMY.Schemas
    • Container store for declaring and retrieving schemas implemented by a service provider.
    • Also provides access to bundled schema implementations of SCIM Core Resource Schemas.
  • SCIMMY.Resources
    • Container store for declaring and retrieving resource types implemented by a service provider.
    • Also provides access to bundled resource type implementations of SCIM Core Resource Types.

For more details on how to use SCIMMY, visit the documentation.