-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSCIMMY.Types.html
More file actions
231 lines (156 loc) · 10.8 KB
/
SCIMMY.Types.html
File metadata and controls
231 lines (156 loc) · 10.8 KB
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Namespace: SCIMMY.Types - SCIMMY</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">Namespace: <span class="ancestors"><a href="index.html">SCIMMY</a>.</span>Types</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 class="active"><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 class="active"><details class="active" open="open"><summary class="active"><h4 class="active"><a href="SCIMMY.Types.html" class="active">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 class-definition">
<header class="section-header">
<h2 class="page-title subsection-title">Namespace: <span class="ancestors"><a href="index.html">SCIMMY</a>.</span>Types</h2>
<h2 class="class-title hidden">Namespace: SCIMMY.Types</h2>
</header>
<section id="description" class="container-overview">
<header>
<h3 class="hidden">Description</h3>
</header>
<div class="description"><p>SCIMMY provides a singleton class, <code>SCIMMY.Types</code>, that exposes the building blocks used to create SCIM schemas and resource types, and handle SCIM schema and protocol errors.
These can be used to construct custom resource types and handle errors encountered when invoking supplied read/write/delete handlers of built-in resources.</p></div>
</section>
<section id="usage" class="class-usage">
<h3 class="subsection-title">Usage</h3>
<section id="details" class="details">
<dl class="details-list">
<div class="detail tag-kind">
<dt>Kind:</dt>
<dd><span class="signature type-signature">singleton</span></dd>
</div>
<div class="detail tag-source">
<dt>Source:</dt>
<dd><a href="https://github.com/scimmyjs/scimmy/blob/ea53d92787d2a5db844c7699a7aeb4c1eafa13a7/src/lib/types.js#L11">src/lib/types.js, line 11</a></dd>
</div>
</dl>
</section>
</section>
<section id="classes" class="child-classes">
<h3 class="subsection-title">Classes</h3>
<ul class="subsection-list">
<li>
<div class="name">
<code><a href="SCIMMY.Types.Attribute.html">SCIMMY.Types.Attribute</a></code>
</div>
<ul>
<li>Defines a SCIM schema attribute, and is used to ensure a given resource's value conforms to the attribute definition.</li>
</ul>
</li>
<li>
<div class="name">
<code><a href="SCIMMY.Types.SchemaDefinition.html">SCIMMY.Types.SchemaDefinition</a></code>
</div>
<ul>
<li>Defines an underlying SCIM schema definition, containing the schema's URN namespace, friendly name, description, and collection of attributes that make up the schema.</li>
<li>Provides a way to ensure all properties of a resource conform to their attribute definitions, as well as enabling JSON expression of schemas for consumption by other SCIM clients or service providers.</li>
</ul>
</li>
<li>
<div class="name">
<code><a href="SCIMMY.Types.Error.html">SCIMMY.Types.Error</a></code>
</div>
<ul>
<li>Extends the native Error class and provides a way to express errors caused by SCIM protocol, schema conformity, filter expression,
or other exceptions with details required by the SCIM protocol in <a href="https://datatracker.ietf.org/doc/html/rfc7644#section-3.12">RFC7644§3.12</a>.</li>
</ul>
</li>
<li>
<div class="name">
<code><a href="SCIMMY.Types.Filter.html">SCIMMY.Types.Filter</a></code>
</div>
<ul>
<li>Parses SCIM <a href="https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2">filter expressions</a> into object representations of the filter expression.</li>
</ul>
</li>
<li>
<div class="name">
<code><a href="SCIMMY.Types.Resource.html">SCIMMY.Types.Resource</a></code>
</div>
<ul>
<li>Extendable class representing a SCIM Resource Type, which acts as an interface between a SCIM resource type schema, and an app's internal data model.</li>
<li>Handles incoming requests to read/write/delete a resource, parses any attribute, filter, and sort parameters of a request, and formats responses for consumption by other SCIM clients and service providers.</li>
</ul>
</li>
<li>
<div class="name">
<code><a href="SCIMMY.Types.Schema.html">SCIMMY.Types.Schema</a></code>
</div>
<ul>
<li>Extendable class which provides the ability to construct resource instances with automated validation of conformity to a resource's schema definition.</li>
<li>Once instantiated, any modifications will also be validated against the attached schema definition's matching attribute configuration (e.g. for mutability or canonical values).</li>
</ul>
</li>
</ul>
</section>
</article>
<aside class="content-aside">
<div class="toc toc-tiny">
<h2 class="page-title">Namespace: <span class="ancestors"><a href="index.html">SCIMMY</a>.</span>Types</h2>
<details class="toc-container">
<summary class="toc-title">Table of Contents</summary>
<nav class="toc-content"><ul><li><h5 class="toc-section"><a href="#description">Description</a></h5></li><li><h5 class="toc-section"><a href="#usage">Usage</a></h5><ul><li><a href="#details">Details</a></li></ul></li><li><h5 class="toc-section"><a href="#classes">Classes</a></h5></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><h5 class="toc-section"><a href="#description">Description</a></h5></li><li><h5 class="toc-section"><a href="#usage">Usage</a></h5><ul><li><a href="#details">Details</a></li></ul></li><li><h5 class="toc-section"><a href="#classes">Classes</a></h5></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.781Z</span>
</footer>
</main>
<script>hljs.highlightAll();</script>
</body>
</html>