-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
194 lines (177 loc) · 11.2 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>SCIMMY - SCIM m(ade eas)y</title>
<script src="static/classy.js"></script>
<script src="static/highlight/highlight.min.js"></script>
<script src="static/highlight/langs/javascript.min.js"></script>
<script src="static/highlight/langs/json.min.js"></script>
<link type="text/css" rel="stylesheet" href="static/highlight/highlight.min.css">
<link type="text/css" rel="stylesheet" href="static/classy.css">
<link rel="icon" type="image/svg+xml" href="static/assets/icon.svg" />
</head>
<body>
<header class="page-header">
<h1 class="package-details">
<a class="package-name" href="./">
<img alt="SCIMMY" src="static/assets/logo.svg" />
</a>
<span class="package-version">
<span class="type-signature">1.3.5</span>
</span>
</h1>
<h2 class="page-title"><span class="ancestors"></span>SCIMMY - SCIM m(ade eas)y</h2>
<div class="page-links">
<a href="https://github.com/scimmyjs/scimmy" title="View Source on GitHub">
<img alt="View Source on GitHub" src="static/assets/github.png" />
</a>
<div class="page-nav-toggle">
<input type="checkbox" name="tiny-page-nav-toggle" id="tiny-page-nav-toggle" autocomplete="off"/>
<label for="tiny-page-nav-toggle">
<span></span>
<span></span>
<span></span>
</label>
</div>
</div>
</header>
<nav class="page-nav">
<label class="hidden" for="tiny-page-nav"></label>
<input class="hidden tiny-page-nav-target" type="checkbox" id="tiny-page-nav" autocomplete="off"/>
<div class="nav-content">
<h3>API</h3><ul><li><h4><a href="SCIMMY.Config.html">Config</a></h4></li><li><details><summary><h4><a href="SCIMMY.Messages.html">Messages</a></h4></summary><ul><li><a href="SCIMMY.Messages.BulkRequest.html">BulkRequest</a></li><li><a href="SCIMMY.Messages.BulkResponse.html">BulkResponse</a></li><li><a href="SCIMMY.Messages.ErrorResponse.html">ErrorResponse</a></li><li><a href="SCIMMY.Messages.ListResponse.html">ListResponse</a></li><li><a href="SCIMMY.Messages.PatchOp.html">PatchOp</a></li><li><a href="SCIMMY.Messages.SearchRequest.html">SearchRequest</a></li></ul></details></li><li><details><summary><h4><a href="SCIMMY.Resources.html">Resources</a></h4></summary><ul><li><a href="SCIMMY.Resources.Group.html">Group</a></li><li><a href="SCIMMY.Resources.ResourceType.html">ResourceType</a></li><li><a href="SCIMMY.Resources.Schema.html">Schema</a></li><li><a href="SCIMMY.Resources.ServiceProviderConfig.html">ServiceProviderConfig</a></li><li><a href="SCIMMY.Resources.User.html">User</a></li></ul></details></li><li><details><summary><h4><a href="SCIMMY.Schemas.html">Schemas</a></h4></summary><ul><li><a href="SCIMMY.Schemas.EnterpriseUser.html">EnterpriseUser</a></li><li><a href="SCIMMY.Schemas.Group.html">Group</a></li><li><a href="SCIMMY.Schemas.ResourceType.html">ResourceType</a></li><li><a href="SCIMMY.Schemas.ServiceProviderConfig.html">ServiceProviderConfig</a></li><li><a href="SCIMMY.Schemas.User.html">User</a></li></ul></details></li><li><details><summary><h4><a href="SCIMMY.Types.html">Types</a></h4></summary><ul><li><a href="SCIMMY.Types.Attribute.html">Attribute</a></li><li><a href="SCIMMY.Types.SchemaDefinition.html">SchemaDefinition</a></li><li><a href="SCIMMY.Types.Error.html">Error</a></li><li><a href="SCIMMY.Types.Filter.html">Filter</a></li><li><a href="SCIMMY.Types.Resource.html">Resource</a></li><li><a href="SCIMMY.Types.Schema.html">Schema</a></li></ul></details></li></ul>
</div>
</nav>
<main id="main">
<article class="content-container main-page">
<header class="section-header">
<h2 class="page-title"><span class="ancestors"></span>SCIMMY - SCIM m(ade eas)y</h2>
</header>
<section class="readme description"><p align="center">
<a href="https://scimmyjs.github.io" target="_blank">
<img alt="SCIMMY" src="https://scimmyjs.github.io/static/assets/logo.svg" width="512">
</a>
</p>
<p align="center">
<a href="https://github.com/scimmyjs/scimmy/actions/workflows/ci.yml" target="_blank"><img alt="Unit Test Status" src="https://img.shields.io/github/actions/workflow/status/scimmyjs/scimmy/ci.yml?branch=main&style=flat&logo=mocha&label=unit%20tests"></a>
<a href="https://coveralls.io/github/scimmyjs/scimmy?branch=main" target="_blank"><img alt="Coverage Status" src="https://img.shields.io/coverallsCoverage/github/scimmyjs/scimmy?branch=main&style=flat&logo=coveralls"></a>
<a href="https://github.com/sponsors/scimmyjs" target="_blank"><img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/scimmyjs?style=flat&logo=githubsponsors"></a>
<a href="https://github.com/scimmyjs/scimmy/blob/1e51643ba4c224b5619aaa6732de1f414b9ceaf6/LICENSE.md" target="_blank"><img alt="GitHub License" src="https://img.shields.io/github/license/scimmyjs/scimmy?style=flat"></a>
</p>
<p>SCIM 2.0 (System for Cross-domain Identity Management) is a set of standards (<a href="https://datatracker.ietf.org/doc/html/rfc7643">RFC7643</a> and <a href="https://datatracker.ietf.org/doc/html/rfc7644">RFC7644</a>)
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.</p>
<blockquote>
<p>Want to use SCIMMY to quickly implement the SCIM protocol HTTP endpoints in express?<br>
<strong>Check out the <a href="https://github.com/scimmyjs/scimmy-routers">SCIMMY Routers</a> middleware package!</strong></p>
</blockquote>
<h5 id="requirements">Requirements</h5>
<ul>
<li><a href="https://nodejs.org">Node.js</a> v16+ with NPM 7+</li>
</ul>
<h2 id="installation-and-usage">Installation and Usage</h2>
<p>Through NPM:</p>
<pre class="prettyprint source"><code>$ npm install scimmy
</code></pre>
<p>In your code:</p>
<pre class="prettyprint source lang-js"><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 */
});
</code></pre>
<h5 id="questions">Questions</h5>
<ul>
<li>
<p><strong>Why use SCIMMY instead of some other SCIM-related package?</strong></p>
<ul>
<li>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 <a href="https://www.npmjs.com/package/scim-patch">SCIM-PATCH</a>
or <a href="https://www.npmjs.com/package/scim2-parse-filter">scim2-parse-filter</a>). That's all well and good, but
SCIMMY aims to implement the entire spec and integrate the protocol directly into your code.</li>
<li>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!</li>
</ul>
</li>
<li>
<p><strong>Will this work with cloud service X/Y/Z?</strong></p>
<ul>
<li>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.</li>
</ul>
</li>
<li>
<p><strong>What about the actual SCIM protocol HTTP endpoints?</strong></p>
<ul>
<li>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 <a href="https://github.com/scimmyjs/scimmy-routers">SCIMMY Routers</a></li>
</ul>
</li>
</ul>
<h2 id="api">API</h2>
<p>SCIMMY exports a singleton class which provides the following interfaces:</p>
<ul>
<li><code><a href="SCIMMY.Config.html">SCIMMY.Config</a></code>
<ul>
<li>SCIM Service Provider Configuration container store.</li>
</ul>
</li>
<li><code><a href="SCIMMY.Types.html">SCIMMY.Types</a></code>
<ul>
<li>SCIMMY classes for implementing schemas and resource types.</li>
</ul>
</li>
<li><code><a href="SCIMMY.Messages.html">SCIMMY.Messages</a></code>
<ul>
<li>Implementations of non-resource SCIM "message" schemas, such as ListResponse and PatchOp.</li>
</ul>
</li>
<li><code><a href="SCIMMY.Schemas.html">SCIMMY.Schemas</a></code>
<ul>
<li>Container store for declaring and retrieving schemas implemented by a service provider.</li>
<li>Also provides access to bundled schema implementations of <a href="https://datatracker.ietf.org/doc/html/rfc7643#section-4">SCIM Core Resource Schemas</a>.</li>
</ul>
</li>
<li><code><a href="SCIMMY.Resources.html">SCIMMY.Resources</a></code>
<ul>
<li>Container store for declaring and retrieving resource types implemented by a service provider.</li>
<li>Also provides access to bundled resource type implementations of <a href="https://datatracker.ietf.org/doc/html/rfc7643#section-4">SCIM Core Resource Types</a>.</li>
</ul>
</li>
</ul></section>
</article>
<aside class="content-aside">
<div class="toc toc-tiny">
<h2 class="page-title"><span class="ancestors"></span>SCIMMY - SCIM m(ade eas)y</h2>
<details class="toc-container">
<summary class="toc-title">Table of Contents</summary>
<nav class="toc-content"><ul><li><a href="#installation-and-usage">Installation and Usage</a><ul><li><a href="#questions">Questions</a></li></ul></li><li><a href="#api">API</a></li></ul></nav>
</details>
</div>
<div class="toc toc-regular">
<nav class="toc-container">
<h5 class="toc-title">Table of Contents</h5>
<div class="toc-content"><ul><li><a href="#installation-and-usage">Installation and Usage</a><ul><li><a href="#questions">Questions</a></li></ul></li><li><a href="#api">API</a></li></ul></div>
</nav>
</div>
</aside>
<footer>
Generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a>
using <a href="https://github.com/sleelin/classy-template">classy-template</a>
<span class="creation-timestamp">2025-03-05T04:14:54.335Z</span>
</footer>
</main>
<script>hljs.highlightAll();</script>
</body>
</html>