-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSCIMMY.Types.Error.html
376 lines (248 loc) · 12.5 KB
/
SCIMMY.Types.Error.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
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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Class: SCIMMY.Types.Error - 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">Class: <span class="ancestors"><a href="index.html">SCIMMY</a><a href="SCIMMY.Types.html">.Types</a>.</span>Error</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><h4><a href="SCIMMY.Types.html">Types</a></h4></summary><ul class="active"><li><a href="SCIMMY.Types.Attribute.html">Attribute</a></li><li><a href="SCIMMY.Types.SchemaDefinition.html">SchemaDefinition</a></li><li class="active"><a href="SCIMMY.Types.Error.html" class="active">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">Class: <span class="ancestors"><a href="index.html">SCIMMY</a><a href="SCIMMY.Types.html">.Types</a>.</span>Error</h2>
<h2 class="class-title">SCIM Error Type</h2>
</header>
<section id="description" class="container-overview">
<header>
<h3 class="hidden">Description</h3>
<div class="class-summary description">
<blockquote>
<strong>Summary:</strong>
<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>
</blockquote>
</div>
</header>
</section>
<section id="usage" class="class-usage">
<h3 class="subsection-title">Usage</h3>
<div class="description"><p>Instantiate a new error with SCIM error details</p></div>
<div class="class-signature">
<pre class="signature name no-highlight">
<code>
new <span class="ancestors">SCIMMY.Types.</span>Error<span class="signature">(status, scimType, message)</span><span class="type-signature returns"></span>
</code>
</pre>
</div>
<section id="details" class="details">
<dl class="details-list">
<div class="detail tag-see">
<dt>See:</dt>
<dd><a href="SCIMMY.Messages.ErrorResponse.html">SCIMMY.Messages.ErrorResponse</a></dd>
</div>
<div class="detail tag-source">
<dt>Source:</dt>
<dd><a href="https://github.com/scimmyjs/scimmy/blob/ea53d92787d2a5db844c7699a7aeb4c1eafa13a7/src/lib/types/error.js#L10">src/lib/types/error.js, line 10</a></dd>
</div>
</dl>
</section>
<section id="params" class="params">
<h5 class="subsection-title">Parameters:</h5>
<div class="subsection-content">
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name">
<code>
status<span class="signature-attributes"></span>
</code>
</td>
<td class="type">
<span class="param">
<code>
<span class="param-type">Number</span>
</code>
</span>
</td>
<td class="description last">
<p>HTTP status code to be sent with the error</p>
</td>
</tr>
<tr>
<td class="name">
<code>
scimType<span class="signature-attributes"></span>
</code>
</td>
<td class="type">
<span class="param">
<code>
<span class="param-type">String</span>
</code>
</span>
</td>
<td class="description last">
<p>the SCIM detail error keyword as per <a href="https://datatracker.ietf.org/doc/html/rfc7644#section-3.12">RFC7644§3.12</a></p>
</td>
</tr>
<tr>
<td class="name">
<code>
message<span class="signature-attributes"></span>
</code>
</td>
<td class="type">
<span class="param">
<code>
<span class="param-type">String</span>
</code>
</span>
</td>
<td class="description last">
<p>a human-readable description of what caused the error to occur</p>
</td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="properties" class="props">
<h5 class="subsection-title">Properties:</h5>
<div class="subsection-content">
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name">
<code>
status<span class="signature-attributes"></span>
</code>
</td>
<td class="type">
<span class="param">
<code>
<span class="param-type">Number</span>
</code>
</span>
</td>
<td class="description last">
<p>HTTP status code to be sent with the error</p>
</td>
</tr>
<tr>
<td class="name">
<code>
scimType<span class="signature-attributes"></span>
</code>
</td>
<td class="type">
<span class="param">
<code>
<span class="param-type">String</span>
</code>
</span>
</td>
<td class="description last">
<p>the SCIM detail error keyword as per <a href="https://datatracker.ietf.org/doc/html/rfc7644#section-3.12">RFC7644§3.12</a></p>
</td>
</tr>
<tr>
<td class="name">
<code>
message<span class="signature-attributes"></span>
</code>
</td>
<td class="type">
<span class="param">
<code>
<span class="param-type">String</span>
</code>
</span>
</td>
<td class="description last">
<p>a human-readable description of what caused the error to occur</p>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</section>
</article>
<aside class="content-aside">
<div class="toc toc-tiny">
<h2 class="page-title">Class: <span class="ancestors"><a href="index.html">SCIMMY</a><a href="SCIMMY.Types.html">.Types</a>.</span>Error</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><li><a href="#params">Parameters</a></li><li><a href="#properties">Properties</a></li></ul></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><li><a href="#params">Parameters</a></li><li><a href="#properties">Properties</a></li></ul></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.733Z</span>
</footer>
</main>
<script>hljs.highlightAll();</script>
</body>
</html>