-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSCIMMY.Messages.html
More file actions
232 lines (157 loc) · 10.9 KB
/
SCIMMY.Messages.html
File metadata and controls
232 lines (157 loc) · 10.9 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
232
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Namespace: SCIMMY.Messages - 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>Messages</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 class="active"><details class="active" open="open"><summary class="active"><h4 class="active"><a href="SCIMMY.Messages.html" class="active">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 class-definition">
<header class="section-header">
<h2 class="page-title subsection-title">Namespace: <span class="ancestors"><a href="index.html">SCIMMY</a>.</span>Messages</h2>
<h2 class="class-title hidden">Namespace: SCIMMY.Messages</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.Messages</code>, that includes tools for constructing and
consuming SCIM-compliant data messages to be sent to, or received from, a SCIM service provider.</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/messages.js#L11">src/lib/messages.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.Messages.BulkRequest.html">SCIMMY.Messages.BulkRequest</a></code>
</div>
<ul>
<li>Parses <a href="https://datatracker.ietf.org/doc/html/rfc7644#section-3.7">BulkRequest messages</a>, making sure "Operations" have been specified, and conform with the SCIM protocol.</li>
<li>Provides a method to apply BulkRequest operations and return the results as a BulkResponse.</li>
</ul>
</li>
<li>
<div class="name">
<code><a href="SCIMMY.Messages.BulkResponse.html">SCIMMY.Messages.BulkResponse</a></code>
</div>
<ul>
<li>Encapsulates bulk operation results as <a href="https://datatracker.ietf.org/doc/html/rfc7644#section-3.7">BulkResponse messages</a> for consumption by a client.</li>
<li>Provides a method to unwrap BulkResponse results into operation success status, and map newly created resource IDs to their BulkRequest bulkIds.</li>
</ul>
</li>
<li>
<div class="name">
<code><a href="SCIMMY.Messages.ErrorResponse.html">SCIMMY.Messages.ErrorResponse</a></code>
</div>
<ul>
<li>Formats exceptions to conform to the <a href="https://datatracker.ietf.org/doc/html/rfc7644#section-3.12">HTTP Status and Error Response Handling</a> section of the SCIM protocol, ensuring HTTP status codes and scimType error detail keyword pairs are valid.</li>
<li>When used to parse service provider responses, throws a new instance of <code>SCIMMY.Types.Error</code> with details sourced from the message.</li>
</ul>
</li>
<li>
<div class="name">
<code><a href="SCIMMY.Messages.ListResponse.html">SCIMMY.Messages.ListResponse</a></code>
</div>
<ul>
<li>Formats supplied service provider resources as <a href="https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2">ListResponse messages</a>, handling pagination and sort when required.</li>
</ul>
</li>
<li>
<div class="name">
<code><a href="SCIMMY.Messages.PatchOp.html">SCIMMY.Messages.PatchOp</a></code>
</div>
<ul>
<li>Parses <a href="https://datatracker.ietf.org/doc/html/rfc7644#section-3.5.2">PatchOp messages</a>, making sure all specified "Operations" are valid and conform with the SCIM protocol.</li>
<li>Provides a method to atomically apply PatchOp operations to a resource instance, handling any exceptions that occur along the way.</li>
</ul>
</li>
<li>
<div class="name">
<code><a href="SCIMMY.Messages.SearchRequest.html">SCIMMY.Messages.SearchRequest</a></code>
</div>
<ul>
<li>Encapsulates HTTP POST data as <a href="https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.3">SCIM SearchRequest messages</a>.</li>
<li>Provides a method to perform the search request against the declared or specified resource types.</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>Messages</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.488Z</span>
</footer>
</main>
<script>hljs.highlightAll();</script>
</body>
</html>