@itentialopensource/adapter-microsoft_graph 1.3.5 → 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
package/TAB2.md CHANGED
@@ -1,264 +1,73 @@
1
- # Microsoft_graph
1
+ # Microsoft Graph
2
2
 
3
3
  ## Table of Contents
4
4
 
5
- - [Getting Started](#getting-started)
6
- - [Helpful Background Information](#helpful-background-information)
7
- - [Prerequisites](#prerequisites)
8
- - [How to Install](#how-to-install)
9
- - [Testing](#testing)
10
- - [Configuration](#configuration)
11
- - [Example Properties](#example-properties)
12
- - [Connection Properties](#connection-properties)
13
- - [Authentication Properties](#authentication-properties)
14
- - [Healthcheck Properties](#healthcheck-properties)
15
- - [Request Properties](#request-properties)
16
- - [SSL Properties](#ssl-properties)
17
- - [Throttle Properties](#throttle-properties)
18
- - [Proxy Properties](#proxy-properties)
19
- - [Mongo Properties](#mongo-properties)
20
- - [Device Broker Properties](#device-broker-properties)
21
- - [Using this Adapter](#using-this-adapter)
22
- - [Generic Adapter Calls](#generic-adapter-calls)
23
- - [Adapter Cache Calls](#adapter-cache-calls)
24
- - [Adapter Broker Calls](#adapter-broker-calls)
25
- - [Specific Adapter Calls](#specific-adapter-calls)
26
- - [Authentication](#authentication)
27
- - [Additional Information](#additional-information)
28
- - [Enhancements](#enhancements)
29
- - [Contributing](#contributing)
30
- - [Helpful Links](#helpful-links)
31
- - [Node Scripts](#node-scripts)
32
- - [Troubleshoot](#troubleshoot)
33
- - [Connectivity Issues](#connectivity-issues)
34
- - [Functional Issues](#functional-issues)
5
+ - [Specific Adapter Information](#specific-adapter-information)
6
+ - [Authentication](#authentication)
7
+ - [Sample Properties](#sample-properties)
8
+ - [Swagger](#swagger)
9
+ - [Generic Adapter Information](#generic-adapter-information)
35
10
 
36
- ## Getting Started
37
-
38
- These instructions will help you get a copy of the project on your local machine for development and testing. Reading this section is also helpful for deployments as it provides you with pertinent information on prerequisites and properties.
39
-
40
- ### Helpful Background Information
41
-
42
- There is <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter documentation available on the Itential Documentation Site</a>. This documentation includes information and examples that are helpful for:
43
-
44
- ```text
45
- Authentication
46
- IAP Service Instance Configuration
47
- Code Files
48
- Endpoint Configuration (Action & Schema)
49
- Mock Data
50
- Adapter Generic Methods
51
- Headers
52
- Security
53
- Linting and Testing
54
- Build an Adapter
55
- Troubleshooting an Adapter
56
- ```
57
-
58
- Others will be added over time.
59
- Want to build a new adapter? Use the <a href="https://adapters.itential.io" target="_blank">Itential Adapter Builder</a>
60
-
61
- ### Prerequisites
62
-
63
- The following is a list of required packages for installation on the system the adapter will run on:
64
-
65
- ```text
66
- Node.js
67
- npm
68
- Git
69
- ```
70
-
71
- The following list of packages are required for Itential opensource adapters or custom adapters that have been built utilizing the Itential Adapter Builder. You can install these packages by running npm install inside the adapter directory.
72
-
73
- <table border="1" class="bordered-table">
74
- <tr>
75
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Package</span></th>
76
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
77
- </tr>
78
- <tr>
79
- <td style="padding:15px">@itentialopensource/adapter-utils</td>
80
- <td style="padding:15px">Runtime library classes for all adapters; includes request handling, connection, authentication throttling, and translation.</td>
81
- </tr>
82
- <tr>
83
- <td style="padding:15px">ajv</td>
84
- <td style="padding:15px">Required for validation of adapter properties to integrate with Microsoft_graph.</td>
85
- </tr>
86
- <tr>
87
- <td style="padding:15px">axios</td>
88
- <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
89
- </tr>
90
- <tr>
91
- <td style="padding:15px">commander</td>
92
- <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
93
- </tr>
94
- <tr>
95
- <td style="padding:15px">dns-lookup-promise</td>
96
- <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
97
- </tr>
98
- <tr>
99
- <td style="padding:15px">fs-extra</td>
100
- <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
101
- </tr>
102
- <tr>
103
- <td style="padding:15px">mocha</td>
104
- <td style="padding:15px">Testing library that is utilized by some of the node scripts that are included with the adapter.</td>
105
- </tr>
106
- <tr>
107
- <td style="padding:15px">mocha-param</td>
108
- <td style="padding:15px">Testing library that is utilized by some of the node scripts that are included with the adapter.</td>
109
- </tr>
110
- <tr>
111
- <td style="padding:15px">mongodb</td>
112
- <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
113
- </tr>
114
- <tr>
115
- <td style="padding:15px">nyc</td>
116
- <td style="padding:15px">Testing coverage library that is utilized by some of the node scripts that are included with the adapter.</td>
117
- </tr>
118
- <tr>
119
- <td style="padding:15px">ping</td>
120
- <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
121
- </tr>
122
- <tr>
123
- <td style="padding:15px">readline-sync</td>
124
- <td style="padding:15px">Utilized by the node script that comes with the adapter; helps to test unit and integration functionality.</td>
125
- </tr>
126
- <tr>
127
- <td style="padding:15px">semver</td>
128
- <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
129
- </tr>
130
- <tr>
131
- <td style="padding:15px">winston</td>
132
- <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
133
- </tr>
134
- </table>
135
- <br>
136
-
137
- If you are developing and testing a custom adapter, or have testing capabilities on an Itential opensource adapter, you will need to install these packages as well.
138
-
139
- ```text
140
- chai
141
- eslint
142
- eslint-config-airbnb-base
143
- eslint-plugin-import
144
- eslint-plugin-json
145
- testdouble
146
- ```
147
-
148
- ### How to Install
149
-
150
- 1. Set up the name space location in your IAP node_modules.
151
-
152
- ```bash
153
- cd /opt/pronghorn/current/node_modules (* could be in a different place)
154
- if the @itentialopensource directory does not exist, create it:
155
- mkdir @itentialopensource
156
- ```
157
-
158
- 2. Clone/unzip/tar the adapter into your IAP environment.
159
-
160
- ```bash
161
- cd \@itentialopensource
162
- git clone git@gitlab.com:\@itentialopensource/adapters/adapter-microsoft_graph
163
- or
164
- unzip adapter-microsoft_graph.zip
165
- or
166
- tar -xvf adapter-microsoft_graph.tar
167
- ```
168
-
169
- 3. Run the adapter install script.
170
-
171
- ```bash
172
- cd adapter-microsoft_graph
173
- npm install
174
- npm run lint:errors
175
- npm run test
176
- ```
177
-
178
- 4. Restart IAP
179
-
180
- ```bash
181
- systemctl restart pronghorn
182
- ```
183
-
184
- 5. Create an adapter service instance configuration in IAP Admin Essentials GUI
185
-
186
- 6. Copy the properties from the sampleProperties.json and paste them into the service instance configuration in the inner/second properties field.
187
-
188
- 7. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
189
-
190
-
191
- For an easier install of the adapter use npm run adapter:install, it will install the adapter in IAP. Please note that it can be dependent on where the adapter is installed and on the version of IAP so it is subject to fail. If using this, you can replace step 3-5 above with these:
192
-
193
- 3. Install adapter dependencies and check the adapter.
194
-
195
- ```bash
196
- cd adapter-microsoft_graph
197
- npm run adapter:install
198
- ```
199
-
200
- 4. Restart IAP
201
-
202
- ```bash
203
- systemctl restart pronghorn
204
- ```
205
-
206
- 5. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
207
-
208
-
209
- ### Testing
210
-
211
- Mocha is generally used to test all Itential Opensource Adapters. There are unit tests as well as integration tests performed. Integration tests can generally be run as standalone using mock data and running the adapter in stub mode, or as integrated. When running integrated, every effort is made to prevent environmental failures, however there is still a possibility.
212
-
213
- #### Unit Testing
214
-
215
- Unit Testing includes testing basic adapter functionality as well as error conditions that are triggered in the adapter prior to any integration. There are two ways to run unit tests. The prefered method is to use the testRunner script; however, both methods are provided here.
216
-
217
- ```bash
218
- node utils/testRunner --unit
219
-
220
- npm run test:unit
221
- npm run test:baseunit
222
- ```
223
-
224
- To add new unit tests, edit the `test/unit/adapterTestUnit.js` file. The tests that are already in this file should provide guidance for adding additional tests.
225
-
226
- #### Integration Testing - Standalone
11
+ ## Specific Adapter Information
12
+ ### Authentication
227
13
 
228
- Standalone Integration Testing requires mock data to be provided with the entities. If this data is not provided, standalone integration testing will fail. When the adapter is set to run in stub mode (setting the stub property to true), the adapter will run through its code up to the point of making the request. It will then retrieve the mock data and return that as if it had received that data as the response from Microsoft_graph. It will then translate the data so that the adapter can return the expected response to the rest of the Itential software. Standalone is the default integration test.
14
+ This document will go through the steps for authenticating the Microsoft Graph adapter with OAuth Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>.
229
15
 
230
- Similar to unit testing, there are two ways to run integration tests. Using the testRunner script is better because it prevents you from having to edit the test script; it will also resets information after testing is complete so that credentials are not saved in the file.
16
+ Companies periodically change authentication methods to provide better security. As this happens this section should be updated and contributed/merge back into the adapter repository.
231
17
 
232
- ```bash
233
- node utils/testRunner
234
- answer no at the first prompt
18
+ #### OAuth Authentication
19
+ The Microsoft Graph adapter requires OAuth Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
235
20
 
236
- npm run test:integration
21
+ STEPS
22
+ 1. Ensure you have access to a Microsoft Graph server and that it is running
23
+ 2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
24
+ 3. Use the properties below for the ```properties.authentication``` field. Note that the token_URI_path has a variable which should be replaced with a valid tenant value
25
+ ```json
26
+ "authentication": {
27
+ "auth_method": "request_token",
28
+ "token_timeout": 600000,
29
+ "token_cache": "local",
30
+ "token_URI_path": "/{tenant}/oauth2/v2.0/token",
31
+ "invalid_token_error": 401,
32
+ "auth_field": "header.headers.Authorization",
33
+ "auth_field_format": "Bearer {token}",
34
+ "client_id": "<client_id>",
35
+ "client_secret": "<client_secret>",
36
+ "grant_type": "client_credentials",
37
+ "auth_logging": false,
38
+ "sso": {
39
+ "protocol": "https",
40
+ "host": "login.microsoftonline.com",
41
+ "port": 443
42
+ }
43
+ }
237
44
  ```
238
-
239
- To add new integration tests, edit the `test/integration/adapterTestIntegration.js` file. The tests that are already in this file should provide guidance for adding additional tests.
240
-
241
- #### Integration Testing
242
-
243
- Integration Testing requires connectivity to Microsoft_graph. By using the testRunner script it prevents you from having to edit the integration test. It also resets the integration test after the test is complete so that credentials are not saved in the file.
244
-
245
- > **Note**: These tests have been written as a best effort to make them work in most environments. However, the Adapter Builder often does not have the necessary information that is required to set up valid integration tests. For example, the order of the requests can be very important and data is often required for `creates` and `updates`. Hence, integration tests may have to be enhanced before they will work (integrate) with Microsoft_graph. Even after tests have been set up properly, it is possible there are environmental constraints that could result in test failures. Some examples of possible environmental issues are customizations that have been made within Microsoft_graph which change order dependencies or required data.
246
-
247
- ```bash
248
- node utils/testRunner
249
- answer yes at the first prompt
250
- answer all other questions on connectivity and credentials
45
+ 4. Use the properties below for the ```properties.request.global_request.authData``` field to add scope to the token request
46
+ ```json
47
+ "request": {
48
+ "global_request": {
49
+ "authData": {
50
+ "scope": "https://graph.microsoft.com/.default"
51
+ }
52
+ }
53
+ }
251
54
  ```
55
+ 5. Restart the adapter. If your properties were set correctly, the adapter should go online.
252
56
 
253
- Test should also be written to clean up after themselves. However, it is important to understand that in some cases this may not be possible. In addition, whenever exceptions occur, test execution may be stopped, which will prevent cleanup actions from running. It is recommended that tests be utilized in dev and test labs only.
254
-
255
- > **Reminder**: Do not check in code with actual credentials to systems.
256
-
257
- ## Configuration
57
+ #### Troubleshooting
58
+ - Make sure you copied over the correct client_id and client_secret.
59
+ - Turn on debug level logs for the adapter in IAP Admin Essentials.
60
+ - Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
61
+ - Investigate the logs - in particular:
62
+ - The FULL REQUEST log to make sure the proper headers are being sent with the request.
63
+ - The FULL BODY log to make sure the payload is accurate.
64
+ - The CALL RETURN log to see what the other system is telling us.
65
+ - Credentials should be ** masked ** by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
66
+ - Remember when you are done to turn auth_logging off as you do not want to log credentials.
258
67
 
259
- This section defines **all** the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or IAP are provided in the sampleProperties.
68
+ ### Sample Properties
260
69
 
261
- ### Example Properties
70
+ Sample Properties can be used to help you configure the adapter in the Itential Automation Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
262
71
 
263
72
  ```json
264
73
  "properties": {
@@ -379,30 +188,32 @@ This section defines **all** the properties that are available for the adapter,
379
188
  }
380
189
  },
381
190
  "devicebroker": {
191
+ "enabled": false,
382
192
  "getDevice": [
383
193
  {
384
- "path": "/get/devices/{id}",
194
+ "path": "/not/mapped",
385
195
  "method": "GET",
386
196
  "query": {},
387
197
  "body": {},
388
198
  "headers": {},
389
199
  "handleFailure": "ignore",
390
200
  "requestFields": {
391
- "id": "name"
201
+ "insample": "{port}"
392
202
  },
393
203
  "responseDatakey": "",
394
204
  "responseFields": {
395
- "name": "host",
396
- "ostype": "os",
397
- "ostypePrefix": "system-",
398
- "ipaddress": "attributes.ipaddr",
399
- "port": "443"
205
+ "name": "{this}{||}{that}",
206
+ "ostype": "{osfield}",
207
+ "ostypePrefix": "meraki-",
208
+ "port": "{port}",
209
+ "ipaddress": "{ip_addr}",
210
+ "serial": "{serial}"
400
211
  }
401
212
  }
402
213
  ],
403
214
  "getDevicesFiltered": [
404
215
  {
405
- "path": "/get/devices",
216
+ "path": "/not/mapped",
406
217
  "method": "GET",
407
218
  "pagination": {
408
219
  "offsetVar": "",
@@ -417,42 +228,44 @@ This section defines **all** the properties that are available for the adapter,
417
228
  "requestFields": {},
418
229
  "responseDatakey": "",
419
230
  "responseFields": {
420
- "name": "host",
421
- "ostype": "os",
422
- "ostypePrefix": "system-",
423
- "ipaddress": "attributes.ipaddr",
424
- "port": "443"
231
+ "name": "{this}{||}{that}",
232
+ "ostype": "{osfield}",
233
+ "ostypePrefix": "meraki-",
234
+ "port": "{port}",
235
+ "ipaddress": "{ip_addr}",
236
+ "serial": "{serial}",
237
+ "id": "{myid}"
425
238
  }
426
239
  }
427
240
  ],
428
241
  "isAlive": [
429
242
  {
430
- "path": "/get/devices/{id}/status",
243
+ "path": "/not/mapped/{devID}",
431
244
  "method": "GET",
432
245
  "query": {},
433
246
  "body": {},
434
247
  "headers": {},
435
248
  "handleFailure": "ignore",
436
249
  "requestFields": {
437
- "id": "name"
250
+ "devID": "{id}"
438
251
  },
439
252
  "responseDatakey": "",
440
253
  "responseFields": {
441
- "status": "status",
442
- "statusValue": "online"
254
+ "status": "return2xx",
255
+ "statusValue": "AD.200"
443
256
  }
444
257
  }
445
258
  ],
446
259
  "getConfig": [
447
260
  {
448
- "path": "/get/devices/{id}/configPart1",
261
+ "path": "/not/mapped/{devID}",
449
262
  "method": "GET",
450
263
  "query": {},
451
264
  "body": {},
452
265
  "headers": {},
453
266
  "handleFailure": "ignore",
454
267
  "requestFields": {
455
- "id": "name"
268
+ "devID": "{id}"
456
269
  },
457
270
  "responseDatakey": "",
458
271
  "responseFields": {}
@@ -460,7 +273,7 @@ This section defines **all** the properties that are available for the adapter,
460
273
  ],
461
274
  "getCount": [
462
275
  {
463
- "path": "/get/devices",
276
+ "path": "/not/mapped",
464
277
  "method": "GET",
465
278
  "query": {},
466
279
  "body": {},
@@ -476,15 +289,15 @@ This section defines **all** the properties that are available for the adapter,
476
289
  "enabled": false,
477
290
  "entities": [
478
291
  {
479
- "entityType": "",
480
- "frequency": 1440,
292
+ "entityType": "device",
293
+ "frequency": 3600,
481
294
  "flushOnFail": false,
482
- "limit": 1000,
295
+ "limit": 10000,
483
296
  "retryAttempts": 5,
484
297
  "sort": true,
485
298
  "populate": [
486
299
  {
487
- "path": "",
300
+ "path": "/not/mapped",
488
301
  "method": "GET",
489
302
  "pagination": {
490
303
  "offsetVar": "",
@@ -498,7 +311,15 @@ This section defines **all** the properties that are available for the adapter,
498
311
  "handleFailure": "ignore",
499
312
  "requestFields": {},
500
313
  "responseDatakey": "",
501
- "responseFields": {}
314
+ "responseFields": {
315
+ "name": "{this}{||}{that}",
316
+ "ostype": "{osfield}",
317
+ "ostypePrefix": "meraki-",
318
+ "port": "{port}",
319
+ "ipaddress": "{ip_addr}",
320
+ "serial": "{serial}",
321
+ "id": "{myid}"
322
+ }
502
323
  }
503
324
  ],
504
325
  "cachedTasks": [
@@ -513,2142 +334,7 @@ This section defines **all** the properties that are available for the adapter,
513
334
  }
514
335
  }
515
336
  ```
337
+ ### [Swagger](https://gitlab.com/itentialopensource/adapters/cloud/adapter-microsoft_graph/-/blob/master/report/adapter-openapi.json)
516
338
 
517
- ### Connection Properties
518
-
519
- These base properties are used to connect to Microsoft_graph upon the adapter initially coming up. It is important to set these properties appropriately.
520
-
521
- <table border="1" class="bordered-table">
522
- <tr>
523
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
524
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
525
- </tr>
526
- <tr>
527
- <td style="padding:15px">host</td>
528
- <td style="padding:15px">Required. A fully qualified domain name or IP address.</td>
529
- </tr>
530
- <tr>
531
- <td style="padding:15px">port</td>
532
- <td style="padding:15px">Required. Used to connect to the server.</td>
533
- </tr>
534
- <tr>
535
- <td style="padding:15px">base_path</td>
536
- <td style="padding:15px">Optional. Used to define part of a path that is consistent for all or most endpoints. It makes the URIs easier to use and maintain but can be overridden on individual calls. An example **base_path** might be `/rest/api`. Default is ``.</td>
537
- </tr>
538
- <tr>
539
- <td style="padding:15px">version</td>
540
- <td style="padding:15px">Optional. Used to set a global version for action endpoints. This makes it faster to update the adapter when endpoints change. As with the base-path, version can be overridden on individual endpoints. Default is ``.</td>
541
- </tr>
542
- <tr>
543
- <td style="padding:15px">cache_location</td>
544
- <td style="padding:15px">Optional. Used to define where the adapter cache is located. The cache is used to maintain an entity list to improve performance. Storage locally is lost when the adapter is restarted. Storage in Redis is preserved upon adapter restart. Default is none which means no caching of the entity list.</td>
545
- </tr>
546
- <tr>
547
- <td style="padding:15px">encode_pathvars</td>
548
- <td style="padding:15px">Optional. Used to tell the adapter to encode path variables or not. The default behavior is to encode them so this property can be used to stop that behavior.</td>
549
- </tr>
550
- <tr>
551
- <td style="padding:15px">encode_queryvars</td>
552
- <td style="padding:15px">Optional. Used to tell the adapter to encode query parameters or not. The default behavior is to encode them so this property can be used to stop that behavior.</td>
553
- </tr>
554
- <tr>
555
- <td style="padding:15px">save_metric</td>
556
- <td style="padding:15px">Optional. Used to tell the adapter to save metric information (this does not impact metrics returned on calls). This allows the adapter to gather metrics over time. Metric data can be stored in a database or on the file system.</td>
557
- </tr>
558
- <tr>
559
- <td style="padding:15px">stub</td>
560
- <td style="padding:15px">Optional. Indicates whether the stub should run instead of making calls to Microsoft_graph (very useful during basic testing). Default is false (which means connect to Microsoft_graph).</td>
561
- </tr>
562
- <tr>
563
- <td style="padding:15px">protocol</td>
564
- <td style="padding:15px">Optional. Notifies the adapter whether to use HTTP or HTTPS. Default is HTTP.</td>
565
- </tr>
566
- </table>
567
- <br>
568
-
569
- A connectivity check tells IAP the adapter has loaded successfully.
570
-
571
- ### Authentication Properties
572
-
573
- The following properties are used to define the authentication process to Microsoft_graph.
574
-
575
- >**Note**: Depending on the method that is used to authenticate with Microsoft_graph, you may not need to set all of the authentication properties.
576
-
577
- <table border="1" class="bordered-table">
578
- <tr>
579
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
580
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
581
- </tr>
582
- <tr>
583
- <td style="padding:15px">auth_method</td>
584
- <td style="padding:15px">Required. Used to define the type of authentication currently supported. Authentication methods currently supported are: `basic user_password`, `static_token`, `request_token`, and `no_authentication`.</td>
585
- </tr>
586
- <tr>
587
- <td style="padding:15px">username</td>
588
- <td style="padding:15px">Used to authenticate with Microsoft_graph on every request or when pulling a token that will be used in subsequent requests.</td>
589
- </tr>
590
- <tr>
591
- <td style="padding:15px">password</td>
592
- <td style="padding:15px">Used to authenticate with Microsoft_graph on every request or when pulling a token that will be used in subsequent requests.</td>
593
- </tr>
594
- <tr>
595
- <td style="padding:15px">token</td>
596
- <td style="padding:15px">Defines a static token that can be used on all requests. Only used with `static_token` as an authentication method (auth\_method).</td>
597
- </tr>
598
- <tr>
599
- <td style="padding:15px">invalid_token_error</td>
600
- <td style="padding:15px">Defines the HTTP error that is received when the token is invalid. Notifies the adapter to pull a new token and retry the request. Default is 401.</td>
601
- </tr>
602
- <tr>
603
- <td style="padding:15px">token_timeout</td>
604
- <td style="padding:15px">Defines how long a token is valid. Measured in milliseconds. Once a dynamic token is no longer valid, the adapter has to pull a new token. If the token_timeout is set to -1, the adapter will pull a token on every request to Microsoft_graph. If the timeout_token is 0, the adapter will use the expiration from the token response to determine when the token is no longer valid.</td>
605
- </tr>
606
- <tr>
607
- <td style="padding:15px">token_cache</td>
608
- <td style="padding:15px">Used to determine where the token should be stored (local memory or in Redis).</td>
609
- </tr>
610
- <tr>
611
- <td style="padding:15px">auth_field</td>
612
- <td style="padding:15px">Defines the request field the authentication (e.g., token are basic auth credentials) needs to be placed in order for the calls to work.</td>
613
- </tr>
614
- <tr>
615
- <td style="padding:15px">auth_field_format</td>
616
- <td style="padding:15px">Defines the format of the auth\_field. See examples below. Items enclosed in {} inform the adapter to perofrm an action prior to sending the data. It may be to replace the item with a value or it may be to encode the item.</td>
617
- </tr>
618
- <tr>
619
- <td style="padding:15px">auth_logging</td>
620
- <td style="padding:15px">Setting this true will add some additional logs but this should only be done when trying to debug an issue as certain credential information may be logged out when this is true.</td>
621
- </tr>
622
- <tr>
623
- <td style="padding:15px">client_id</td>
624
- <td style="padding:15px">Provide a client id when needed, this is common on some types of OAuth.</td>
625
- </tr>
626
- <tr>
627
- <td style="padding:15px">client_secret</td>
628
- <td style="padding:15px">Provide a client secret when needed, this is common on some types of OAuth.</td>
629
- </tr>
630
- <tr>
631
- <td style="padding:15px">grant_type</td>
632
- <td style="padding:15px">Provide a grant type when needed, this is common on some types of OAuth.</td>
633
- </tr>
634
- </table>
635
- <br>
636
-
637
- #### Examples of authentication field format
638
-
639
- ```json
640
- "{token}"
641
- "Token {token}"
642
- "{username}:{password}"
643
- "Basic {b64}{username}:{password}{/b64}"
644
- ```
645
-
646
- ### Healthcheck Properties
647
-
648
- The healthcheck properties defines the API that runs the healthcheck to tell the adapter that it can reach Microsoft_graph. There are currently three types of healthchecks.
649
-
650
- - None - Not recommended. Adapter will not run a healthcheck. Consequently, unable to determine before making a request if the adapter can reach Microsoft_graph.
651
- - Startup - Adapter will check for connectivity when the adapter initially comes up, but it will not check afterwards.
652
- - Intermittent - Adapter will check connectivity to Microsoft_graph at a frequency defined in the `frequency` property.
653
-
654
- <table border="1" class="bordered-table">
655
- <tr>
656
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
657
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
658
- </tr>
659
- <tr>
660
- <td style="padding:15px">type</td>
661
- <td style="padding:15px">Required. The type of health check to run.</td>
662
- </tr>
663
- <tr>
664
- <td style="padding:15px">frequency</td>
665
- <td style="padding:15px">Required if intermittent. Defines how often the health check should run. Measured in milliseconds. Default is 300000.</td>
666
- </tr>
667
- <tr>
668
- <td style="padding:15px">query_object</td>
669
- <td style="padding:15px">Query parameters to be added to the adapter healthcheck call.</td>
670
- </tr>
671
- </table>
672
- <br>
673
-
674
- ### Request Properties
675
-
676
- The request section defines properties to help handle requests.
677
-
678
- <table border="1" class="bordered-table">
679
- <tr>
680
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
681
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
682
- </tr>
683
- <tr>
684
- <td style="padding:15px">number_redirects</td>
685
- <td style="padding:15px">Optional. Tells the adapter that the request may be redirected and gives it a maximum number of redirects to allow before returning an error. Default is 0 - no redirects.</td>
686
- </tr>
687
- <tr>
688
- <td style="padding:15px">number_retries</td>
689
- <td style="padding:15px">Tells the adapter how many times to retry a request that has either aborted or reached a limit error before giving up and returning an error.</td>
690
- </tr>
691
- <tr>
692
- <td style="padding:15px">limit_retry_error</td>
693
- <td style="padding:15px">Optional. Can be either an integer or an array. Indicates the http error status number to define that no capacity was available and, after waiting a short interval, the adapter can retry the request. If an array is provvided, the array can contain integers or strings. Strings in the array are used to define ranges (e.g. "502-506"). Default is [0].</td>
694
- </tr>
695
- <tr>
696
- <td style="padding:15px">failover_codes</td>
697
- <td style="padding:15px">An array of error codes for which the adapter will send back a failover flag to IAP so that the Platform can attempt the action in another adapter.</td>
698
- </tr>
699
- <tr>
700
- <td style="padding:15px">attempt_timeout</td>
701
- <td style="padding:15px">Optional. Tells how long the adapter should wait before aborting the attempt. On abort, the adapter will do one of two things: 1) return the error; or 2) if **healthcheck\_on\_timeout** is set to true, it will abort the request and run a Healthcheck until it re-establishes connectivity to Microsoft_graph, and then will re-attempt the request that aborted. Default is 5000 milliseconds.</td>
702
- </tr>
703
- <tr>
704
- <td style="padding:15px">global_request</td>
705
- <td style="padding:15px">Optional. This is information that the adapter can include in all requests to the other system. This is easier to define and maintain than adding this information in either the code (adapter.js) or the action files.</td>
706
- </tr>
707
- <tr>
708
- <td style="padding:15px">global_request -> payload</td>
709
- <td style="padding:15px">Optional. Defines any information that should be included on all requests sent to the other system that have a payload/body.</td>
710
- </tr>
711
- <tr>
712
- <td style="padding:15px">global_request -> uriOptions</td>
713
- <td style="padding:15px">Optional. Defines any information that should be sent as untranslated query options (e.g. page, size) on all requests to the other system.</td>
714
- </tr>
715
- <tr>
716
- <td style="padding:15px">global_request -> addlHeaders</td>
717
- <td style="padding:15px">Optioonal. Defines any headers that should be sent on all requests to the other system.</td>
718
- </tr>
719
- <tr>
720
- <td style="padding:15px">global_request -> authData</td>
721
- <td style="padding:15px">Optional. Defines any additional authentication data used to authentice with the other system. This authData needs to be consistent on every request.</td>
722
- </tr>
723
- <tr>
724
- <td style="padding:15px">healthcheck_on_timeout</td>
725
- <td style="padding:15px">Required. Defines if the adapter should run a health check on timeout. If set to true, the adapter will abort the request and run a health check until it re-establishes connectivity and then it will re-attempt the request.</td>
726
- </tr>
727
- <tr>
728
- <td style="padding:15px">return_raw</td>
729
- <td style="padding:15px">Optional. Tells the adapter whether the raw response should be returned as well as the IAP response. This is helpful when running integration tests to save mock data. It does add overhead to the response object so it is not ideal from production.</td>
730
- </tr>
731
- <tr>
732
- <td style="padding:15px">archiving</td>
733
- <td style="padding:15px">Optional flag. Default is false. It archives the request, the results and the various times (wait time, Microsoft_graph time and overall time) in the `adapterid_results` collection in MongoDB. Although archiving might be desirable, be sure to develop a strategy before enabling this capability. Consider how much to archive and what strategy to use for cleaning up the collection in the database so that it does not become too large, especially if the responses are large.</td>
734
- </tr>
735
- <tr>
736
- <td style="padding:15px">return_request</td>
737
- <td style="padding:15px">Optional flag. Default is false. Will return the actual request that is made including headers. This should only be used during debugging issues as there could be credentials in the actual request.</td>
738
- </tr>
739
- </table>
740
- <br>
741
-
742
- ### SSL Properties
743
-
744
- The SSL section defines the properties utilized for ssl authentication with Microsoft_graph. SSL can work two different ways: set the `accept\_invalid\_certs` flag to true (only recommended for lab environments), or provide a `ca\_file`.
745
-
746
- <table border="1" class="bordered-table">
747
- <tr>
748
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
749
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
750
- </tr>
751
- <tr>
752
- <td style="padding:15px">enabled</td>
753
- <td style="padding:15px">If SSL is required, set to true.</td>
754
- </tr>
755
- <tr>
756
- <td style="padding:15px">accept_invalid_certs</td>
757
- <td style="padding:15px">Defines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false.</td>
758
- </tr>
759
- <tr>
760
- <td style="padding:15px">ca_file</td>
761
- <td style="padding:15px">Defines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required.</td>
762
- </tr>
763
- <tr>
764
- <td style="padding:15px">key_file</td>
765
- <td style="padding:15px">Defines the path name to the Key file used for SSL. The key_file may be needed for some systems but it is not required for SSL.</td>
766
- </tr>
767
- <tr>
768
- <td style="padding:15px">cert_file</td>
769
- <td style="padding:15px">Defines the path name to the Certificate file used for SSL. The cert_file may be needed for some systems but it is not required for SSL.</td>
770
- </tr>
771
- <tr>
772
- <td style="padding:15px">secure_protocol</td>
773
- <td style="padding:15px">Defines the protocol (e.g., SSLv3_method) to use on the SSL request.</td>
774
- </tr>
775
- <tr>
776
- <td style="padding:15px">ciphers</td>
777
- <td style="padding:15px">Required if SSL enabled. Specifies a list of SSL ciphers to use.</td>
778
- </tr>
779
- <tr>
780
- <td style="padding:15px">ecdhCurve</td>
781
- <td style="padding:15px">During testing on some Node 8 environments, you need to set `ecdhCurve` to auto. If you do not, you will receive PROTO errors when attempting the calls. This is the only usage of this property and to our knowledge it only impacts Node 8 and 9.</td>
782
- </tr>
783
- </table>
784
- <br>
785
-
786
- ### Throttle Properties
787
-
788
- The throttle section is used when requests to Microsoft_graph must be queued (throttled). All of the properties in this section are optional.
789
-
790
- <table border="1" class="bordered-table">
791
- <tr>
792
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
793
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
794
- </tr>
795
- <tr>
796
- <td style="padding:15px">throttle_enabled</td>
797
- <td style="padding:15px">Default is false. Defines if the adapter should use throttling or not.</td>
798
- </tr>
799
- <tr>
800
- <td style="padding:15px">number_pronghorns</td>
801
- <td style="padding:15px">Default is 1. Defines if throttling is done in a single Itential instance or whether requests are being throttled across multiple Itential instances (minimum = 1, maximum = 20). Throttling in a single Itential instance uses an in-memory queue so there is less overhead. Throttling across multiple Itential instances requires placing the request and queue information into a shared resource (e.g. database) so that each instance can determine what is running and what is next to run. Throttling across multiple instances requires additional I/O overhead.</td>
802
- </tr>
803
- <tr>
804
- <td style="padding:15px">sync-async</td>
805
- <td style="padding:15px">This property is not used at the current time (it is for future expansion of the throttling engine).</td>
806
- </tr>
807
- <tr>
808
- <td style="padding:15px">max_in_queue</td>
809
- <td style="padding:15px">Represents the maximum number of requests the adapter should allow into the queue before rejecting requests (minimum = 1, maximum = 5000). This is not a limit on what the adapter can handle but more about timely responses to requests. The default is currently 1000.</td>
810
- </tr>
811
- <tr>
812
- <td style="padding:15px">concurrent_max</td>
813
- <td style="padding:15px">Defines the number of requests the adapter can send to Microsoft_graph at one time (minimum = 1, maximum = 1000). The default is 1 meaning each request must be sent to Microsoft_graph in a serial manner.</td>
814
- </tr>
815
- <tr>
816
- <td style="padding:15px">expire_timeout</td>
817
- <td style="padding:15px">Default is 0. Defines a graceful timeout of the request session. After a request has completed, the adapter will wait additional time prior to sending the next request. Measured in milliseconds (minimum = 0, maximum = 60000).</td>
818
- </tr>
819
- <tr>
820
- <td style="padding:15px">average_runtime</td>
821
- <td style="padding:15px">Represents the approximate average of how long it takes Microsoft_graph to handle each request. Measured in milliseconds (minimum = 50, maximum = 60000). Default is 200. This metric has performance implications. If the runtime number is set too low, it puts extra burden on the CPU and memory as the requests will continually try to run. If the runtime number is set too high, requests may wait longer than they need to before running. The number does not need to be exact but your throttling strategy depends heavily on this number being within reason. If averages range from 50 to 250 milliseconds you might pick an average run-time somewhere in the middle so that when Microsoft_graph performance is exceptional you might run a little slower than you might like, but when it is poor you still run efficiently.</td>
822
- </tr>
823
- <tr>
824
- <td style="padding:15px">priorities</td>
825
- <td style="padding:15px">An array of priorities and how to handle them in relation to the throttle queue. Array of objects that include priority value and percent of queue to put the item ex { value: 1, percent: 10 }</td>
826
- </tr>
827
- </table>
828
- <br>
829
-
830
- ### Proxy Properties
831
-
832
- The proxy section defines the properties to utilize when Microsoft_graph is behind a proxy server.
833
-
834
- <table border="1" class="bordered-table">
835
- <tr>
836
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
837
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
838
- </tr>
839
- <tr>
840
- <td style="padding:15px">enabled</td>
841
- <td style="padding:15px">Required. Default is false. If Microsoft_graph is behind a proxy server, set enabled flag to true.</td>
842
- </tr>
843
- <tr>
844
- <td style="padding:15px">host</td>
845
- <td style="padding:15px">Host information for the proxy server. Required if `enabled` is true.</td>
846
- </tr>
847
- <tr>
848
- <td style="padding:15px">port</td>
849
- <td style="padding:15px">Port information for the proxy server. Required if `enabled` is true.</td>
850
- </tr>
851
- <tr>
852
- <td style="padding:15px">protocol</td>
853
- <td style="padding:15px">The protocol (i.e., http, https, etc.) used to connect to the proxy. Default is http.</td>
854
- </tr>
855
- <tr>
856
- <td style="padding:15px">username</td>
857
- <td style="padding:15px">If there is authentication for the proxy, provide the username here.</td>
858
- </tr>
859
- <tr>
860
- <td style="padding:15px">password</td>
861
- <td style="padding:15px">If there is authentication for the proxy, provide the password here.</td>
862
- </tr>
863
- </table>
864
- <br>
865
-
866
- ### Mongo Properties
867
-
868
- The mongo section defines the properties used to connect to a Mongo database. Mongo can be used for throttling as well as to persist metric data. If not provided, metrics will be stored in the file system.
869
-
870
- <table border="1" class="bordered-table">
871
- <tr>
872
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
873
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
874
- </tr>
875
- <tr>
876
- <td style="padding:15px">host</td>
877
- <td style="padding:15px">Optional. Host information for the mongo server.</td>
878
- </tr>
879
- <tr>
880
- <td style="padding:15px">port</td>
881
- <td style="padding:15px">Optional. Port information for the mongo server.</td>
882
- </tr>
883
- <tr>
884
- <td style="padding:15px">database</td>
885
- <td style="padding:15px">Optional. The database for the adapter to use for its data.</td>
886
- </tr>
887
- <tr>
888
- <td style="padding:15px">username</td>
889
- <td style="padding:15px">Optional. If credentials are required to access mongo, this is the user to login as.</td>
890
- </tr>
891
- <tr>
892
- <td style="padding:15px">password</td>
893
- <td style="padding:15px">Optional. If credentials are required to access mongo, this is the password to login with.</td>
894
- </tr>
895
- <tr>
896
- <td style="padding:15px">replSet</td>
897
- <td style="padding:15px">Optional. If the database is set up to use replica sets, define it here so it can be added to the database connection.</td>
898
- </tr>
899
- <tr>
900
- <td style="padding:15px">db_ssl</td>
901
- <td style="padding:15px">Optional. Contains information for SSL connectivity to the database.</td>
902
- </tr>
903
- <tr>
904
- <td style="padding:15px">db_ssl -> enabled</td>
905
- <td style="padding:15px">If SSL is required, set to true.</td>
906
- </tr>
907
- <tr>
908
- <td style="padding:15px">db_ssl -> accept_invalid_cert</td>
909
- <td style="padding:15px">Defines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false.</td>
910
- </tr>
911
- <tr>
912
- <td style="padding:15px">db_ssl -> ca_file</td>
913
- <td style="padding:15px">Defines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required.</td>
914
- </tr>
915
- <tr>
916
- <td style="padding:15px">db_ssl -> key_file</td>
917
- <td style="padding:15px">Defines the path name to the Key file used for SSL. The key_file may be needed for some systems but it is not required for SSL.</td>
918
- </tr>
919
- <tr>
920
- <td style="padding:15px">db_ssl -> cert_file</td>
921
- <td style="padding:15px">Defines the path name to the Certificate file used for SSL. The cert_file may be needed for some systems but it is not required for SSL.</td>
922
- </tr>
923
- </table>
924
- <br>
925
-
926
- ### Device Broker Properties
927
-
928
- The device broker section defines the properties used integrate Microsoft_graph to the device broker. Each broker call is represented and has an array of calls that can be used to build the response. This describes the calls and then the fields which are available in the calls.
929
-
930
- <table border="1" class="bordered-table">
931
- <tr>
932
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
933
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
934
- </tr>
935
- <tr>
936
- <td style="padding:15px">getDevice</td>
937
- <td style="padding:15px">The array of calls used to get device details for the broker</td>
938
- </tr>
939
- <tr>
940
- <td style="padding:15px">getDevicesFiltered</td>
941
- <td style="padding:15px">The array of calls used to get devices for the broker</td>
942
- </tr>
943
- <tr>
944
- <td style="padding:15px">isAlive</td>
945
- <td style="padding:15px">The array of calls used to get device status for the broker</td>
946
- </tr>
947
- <tr>
948
- <td style="padding:15px">getConfig</td>
949
- <td style="padding:15px">The array of calls used to get device configuration for the broker</td>
950
- </tr>
951
- <tr>
952
- <td style="padding:15px">getCount</td>
953
- <td style="padding:15px">The array of calls used to get device configuration for the broker</td>
954
- </tr>
955
- <tr>
956
- <td style="padding:15px">getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> path</td>
957
- <td style="padding:15px">The path, not including the base_path and version, for making this call</td>
958
- </tr>
959
- <tr>
960
- <td style="padding:15px">getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> method</td>
961
- <td style="padding:15px">The rest method for making this call</td>
962
- </tr>
963
- <tr>
964
- <td style="padding:15px">getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> query</td>
965
- <td style="padding:15px">Query object containing and query parameters and their values for this call</td>
966
- </tr>
967
- <tr>
968
- <td style="padding:15px">getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> body</td>
969
- <td style="padding:15px">Body object containing the payload for this call</td>
970
- </tr>
971
- <tr>
972
- <td style="padding:15px">getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> headers</td>
973
- <td style="padding:15px">Header object containing the headers for this call.</td>
974
- </tr>
975
- <tr>
976
- <td style="padding:15px">getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> handleFailure</td>
977
- <td style="padding:15px">Tells the adapter whether to "fail" or "ignore" failures if they occur.</td>
978
- </tr>
979
- <tr>
980
- <td style="padding:15px">isAlive -> statusValue</td>
981
- <td style="padding:15px">Tells the adapter what value to look for in the status field to determine if the device is alive.</td>
982
- </tr>
983
- <tr>
984
- <td style="padding:15px">getDevice/getDevicesFiltered/isAlive/getConfig -> requestFields</td>
985
- <td style="padding:15px">Object containing fields the adapter should send on the request and where it should get the data. The where can be from a response to a getDevicesFiltered or a static value.</td>
986
- </tr>
987
- <tr>
988
- <td style="padding:15px">getDevice/getDevicesFiltered/isAlive/getConfig -> responseFields</td>
989
- <td style="padding:15px">Object containing fields the adapter should set to send back to iap and where the value should come from in the response or request data.</td>
990
- </tr>
991
- </table>
992
- <br>
993
-
994
-
995
- ## Using this Adapter
996
-
997
- The `adapter.js` file contains the calls the adapter makes available to the rest of the Itential Platform. The API detailed for these calls should be available through JSDOC. The following is a brief summary of the calls.
998
-
999
- ### Generic Adapter Calls
1000
-
1001
- These are adapter methods that IAP or you might use. There are some other methods not shown here that might be used for internal adapter functionality.
1002
-
1003
- <table border="1" class="bordered-table">
1004
- <tr>
1005
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
1006
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
1007
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
1008
- </tr>
1009
- <tr>
1010
- <td style="padding:15px">connect()</td>
1011
- <td style="padding:15px">This call is run when the Adapter is first loaded by he Itential Platform. It validates the properties have been provided correctly.</td>
1012
- <td style="padding:15px">No</td>
1013
- </tr>
1014
- <tr>
1015
- <td style="padding:15px">healthCheck(callback)</td>
1016
- <td style="padding:15px">This call ensures that the adapter can communicate with Adapter for ServiceNow. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
1017
- <td style="padding:15px">No</td>
1018
- </tr>
1019
- <tr>
1020
- <td style="padding:15px">refreshProperties(properties)</td>
1021
- <td style="padding:15px">This call provides the adapter the ability to accept property changes without having to restart the adapter.</td>
1022
- <td style="padding:15px">No</td>
1023
- </tr>
1024
- <tr>
1025
- <td style="padding:15px">encryptProperty(property, technique, callback)</td>
1026
- <td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Adapter for ServiceNow.</td>
1027
- <td style="padding:15px">No</td>
1028
- </tr>
1029
- <tr>
1030
- <td style="padding:15px">iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback)</td>
1031
- <td style="padding:15px">This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.</td>
1032
- <td style="padding:15px">Yes</td>
1033
- </tr>
1034
- <tr>
1035
- <td style="padding:15px">iapSuspendAdapter(mode, callback)</td>
1036
- <td style="padding:15px">This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.</td>
1037
- <td style="padding:15px">Yes</td>
1038
- </tr>
1039
- <tr>
1040
- <td style="padding:15px">iapUnsuspendAdapter(callback)</td>
1041
- <td style="padding:15px">This call provides the ability to resume a suspended adapter. Any requests in queue will be processed before new requests.</td>
1042
- <td style="padding:15px">Yes</td>
1043
- </tr>
1044
- <tr>
1045
- <td style="padding:15px">iapGetAdapterQueue(callback)</td>
1046
- <td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</td>
1047
- <td style="padding:15px">Yes</td>
1048
- </tr>
1049
- <tr>
1050
- <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
1051
- <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
1052
- <td style="padding:15px">Yes</td>
1053
- </tr>
1054
- <tr>
1055
- <td style="padding:15px">iapTroubleshootAdapter(props, persistFlag, adapter, callback)</td>
1056
- <td style="padding:15px">This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.</td>
1057
- <td style="padding:15px">Yes</td>
1058
- </tr>
1059
- <tr>
1060
- <td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td>
1061
- <td style="padding:15px">This call will return the results of a healthcheck.</td>
1062
- <td style="padding:15px">Yes</td>
1063
- </tr>
1064
- <tr>
1065
- <td style="padding:15px">iapRunAdapterConnectivity(callback)</td>
1066
- <td style="padding:15px">This call will return the results of a connectivity check.</td>
1067
- <td style="padding:15px">Yes</td>
1068
- </tr>
1069
- <tr>
1070
- <td style="padding:15px">iapRunAdapterBasicGet(callback)</td>
1071
- <td style="padding:15px">This call will return the results of running basic get API calls.</td>
1072
- <td style="padding:15px">Yes</td>
1073
- </tr>
1074
- <tr>
1075
- <td style="padding:15px">iapMoveAdapterEntitiesToDB(callback)</td>
1076
- <td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.</td>
1077
- <td style="padding:15px">Yes</td>
1078
- </tr>
1079
- <tr>
1080
- <td style="padding:15px">iapDeactivateTasks(tasks, callback)</td>
1081
- <td style="padding:15px">This call provides the ability to remove tasks from the adapter.</td>
1082
- <td style="padding:15px">Yes</td>
1083
- </tr>
1084
- <tr>
1085
- <td style="padding:15px">iapActivateTasks(tasks, callback)</td>
1086
- <td style="padding:15px">This call provides the ability to add deactivated tasks back into the adapter.</td>
1087
- <td style="padding:15px">Yes</td>
1088
- </tr>
1089
- <tr>
1090
- <td style="padding:15px">iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)</td>
1091
- <td style="padding:15px">This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.</td>
1092
- <td style="padding:15px">Yes</td>
1093
- </tr>
1094
- <tr>
1095
- <td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
1096
- <td style="padding:15px">This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.</td>
1097
- <td style="padding:15px">Yes</td>
1098
- </tr>
1099
- <tr>
1100
- <td style="padding:15px">genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
1101
- <td style="padding:15px">This call is the same as the genericAdapterRequest only it does not add a base_path or version to the call.</td>
1102
- <td style="padding:15px">Yes</td>
1103
- </tr>
1104
- <tr>
1105
- <td style="padding:15px">iapRunAdapterLint(callback)</td>
1106
- <td style="padding:15px">Runs lint on the addapter and provides the information back.</td>
1107
- <td style="padding:15px">Yes</td>
1108
- </tr>
1109
- <tr>
1110
- <td style="padding:15px">iapRunAdapterTests(callback)</td>
1111
- <td style="padding:15px">Runs baseunit and unit tests on the adapter and provides the information back.</td>
1112
- <td style="padding:15px">Yes</td>
1113
- </tr>
1114
- <tr>
1115
- <td style="padding:15px">iapGetAdapterInventory(callback)</td>
1116
- <td style="padding:15px">This call provides some inventory related information about the adapter.</td>
1117
- <td style="padding:15px">Yes</td>
1118
- </tr>
1119
- </table>
1120
- <br>
1121
-
1122
- ### Adapter Cache Calls
1123
-
1124
- These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.
1125
-
1126
- <table border="1" class="bordered-table">
1127
- <tr>
1128
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
1129
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
1130
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
1131
- </tr>
1132
- <tr>
1133
- <td style="padding:15px">iapPopulateEntityCache(entityTypes, callback)</td>
1134
- <td style="padding:15px">This call populates the adapter cache.</td>
1135
- <td style="padding:15px">Yes</td>
1136
- </tr>
1137
- <tr>
1138
- <td style="padding:15px">iapRetrieveEntitiesCache(entityType, options, callback)</td>
1139
- <td style="padding:15px">This call retrieves the specific items from the adapter cache.</td>
1140
- <td style="padding:15px">Yes</td>
1141
- </tr>
1142
- </table>
1143
- <br>
1144
-
1145
- ### Adapter Broker Calls
1146
-
1147
- These are adapter methods that are used to integrate to IAP Brokers. This adapter currently supports the following broker calls.
1148
-
1149
- <table border="1" class="bordered-table">
1150
- <tr>
1151
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
1152
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
1153
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
1154
- </tr>
1155
- <tr>
1156
- <td style="padding:15px">hasEntities(entityType, entityList, callback)</td>
1157
- <td style="padding:15px">This call is utilized by the IAP Device Broker to determine if the adapter has a specific entity and item of the entity.</td>
1158
- <td style="padding:15px">No</td>
1159
- </tr>
1160
- <tr>
1161
- <td style="padding:15px">getDevice(deviceName, callback)</td>
1162
- <td style="padding:15px">This call returns the details of the requested device.</td>
1163
- <td style="padding:15px">No</td>
1164
- </tr>
1165
- <tr>
1166
- <td style="padding:15px">getDevicesFiltered(options, callback)</td>
1167
- <td style="padding:15px">This call returns the list of devices that match the criteria provided in the options filter.</td>
1168
- <td style="padding:15px">No</td>
1169
- </tr>
1170
- <tr>
1171
- <td style="padding:15px">isAlive(deviceName, callback)</td>
1172
- <td style="padding:15px">This call returns whether the device status is active</td>
1173
- <td style="padding:15px">No</td>
1174
- </tr>
1175
- <tr>
1176
- <td style="padding:15px">getConfig(deviceName, format, callback)</td>
1177
- <td style="padding:15px">This call returns the configuration for the selected device.</td>
1178
- <td style="padding:15px">No</td>
1179
- </tr>
1180
- <tr>
1181
- <td style="padding:15px">iapGetDeviceCount(callback)</td>
1182
- <td style="padding:15px">This call returns the count of devices.</td>
1183
- <td style="padding:15px">No</td>
1184
- </tr>
1185
- </table>
1186
- <br>
1187
-
1188
- ### Specific Adapter Calls
1189
-
1190
- Specific adapter calls are built based on the API of the Microsoft_graph. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls.
1191
-
1192
- <table border="1" class="bordered-table">
1193
- <tr>
1194
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
1195
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
1196
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
1197
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
1198
- </tr>
1199
- <tr>
1200
- <td style="padding:15px">getapplications(callback)</td>
1201
- <td style="padding:15px">Get applications</td>
1202
- <td style="padding:15px">{base_path}/{version}/v1.0/applications?{query}</td>
1203
- <td style="padding:15px">Yes</td>
1204
- </tr>
1205
- <tr>
1206
- <td style="padding:15px">createanapplication(body, callback)</td>
1207
- <td style="padding:15px">Create an application</td>
1208
- <td style="padding:15px">{base_path}/{version}/v1.0/applications?{query}</td>
1209
- <td style="padding:15px">Yes</td>
1210
- </tr>
1211
- <tr>
1212
- <td style="padding:15px">getapplication(applicationId, callback)</td>
1213
- <td style="padding:15px">Get application</td>
1214
- <td style="padding:15px">{base_path}/{version}/v1.0/applications/{pathv1}?{query}</td>
1215
- <td style="padding:15px">Yes</td>
1216
- </tr>
1217
- <tr>
1218
- <td style="padding:15px">updateapplication(applicationId, body, callback)</td>
1219
- <td style="padding:15px">Update application</td>
1220
- <td style="padding:15px">{base_path}/{version}/v1.0/applications/{pathv1}?{query}</td>
1221
- <td style="padding:15px">Yes</td>
1222
- </tr>
1223
- <tr>
1224
- <td style="padding:15px">getapplicationowners(applicationId, callback)</td>
1225
- <td style="padding:15px">Get application owners</td>
1226
- <td style="padding:15px">{base_path}/{version}/v1.0/applications/{pathv1}/owners?{query}</td>
1227
- <td style="padding:15px">Yes</td>
1228
- </tr>
1229
- <tr>
1230
- <td style="padding:15px">deleteapplication(applicationId, callback)</td>
1231
- <td style="padding:15px">Delete application</td>
1232
- <td style="padding:15px">{base_path}/{version}/beta/applications/{pathv1}?{query}</td>
1233
- <td style="padding:15px">Yes</td>
1234
- </tr>
1235
- <tr>
1236
- <td style="padding:15px">performparallelGETS(body, callback)</td>
1237
- <td style="padding:15px">Perform parallel GETS</td>
1238
- <td style="padding:15px">{base_path}/{version}/v1.0/$batch?{query}</td>
1239
- <td style="padding:15px">Yes</td>
1240
- </tr>
1241
- <tr>
1242
- <td style="padding:15px">createsubjectRightsRequest(body, callback)</td>
1243
- <td style="padding:15px">Create subjectRightsRequest</td>
1244
- <td style="padding:15px">{base_path}/{version}/v1.0/privacy/subjectRightsRequests?{query}</td>
1245
- <td style="padding:15px">Yes</td>
1246
- </tr>
1247
- <tr>
1248
- <td style="padding:15px">listsubjectRightsRequests(callback)</td>
1249
- <td style="padding:15px">List subjectRightsRequests</td>
1250
- <td style="padding:15px">{base_path}/{version}/v1.0/privacy/subjectRightsRequests?{query}</td>
1251
- <td style="padding:15px">Yes</td>
1252
- </tr>
1253
- <tr>
1254
- <td style="padding:15px">getsubjectRightsRequest(subjectRightsRequestId, callback)</td>
1255
- <td style="padding:15px">Get subjectRightsRequest</td>
1256
- <td style="padding:15px">{base_path}/{version}/v1.0/privacy/subjectRightsRequests/{pathv1}?{query}</td>
1257
- <td style="padding:15px">Yes</td>
1258
- </tr>
1259
- <tr>
1260
- <td style="padding:15px">subjectRightsRequestGetFinalReport(subjectRightsRequestId, callback)</td>
1261
- <td style="padding:15px">subjectRightsRequest: getFinalReport</td>
1262
- <td style="padding:15px">{base_path}/{version}/v1.0/privacy/subjectRightsRequests/{pathv1}/getFinalReport?{query}</td>
1263
- <td style="padding:15px">Yes</td>
1264
- </tr>
1265
- <tr>
1266
- <td style="padding:15px">subjectRightsRequestGetFinalAttachment(subjectRightsRequestId, callback)</td>
1267
- <td style="padding:15px">subjectRightsRequest: getFinalAttachment</td>
1268
- <td style="padding:15px">{base_path}/{version}/v1.0/privacy/subjectRightsRequests/{pathv1}/getFinalAttachment?{query}</td>
1269
- <td style="padding:15px">Yes</td>
1270
- </tr>
1271
- <tr>
1272
- <td style="padding:15px">createauthoredNote(subjectRightsRequestId, body, callback)</td>
1273
- <td style="padding:15px">Create authoredNote</td>
1274
- <td style="padding:15px">{base_path}/{version}/v1.0/privacy/subjectRightsRequests/{pathv1}/notes?{query}</td>
1275
- <td style="padding:15px">Yes</td>
1276
- </tr>
1277
- <tr>
1278
- <td style="padding:15px">listnotes(subjectRightsRequestId, callback)</td>
1279
- <td style="padding:15px">List notes</td>
1280
- <td style="padding:15px">{base_path}/{version}/v1.0/privacy/subjectRightsRequests/{pathv1}/notes?{query}</td>
1281
- <td style="padding:15px">Yes</td>
1282
- </tr>
1283
- <tr>
1284
- <td style="padding:15px">listretentionLabels(callback)</td>
1285
- <td style="padding:15px">List retentionLabels</td>
1286
- <td style="padding:15px">{base_path}/{version}/beta/security/labels/retentionLabels?{query}</td>
1287
- <td style="padding:15px">Yes</td>
1288
- </tr>
1289
- <tr>
1290
- <td style="padding:15px">createretentionLabel(body, callback)</td>
1291
- <td style="padding:15px">Create retentionLabel</td>
1292
- <td style="padding:15px">{base_path}/{version}/beta/security/labels/retentionLabels?{query}</td>
1293
- <td style="padding:15px">Yes</td>
1294
- </tr>
1295
- <tr>
1296
- <td style="padding:15px">getretentionLabel(retentionLabelId, callback)</td>
1297
- <td style="padding:15px">Get retentionLabel</td>
1298
- <td style="padding:15px">{base_path}/{version}/beta/security/labels/retentionLabels/{pathv1}?{query}</td>
1299
- <td style="padding:15px">Yes</td>
1300
- </tr>
1301
- <tr>
1302
- <td style="padding:15px">updateretentionLabel(retentionLabelId, body, callback)</td>
1303
- <td style="padding:15px">Update retentionLabel</td>
1304
- <td style="padding:15px">{base_path}/{version}/beta/security/labels/retentionLabels/{pathv1}?{query}</td>
1305
- <td style="padding:15px">Yes</td>
1306
- </tr>
1307
- <tr>
1308
- <td style="padding:15px">deleterentionionLabel(retentionLabelId, callback)</td>
1309
- <td style="padding:15px">Delete rentionionLabel</td>
1310
- <td style="padding:15px">{base_path}/{version}/beta/security/labels/retentionLabels/{pathv1}?{query}</td>
1311
- <td style="padding:15px">Yes</td>
1312
- </tr>
1313
- <tr>
1314
- <td style="padding:15px">listretentionEventTypes(callback)</td>
1315
- <td style="padding:15px">List retentionEventTypes</td>
1316
- <td style="padding:15px">{base_path}/{version}/beta/security/triggerTypes/retentionEventTypes?{query}</td>
1317
- <td style="padding:15px">Yes</td>
1318
- </tr>
1319
- <tr>
1320
- <td style="padding:15px">getretentionEventType(retentionEventTypeId, callback)</td>
1321
- <td style="padding:15px">Get retentionEventType</td>
1322
- <td style="padding:15px">{base_path}/{version}/beta/security/triggerTypes/retentionEventTypes/{pathv1}?{query}</td>
1323
- <td style="padding:15px">Yes</td>
1324
- </tr>
1325
- <tr>
1326
- <td style="padding:15px">createretentionEvent(body, callback)</td>
1327
- <td style="padding:15px">Create retentionEvent</td>
1328
- <td style="padding:15px">{base_path}/{version}/beta/security/triggers/retentionEvents?{query}</td>
1329
- <td style="padding:15px">Yes</td>
1330
- </tr>
1331
- <tr>
1332
- <td style="padding:15px">listretentionEvents(callback)</td>
1333
- <td style="padding:15px">List retentionEvents</td>
1334
- <td style="padding:15px">{base_path}/{version}/beta/security/triggers/retentionEvents?{query}</td>
1335
- <td style="padding:15px">Yes</td>
1336
- </tr>
1337
- <tr>
1338
- <td style="padding:15px">getretentionEvent(retentionEventId, callback)</td>
1339
- <td style="padding:15px">Get retentionEvent</td>
1340
- <td style="padding:15px">{base_path}/{version}/beta/security/triggers/retentionEvents/{pathv1}?{query}</td>
1341
- <td style="padding:15px">Yes</td>
1342
- </tr>
1343
- <tr>
1344
- <td style="padding:15px">getrooms(callback)</td>
1345
- <td style="padding:15px">Get rooms</td>
1346
- <td style="padding:15px">{base_path}/{version}/beta/me/findRooms?{query}</td>
1347
- <td style="padding:15px">Yes</td>
1348
- </tr>
1349
- <tr>
1350
- <td style="padding:15px">getmyeventsfornextweek(startdatetime, enddatetime, callback)</td>
1351
- <td style="padding:15px">Get my events for next week</td>
1352
- <td style="padding:15px">{base_path}/{version}/v1.0/me/calendarview?{query}</td>
1353
- <td style="padding:15px">Yes</td>
1354
- </tr>
1355
- <tr>
1356
- <td style="padding:15px">getmycalendars(callback)</td>
1357
- <td style="padding:15px">Get my calendars</td>
1358
- <td style="padding:15px">{base_path}/{version}/v1.0/me/calendars?{query}</td>
1359
- <td style="padding:15px">Yes</td>
1360
- </tr>
1361
- <tr>
1362
- <td style="padding:15px">addMicrosoftGraphcommunitycallevent(body, callback)</td>
1363
- <td style="padding:15px">Add Microsoft Graph community call event</td>
1364
- <td style="padding:15px">{base_path}/{version}/v1.0/me/events?{query}</td>
1365
- <td style="padding:15px">Yes</td>
1366
- </tr>
1367
- <tr>
1368
- <td style="padding:15px">getmyMicrosoftGraphcommunitycallevents(filter, callback)</td>
1369
- <td style="padding:15px">Get my Microsoft Graph community call events</td>
1370
- <td style="padding:15px">{base_path}/{version}/v1.0/me/events?{query}</td>
1371
- <td style="padding:15px">Yes</td>
1372
- </tr>
1373
- <tr>
1374
- <td style="padding:15px">getmyfiles(callback)</td>
1375
- <td style="padding:15px">Get my files</td>
1376
- <td style="padding:15px">{base_path}/{version}/v1.0/me/drive/root/children?{query}</td>
1377
- <td style="padding:15px">Yes</td>
1378
- </tr>
1379
- <tr>
1380
- <td style="padding:15px">createafolder(body, callback)</td>
1381
- <td style="padding:15px">Create a folder</td>
1382
- <td style="padding:15px">{base_path}/{version}/v1.0/me/drive/root/children?{query}</td>
1383
- <td style="padding:15px">Yes</td>
1384
- </tr>
1385
- <tr>
1386
- <td style="padding:15px">getmyrecentfiles(callback)</td>
1387
- <td style="padding:15px">Get my recent files</td>
1388
- <td style="padding:15px">{base_path}/{version}/v1.0/me/drive/recent?{query}</td>
1389
- <td style="padding:15px">Yes</td>
1390
- </tr>
1391
- <tr>
1392
- <td style="padding:15px">getfilessharedwithme(callback)</td>
1393
- <td style="padding:15px">Get files shared with me</td>
1394
- <td style="padding:15px">{base_path}/{version}/v1.0/me/drive/sharedWithMe?{query}</td>
1395
- <td style="padding:15px">Yes</td>
1396
- </tr>
1397
- <tr>
1398
- <td style="padding:15px">searchmyOneDrive(select, callback)</td>
1399
- <td style="padding:15px">Search my OneDrive</td>
1400
- <td style="padding:15px">{base_path}/{version}/v1.0/me/drive/root/search(q=&#39;finance&#39;)?{query}</td>
1401
- <td style="padding:15px">Yes</td>
1402
- </tr>
1403
- <tr>
1404
- <td style="padding:15px">getgroups(callback)</td>
1405
- <td style="padding:15px">Get groups</td>
1406
- <td style="padding:15px">{base_path}/{version}/v1.0/groups?{query}</td>
1407
- <td style="padding:15px">Yes</td>
1408
- </tr>
1409
- <tr>
1410
- <td style="padding:15px">createagroupwithextension(body, callback)</td>
1411
- <td style="padding:15px">Create a group with extension</td>
1412
- <td style="padding:15px">{base_path}/{version}/v1.0/groups?{query}</td>
1413
- <td style="padding:15px">Yes</td>
1414
- </tr>
1415
- <tr>
1416
- <td style="padding:15px">getavaiableschemaextensions(callback)</td>
1417
- <td style="padding:15px">Get avaiable schema extensions</td>
1418
- <td style="padding:15px">{base_path}/{version}/v1.0/schemaExtensions?{query}</td>
1419
- <td style="padding:15px">Yes</td>
1420
- </tr>
1421
- <tr>
1422
- <td style="padding:15px">updateagroupwithextension(groupId, body, callback)</td>
1423
- <td style="padding:15px">Update a group with extension</td>
1424
- <td style="padding:15px">{base_path}/{version}/v1.0/groups/{pathv1}?{query}</td>
1425
- <td style="padding:15px">Yes</td>
1426
- </tr>
1427
- <tr>
1428
- <td style="padding:15px">deleteteam(groupId, callback)</td>
1429
- <td style="padding:15px">Delete team</td>
1430
- <td style="padding:15px">{base_path}/{version}/v1.0/groups/{pathv1}?{query}</td>
1431
- <td style="padding:15px">Yes</td>
1432
- </tr>
1433
- <tr>
1434
- <td style="padding:15px">getmyjoinedteams(callback)</td>
1435
- <td style="padding:15px">Get my joined teams</td>
1436
- <td style="padding:15px">{base_path}/{version}/v1.0/me/joinedTeams?{query}</td>
1437
- <td style="padding:15px">Yes</td>
1438
- </tr>
1439
- <tr>
1440
- <td style="padding:15px">getmembersofateam(teamId, callback)</td>
1441
- <td style="padding:15px">Get members of a team</td>
1442
- <td style="padding:15px">{base_path}/{version}/v1.0/groups/{pathv1}/members?{query}</td>
1443
- <td style="padding:15px">Yes</td>
1444
- </tr>
1445
- <tr>
1446
- <td style="padding:15px">getchannelsofateam(teamId, callback)</td>
1447
- <td style="padding:15px">Get channels of a team</td>
1448
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/channels?{query}</td>
1449
- <td style="padding:15px">Yes</td>
1450
- </tr>
1451
- <tr>
1452
- <td style="padding:15px">createchannel(teamId, body, callback)</td>
1453
- <td style="padding:15px">Create channel</td>
1454
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/channels?{query}</td>
1455
- <td style="padding:15px">Yes</td>
1456
- </tr>
1457
- <tr>
1458
- <td style="padding:15px">getchannelinfo(teamId, channelId, callback)</td>
1459
- <td style="padding:15px">Get channel info</td>
1460
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/channels/{pathv2}?{query}</td>
1461
- <td style="padding:15px">Yes</td>
1462
- </tr>
1463
- <tr>
1464
- <td style="padding:15px">createteam(body, callback)</td>
1465
- <td style="padding:15px">Create team</td>
1466
- <td style="padding:15px">{base_path}/{version}/v1.0/teams?{query}</td>
1467
- <td style="padding:15px">Yes</td>
1468
- </tr>
1469
- <tr>
1470
- <td style="padding:15px">getappsinateam(expand, teamId, callback)</td>
1471
- <td style="padding:15px">Get apps in a team</td>
1472
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/installedApps?{query}</td>
1473
- <td style="padding:15px">Yes</td>
1474
- </tr>
1475
- <tr>
1476
- <td style="padding:15px">gettabsinachannel(expand, teamId, channelId, callback)</td>
1477
- <td style="padding:15px">Get tabs in a channel</td>
1478
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/channels/{pathv2}/tabs?{query}</td>
1479
- <td style="padding:15px">Yes</td>
1480
- </tr>
1481
- <tr>
1482
- <td style="padding:15px">getitemsinateamdrive(teamId, callback)</td>
1483
- <td style="padding:15px">Get items in a team drive</td>
1484
- <td style="padding:15px">{base_path}/{version}/v1.0/groups/{pathv1}/drive/root/children?{query}</td>
1485
- <td style="padding:15px">Yes</td>
1486
- </tr>
1487
- <tr>
1488
- <td style="padding:15px">getmessagesWithoutrepliesInachannelBeta(teamId, channelId, callback)</td>
1489
- <td style="padding:15px">Get messages (without replies) in a channel (beta)</td>
1490
- <td style="padding:15px">{base_path}/{version}/beta/teams/{pathv1}/channels/{pathv2}/messages?{query}</td>
1491
- <td style="padding:15px">Yes</td>
1492
- </tr>
1493
- <tr>
1494
- <td style="padding:15px">createaplaintextchatthreadBeta(teamId, channelId, body, callback)</td>
1495
- <td style="padding:15px">Create a plain text chat thread (beta)</td>
1496
- <td style="padding:15px">{base_path}/{version}/beta/teams/{pathv1}/channels/{pathv2}/messages?{query}</td>
1497
- <td style="padding:15px">Yes</td>
1498
- </tr>
1499
- <tr>
1500
- <td style="padding:15px">getamessageinachannelBeta(teamId, channelId, messageId, callback)</td>
1501
- <td style="padding:15px">Get a message in a channel (beta)</td>
1502
- <td style="padding:15px">{base_path}/{version}/beta/teams/{pathv1}/channels/{pathv2}/messages/{pathv3}?{query}</td>
1503
- <td style="padding:15px">Yes</td>
1504
- </tr>
1505
- <tr>
1506
- <td style="padding:15px">getrepliestoamessageinachannelBeta(teamId, channelId, messageId, callback)</td>
1507
- <td style="padding:15px">Get replies to a message in a channel (beta)</td>
1508
- <td style="padding:15px">{base_path}/{version}/beta/teams/{pathv1}/channels/{pathv2}/messages/{pathv3}/replies?{query}</td>
1509
- <td style="padding:15px">Yes</td>
1510
- </tr>
1511
- <tr>
1512
- <td style="padding:15px">getareplyofamessageBeta(teamId, channelId, messageId, replyId, callback)</td>
1513
- <td style="padding:15px">Get a reply of a message (beta)</td>
1514
- <td style="padding:15px">{base_path}/{version}/beta/teams/{pathv1}/channels/{pathv2}/messages/{pathv3}/replies/{pathv4}?{query}</td>
1515
- <td style="padding:15px">Yes</td>
1516
- </tr>
1517
- <tr>
1518
- <td style="padding:15px">getuserSjoinedteams(userId, callback)</td>
1519
- <td style="padding:15px">Get user's joined teams</td>
1520
- <td style="padding:15px">{base_path}/{version}/v1.0/users/{pathv1}/joinedTeams?{query}</td>
1521
- <td style="padding:15px">Yes</td>
1522
- </tr>
1523
- <tr>
1524
- <td style="padding:15px">getprimarychannel(groupId, callback)</td>
1525
- <td style="padding:15px">Get primary channel</td>
1526
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/primaryChannel?{query}</td>
1527
- <td style="padding:15px">Yes</td>
1528
- </tr>
1529
- <tr>
1530
- <td style="padding:15px">getteamchannels(groupId, callback)</td>
1531
- <td style="padding:15px">Get team channels</td>
1532
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/channels?{query}</td>
1533
- <td style="padding:15px">Yes</td>
1534
- </tr>
1535
- <tr>
1536
- <td style="padding:15px">getteam(teamId, callback)</td>
1537
- <td style="padding:15px">Get team</td>
1538
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}?{query}</td>
1539
- <td style="padding:15px">Yes</td>
1540
- </tr>
1541
- <tr>
1542
- <td style="padding:15px">updateteam(teamId, body, callback)</td>
1543
- <td style="padding:15px">Update team</td>
1544
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}?{query}</td>
1545
- <td style="padding:15px">Yes</td>
1546
- </tr>
1547
- <tr>
1548
- <td style="padding:15px">createteamfromgroup(groupId, body, callback)</td>
1549
- <td style="padding:15px">Create team from group</td>
1550
- <td style="padding:15px">{base_path}/{version}/v1.0/groups/{pathv1}/team?{query}</td>
1551
- <td style="padding:15px">Yes</td>
1552
- </tr>
1553
- <tr>
1554
- <td style="padding:15px">postCreateteam(teamId, channelId, body, callback)</td>
1555
- <td style="padding:15px">Create team</td>
1556
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/channels/{pathv2}/members?{query}</td>
1557
- <td style="padding:15px">Yes</td>
1558
- </tr>
1559
- <tr>
1560
- <td style="padding:15px">archiveteam(teamId, body, callback)</td>
1561
- <td style="padding:15px">Archive team</td>
1562
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/archive?{query}</td>
1563
- <td style="padding:15px">Yes</td>
1564
- </tr>
1565
- <tr>
1566
- <td style="padding:15px">cloneteam(teamId, body, callback)</td>
1567
- <td style="padding:15px">Clone team</td>
1568
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/clone?{query}</td>
1569
- <td style="padding:15px">Yes</td>
1570
- </tr>
1571
- <tr>
1572
- <td style="padding:15px">unarchiveteam(teamId, callback)</td>
1573
- <td style="padding:15px">Unarchive team</td>
1574
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/unarchive?{query}</td>
1575
- <td style="padding:15px">Yes</td>
1576
- </tr>
1577
- <tr>
1578
- <td style="padding:15px">getitemstrendingaroundme(callback)</td>
1579
- <td style="padding:15px">Get items trending around me</td>
1580
- <td style="padding:15px">{base_path}/{version}/beta/me/insights/trending?{query}</td>
1581
- <td style="padding:15px">Yes</td>
1582
- </tr>
1583
- <tr>
1584
- <td style="padding:15px">getpeopleIMworkingwith(callback)</td>
1585
- <td style="padding:15px">Get people I'm working with</td>
1586
- <td style="padding:15px">{base_path}/{version}/beta/me/workingWith?{query}</td>
1587
- <td style="padding:15px">Yes</td>
1588
- </tr>
1589
- <tr>
1590
- <td style="padding:15px">getmymessages(callback)</td>
1591
- <td style="padding:15px">Get my messages</td>
1592
- <td style="padding:15px">{base_path}/{version}/v1.0/me/messages?{query}</td>
1593
- <td style="padding:15px">Yes</td>
1594
- </tr>
1595
- <tr>
1596
- <td style="padding:15px">getmymessagesIMatmentionedin(filter, select, callback)</td>
1597
- <td style="padding:15px">Get my messages I'm at mentioned in</td>
1598
- <td style="padding:15px">{base_path}/{version}/beta/me/messages?{query}</td>
1599
- <td style="padding:15px">Yes</td>
1600
- </tr>
1601
- <tr>
1602
- <td style="padding:15px">getamessage(messageId, callback)</td>
1603
- <td style="padding:15px">Get a message</td>
1604
- <td style="padding:15px">{base_path}/{version}/v1.0/me/messages/{pathv1}?{query}</td>
1605
- <td style="padding:15px">Yes</td>
1606
- </tr>
1607
- <tr>
1608
- <td style="padding:15px">getmymailboxrules(callback)</td>
1609
- <td style="padding:15px">Get my mailbox rules</td>
1610
- <td style="padding:15px">{base_path}/{version}/v1.0/me/mailFolders/inbox/messagerules?{query}</td>
1611
- <td style="padding:15px">Yes</td>
1612
- </tr>
1613
- <tr>
1614
- <td style="padding:15px">getmycategories(callback)</td>
1615
- <td style="padding:15px">Get my categories</td>
1616
- <td style="padding:15px">{base_path}/{version}/v1.0/me/outlook/masterCategories?{query}</td>
1617
- <td style="padding:15px">Yes</td>
1618
- </tr>
1619
- <tr>
1620
- <td style="padding:15px">sendmail(body, callback)</td>
1621
- <td style="padding:15px">Send mail</td>
1622
- <td style="padding:15px">{base_path}/{version}/v1.0/me/sendMail?{query}</td>
1623
- <td style="padding:15px">Yes</td>
1624
- </tr>
1625
- <tr>
1626
- <td style="padding:15px">sendmailApplication(body, userId, callback)</td>
1627
- <td style="padding:15px">Send mail with client credentials</td>
1628
- <td style="padding:15px">{base_path}/{version}/v1.0/users/{pathv1}/sendMail?{query}</td>
1629
- <td style="padding:15px">Yes</td>
1630
- </tr>
1631
- <tr>
1632
- <td style="padding:15px">getmailboxsettings(callback)</td>
1633
- <td style="padding:15px">Get mailbox settings</td>
1634
- <td style="padding:15px">{base_path}/{version}/v1.0/me/mailboxSettings?{query}</td>
1635
- <td style="padding:15px">Yes</td>
1636
- </tr>
1637
- <tr>
1638
- <td style="padding:15px">setautomaticreplies(body, callback)</td>
1639
- <td style="padding:15px">Set automatic replies</td>
1640
- <td style="padding:15px">{base_path}/{version}/v1.0/me/mailboxSettings?{query}</td>
1641
- <td style="padding:15px">Yes</td>
1642
- </tr>
1643
- <tr>
1644
- <td style="padding:15px">getauserSmessages(userId, callback)</td>
1645
- <td style="padding:15px">Get a user's messages</td>
1646
- <td style="padding:15px">{base_path}/{version}/v1.0/users/{pathv1}/messages?{query}</td>
1647
- <td style="padding:15px">Yes</td>
1648
- </tr>
1649
- <tr>
1650
- <td style="padding:15px">getauserSmessage(userId, messageId, callback)</td>
1651
- <td style="padding:15px">Get a user's message</td>
1652
- <td style="padding:15px">{base_path}/{version}/v1.0/users/{pathv1}/messages/{pathv2}?{query}</td>
1653
- <td style="padding:15px">Yes</td>
1654
- </tr>
1655
- <tr>
1656
- <td style="padding:15px">getmynotebooks(callback)</td>
1657
- <td style="padding:15px">Get my notebooks</td>
1658
- <td style="padding:15px">{base_path}/{version}/v1.0/me/onenote/notebooks?{query}</td>
1659
- <td style="padding:15px">Yes</td>
1660
- </tr>
1661
- <tr>
1662
- <td style="padding:15px">createnotebook(body, callback)</td>
1663
- <td style="padding:15px">Create notebook</td>
1664
- <td style="padding:15px">{base_path}/{version}/v1.0/me/onenote/notebooks?{query}</td>
1665
- <td style="padding:15px">Yes</td>
1666
- </tr>
1667
- <tr>
1668
- <td style="padding:15px">getmynotebooksections(callback)</td>
1669
- <td style="padding:15px">Get my notebook sections</td>
1670
- <td style="padding:15px">{base_path}/{version}/v1.0/me/onenote/sections?{query}</td>
1671
- <td style="padding:15px">Yes</td>
1672
- </tr>
1673
- <tr>
1674
- <td style="padding:15px">getmynotebookpages(callback)</td>
1675
- <td style="padding:15px">Get my notebook pages</td>
1676
- <td style="padding:15px">{base_path}/{version}/v1.0/me/onenote/pages?{query}</td>
1677
- <td style="padding:15px">Yes</td>
1678
- </tr>
1679
- <tr>
1680
- <td style="padding:15px">createsection(notebookId, body, callback)</td>
1681
- <td style="padding:15px">Create section</td>
1682
- <td style="padding:15px">{base_path}/{version}/v1.0/me/onenote/notebooks/{pathv1}/sections?{query}</td>
1683
- <td style="padding:15px">Yes</td>
1684
- </tr>
1685
- <tr>
1686
- <td style="padding:15px">getanopenextension(select, expand, callback)</td>
1687
- <td style="padding:15px">Get an open extension</td>
1688
- <td style="padding:15px">{base_path}/{version}/v1.0/me?{query}</td>
1689
- <td style="padding:15px">Yes</td>
1690
- </tr>
1691
- <tr>
1692
- <td style="padding:15px">createanopenextension(body, callback)</td>
1693
- <td style="padding:15px">Create an open extension</td>
1694
- <td style="padding:15px">{base_path}/{version}/v1.0/me/extensions?{query}</td>
1695
- <td style="padding:15px">Yes</td>
1696
- </tr>
1697
- <tr>
1698
- <td style="padding:15px">updateanopenextension(extensionId, body, callback)</td>
1699
- <td style="padding:15px">Update an open extension</td>
1700
- <td style="padding:15px">{base_path}/{version}/v1.0/me/extensions/{pathv1}?{query}</td>
1701
- <td style="padding:15px">Yes</td>
1702
- </tr>
1703
- <tr>
1704
- <td style="padding:15px">getpeople(callback)</td>
1705
- <td style="padding:15px">Get people</td>
1706
- <td style="padding:15px">{base_path}/{version}/v1.0/me/people?{query}</td>
1707
- <td style="padding:15px">Yes</td>
1708
- </tr>
1709
- <tr>
1710
- <td style="padding:15px">getauserSrelatedpeople(userName, callback)</td>
1711
- <td style="padding:15px">Get a user's related people</td>
1712
- <td style="padding:15px">{base_path}/{version}/v1.0/users(&#39;{pathv1}&#39;)/people?{query}</td>
1713
- <td style="padding:15px">Yes</td>
1714
- </tr>
1715
- <tr>
1716
- <td style="padding:15px">searchmessages(body, callback)</td>
1717
- <td style="padding:15px">Search messages</td>
1718
- <td style="padding:15px">{base_path}/{version}/beta/search/query?{query}</td>
1719
- <td style="padding:15px">Yes</td>
1720
- </tr>
1721
- <tr>
1722
- <td style="padding:15px">listediscoveryCases(callback)</td>
1723
- <td style="padding:15px">List ediscoveryCases</td>
1724
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases?{query}</td>
1725
- <td style="padding:15px">Yes</td>
1726
- </tr>
1727
- <tr>
1728
- <td style="padding:15px">createediscoveryCase(body, callback)</td>
1729
- <td style="padding:15px">Create ediscoveryCase</td>
1730
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases?{query}</td>
1731
- <td style="padding:15px">Yes</td>
1732
- </tr>
1733
- <tr>
1734
- <td style="padding:15px">getediscoveryCase(ediscoveryCaseId, callback)</td>
1735
- <td style="padding:15px">Get ediscoveryCase</td>
1736
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}?{query}</td>
1737
- <td style="padding:15px">Yes</td>
1738
- </tr>
1739
- <tr>
1740
- <td style="padding:15px">updateediscoveryCase(ediscoveryCaseId, body, callback)</td>
1741
- <td style="padding:15px">Update ediscoveryCase</td>
1742
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}?{query}</td>
1743
- <td style="padding:15px">Yes</td>
1744
- </tr>
1745
- <tr>
1746
- <td style="padding:15px">createCustodians(ediscoveryCaseId, body, callback)</td>
1747
- <td style="padding:15px">Create Custodians</td>
1748
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/custodians?{query}</td>
1749
- <td style="padding:15px">Yes</td>
1750
- </tr>
1751
- <tr>
1752
- <td style="padding:15px">listediscoveryCustodian(ediscoveryCaseId, callback)</td>
1753
- <td style="padding:15px">List ediscoveryCustodian</td>
1754
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/custodians?{query}</td>
1755
- <td style="padding:15px">Yes</td>
1756
- </tr>
1757
- <tr>
1758
- <td style="padding:15px">createcustodianuserSource(ediscoveryCaseId, custodianId, body, callback)</td>
1759
- <td style="padding:15px">Create custodian userSource</td>
1760
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/custodians/{pathv2}/userSources?{query}</td>
1761
- <td style="padding:15px">Yes</td>
1762
- </tr>
1763
- <tr>
1764
- <td style="padding:15px">listuserSources(ediscoveryCaseId, custodianId, callback)</td>
1765
- <td style="padding:15px">List userSources</td>
1766
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/custodians/{pathv2}/userSources?{query}</td>
1767
- <td style="padding:15px">Yes</td>
1768
- </tr>
1769
- <tr>
1770
- <td style="padding:15px">ediscoveryCustodianApplyHold(ediscoveryCaseId, body, callback)</td>
1771
- <td style="padding:15px">ediscoveryCustodian: applyHold</td>
1772
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/custodians/applyHold?{query}</td>
1773
- <td style="padding:15px">Yes</td>
1774
- </tr>
1775
- <tr>
1776
- <td style="padding:15px">createediscoveryNoncustodialDataSources(ediscoveryCaseId, body, callback)</td>
1777
- <td style="padding:15px">Create ediscoveryNoncustodialDataSources</td>
1778
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/noncustodialDataSources?{query}</td>
1779
- <td style="padding:15px">Yes</td>
1780
- </tr>
1781
- <tr>
1782
- <td style="padding:15px">listediscoveryNoncustodialDataSources(ediscoveryCaseId, callback)</td>
1783
- <td style="padding:15px">List ediscoveryNoncustodialDataSources</td>
1784
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/noncustodialDataSources?{query}</td>
1785
- <td style="padding:15px">Yes</td>
1786
- </tr>
1787
- <tr>
1788
- <td style="padding:15px">ediscoveryNoncustodialDataSourceApplyHold(ediscoveryCaseId, body, callback)</td>
1789
- <td style="padding:15px">ediscoveryNoncustodialDataSource: applyHold</td>
1790
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/noncustodialDataSources/applyHold?{query}</td>
1791
- <td style="padding:15px">Yes</td>
1792
- </tr>
1793
- <tr>
1794
- <td style="padding:15px">createsearches(ediscoveryCaseId, body, callback)</td>
1795
- <td style="padding:15px">Create searches</td>
1796
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/searches?{query}</td>
1797
- <td style="padding:15px">Yes</td>
1798
- </tr>
1799
- <tr>
1800
- <td style="padding:15px">listsearches(ediscoveryCaseId, callback)</td>
1801
- <td style="padding:15px">List searches</td>
1802
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/searches?{query}</td>
1803
- <td style="padding:15px">Yes</td>
1804
- </tr>
1805
- <tr>
1806
- <td style="padding:15px">ediscoverySearchEstimateStatistics(ediscoveryCaseId, ediscoverySearchId, callback)</td>
1807
- <td style="padding:15px">ediscoverySearch: estimate Statistics</td>
1808
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/searches/{pathv2}/estimateStatistics?{query}</td>
1809
- <td style="padding:15px">Yes</td>
1810
- </tr>
1811
- <tr>
1812
- <td style="padding:15px">listlastEstimateStatisticsOperation(ediscoveryCaseId, ediscoverySearchId, callback)</td>
1813
- <td style="padding:15px">List lastEstimateStatisticsOperation</td>
1814
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/searches/{pathv2}/lastEstimateStatisticsOperation?{query}</td>
1815
- <td style="padding:15px">Yes</td>
1816
- </tr>
1817
- <tr>
1818
- <td style="padding:15px">createreviewSets(ediscoveryCaseId, body, callback)</td>
1819
- <td style="padding:15px">Create reviewSets</td>
1820
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/reviewSets?{query}</td>
1821
- <td style="padding:15px">Yes</td>
1822
- </tr>
1823
- <tr>
1824
- <td style="padding:15px">listreviewSets(ediscoveryCaseId, callback)</td>
1825
- <td style="padding:15px">List reviewSets</td>
1826
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/reviewSets?{query}</td>
1827
- <td style="padding:15px">Yes</td>
1828
- </tr>
1829
- <tr>
1830
- <td style="padding:15px">ediscoveryReviewSetAddToReviewSet(ediscoveryCaseId, ediscoveryReviewSetId, body, callback)</td>
1831
- <td style="padding:15px">ediscoveryReviewSet: addToReviewSet</td>
1832
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/reviewSets/{pathv2}/addToReviewSet?{query}</td>
1833
- <td style="padding:15px">Yes</td>
1834
- </tr>
1835
- <tr>
1836
- <td style="padding:15px">createediscoveryReviewSetQuery(ediscoveryCaseId, ediscoveryReviewSetId, body, callback)</td>
1837
- <td style="padding:15px">Create ediscoveryReviewSetQuery</td>
1838
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/reviewSets/{pathv2}/queries?{query}</td>
1839
- <td style="padding:15px">Yes</td>
1840
- </tr>
1841
- <tr>
1842
- <td style="padding:15px">listqueries(ediscoveryCaseId, ediscoveryReviewSetId, callback)</td>
1843
- <td style="padding:15px">List queries</td>
1844
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/reviewSets/{pathv2}/queries?{query}</td>
1845
- <td style="padding:15px">Yes</td>
1846
- </tr>
1847
- <tr>
1848
- <td style="padding:15px">updateediscoveryReviewSetQuery(ediscoveryCaseId, ediscoveryReviewSetId, ediscoveryReviewSetQueryId, body, callback)</td>
1849
- <td style="padding:15px">Update ediscoveryReviewSetQuery</td>
1850
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/reviewSets/{pathv2}/queries/{pathv3}?{query}</td>
1851
- <td style="padding:15px">Yes</td>
1852
- </tr>
1853
- <tr>
1854
- <td style="padding:15px">deleteediscoveryReviewSetQuery(ediscoveryCaseId, ediscoveryReviewSetId, ediscoveryReviewSetQueryId, callback)</td>
1855
- <td style="padding:15px">Delete ediscoveryReviewSetQuery</td>
1856
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/reviewSets/{pathv2}/queries/{pathv3}?{query}</td>
1857
- <td style="padding:15px">Yes</td>
1858
- </tr>
1859
- <tr>
1860
- <td style="padding:15px">listcaseOperations(ediscoveryCaseId, callback)</td>
1861
- <td style="padding:15px">List caseOperations</td>
1862
- <td style="padding:15px">{base_path}/{version}/v1.0/security/cases/ediscoveryCases/{pathv1}/operations?{query}</td>
1863
- <td style="padding:15px">Yes</td>
1864
- </tr>
1865
- <tr>
1866
- <td style="padding:15px">getalerts(callback)</td>
1867
- <td style="padding:15px">Get alerts</td>
1868
- <td style="padding:15px">{base_path}/{version}/v1.0/security/alerts?{query}</td>
1869
- <td style="padding:15px">Yes</td>
1870
- </tr>
1871
- <tr>
1872
- <td style="padding:15px">getsecurescores(top, callback)</td>
1873
- <td style="padding:15px">Get secure scores</td>
1874
- <td style="padding:15px">{base_path}/{version}/v1.0/security/secureScores?{query}</td>
1875
- <td style="padding:15px">Yes</td>
1876
- </tr>
1877
- <tr>
1878
- <td style="padding:15px">getsecurescorescontrolprofiles(top, callback)</td>
1879
- <td style="padding:15px">Get secure scores control profiles</td>
1880
- <td style="padding:15px">{base_path}/{version}/beta/security/secureScoreControlProfiles?{query}</td>
1881
- <td style="padding:15px">Yes</td>
1882
- </tr>
1883
- <tr>
1884
- <td style="padding:15px">getTIindicators(callback)</td>
1885
- <td style="padding:15px">Get TI indicators</td>
1886
- <td style="padding:15px">{base_path}/{version}/beta/security/tiIndicators?{query}</td>
1887
- <td style="padding:15px">Yes</td>
1888
- </tr>
1889
- <tr>
1890
- <td style="padding:15px">getTIindicatorbyid(tIIndicatorId, callback)</td>
1891
- <td style="padding:15px">Get TI indicator by id</td>
1892
- <td style="padding:15px">{base_path}/{version}/beta/security/tiIndicators/{pathv1}?{query}</td>
1893
- <td style="padding:15px">Yes</td>
1894
- </tr>
1895
- <tr>
1896
- <td style="padding:15px">getsecurityactions(callback)</td>
1897
- <td style="padding:15px">Get security actions</td>
1898
- <td style="padding:15px">{base_path}/{version}/beta/security/securityActions?{query}</td>
1899
- <td style="padding:15px">Yes</td>
1900
- </tr>
1901
- <tr>
1902
- <td style="padding:15px">getsecurityactionbyid(securityActionsId, callback)</td>
1903
- <td style="padding:15px">Get security action by id</td>
1904
- <td style="padding:15px">{base_path}/{version}/beta/security/securityActions/{pathv1}?{query}</td>
1905
- <td style="padding:15px">Yes</td>
1906
- </tr>
1907
- <tr>
1908
- <td style="padding:15px">getmyorganizationSdefaultsitecollection(callback)</td>
1909
- <td style="padding:15px">Get my organization's default site collection</td>
1910
- <td style="padding:15px">{base_path}/{version}/v1.0/sites/root?{query}</td>
1911
- <td style="padding:15px">Yes</td>
1912
- </tr>
1913
- <tr>
1914
- <td style="padding:15px">getthedoclibsinrootsite(callback)</td>
1915
- <td style="padding:15px">Get the doc libs in root site</td>
1916
- <td style="padding:15px">{base_path}/{version}/v1.0/sites/root/drives?{query}</td>
1917
- <td style="padding:15px">Yes</td>
1918
- </tr>
1919
- <tr>
1920
- <td style="padding:15px">searchforsitebyname(search, callback)</td>
1921
- <td style="padding:15px">Search for site by name</td>
1922
- <td style="padding:15px">{base_path}/{version}/v1.0/sites?{query}</td>
1923
- <td style="padding:15px">Yes</td>
1924
- </tr>
1925
- <tr>
1926
- <td style="padding:15px">getsubsitesofsite(callback)</td>
1927
- <td style="padding:15px">Get subsites of site</td>
1928
- <td style="padding:15px">{base_path}/{version}/v1.0/sites/root/sites?{query}</td>
1929
- <td style="padding:15px">Yes</td>
1930
- </tr>
1931
- <tr>
1932
- <td style="padding:15px">getsitecolumns(callback)</td>
1933
- <td style="padding:15px">Get site columns</td>
1934
- <td style="padding:15px">{base_path}/{version}/v1.0/sites/root/columns?{query}</td>
1935
- <td style="padding:15px">Yes</td>
1936
- </tr>
1937
- <tr>
1938
- <td style="padding:15px">getsitecontenttypes(callback)</td>
1939
- <td style="padding:15px">Get site content types</td>
1940
- <td style="padding:15px">{base_path}/{version}/v1.0/sites/root/contentTypes?{query}</td>
1941
- <td style="padding:15px">Yes</td>
1942
- </tr>
1943
- <tr>
1944
- <td style="padding:15px">getsitelists(callback)</td>
1945
- <td style="padding:15px">Get site lists</td>
1946
- <td style="padding:15px">{base_path}/{version}/v1.0/sites/root/lists?{query}</td>
1947
- <td style="padding:15px">Yes</td>
1948
- </tr>
1949
- <tr>
1950
- <td style="padding:15px">getlistcolumns(listId, callback)</td>
1951
- <td style="padding:15px">Get list columns</td>
1952
- <td style="padding:15px">{base_path}/{version}/v1.0/sites/root/lists/{pathv1}/columns?{query}</td>
1953
- <td style="padding:15px">Yes</td>
1954
- </tr>
1955
- <tr>
1956
- <td style="padding:15px">getlistcontenttypes(listId, callback)</td>
1957
- <td style="padding:15px">Get list content types</td>
1958
- <td style="padding:15px">{base_path}/{version}/v1.0/sites/root/lists/{pathv1}/contentTypes?{query}</td>
1959
- <td style="padding:15px">Yes</td>
1960
- </tr>
1961
- <tr>
1962
- <td style="padding:15px">getlistitems(listId, callback)</td>
1963
- <td style="padding:15px">Get list items</td>
1964
- <td style="padding:15px">{base_path}/{version}/v1.0/sites/root/lists/{pathv1}/items?{query}</td>
1965
- <td style="padding:15px">Yes</td>
1966
- </tr>
1967
- <tr>
1968
- <td style="padding:15px">getsubscriptions(callback)</td>
1969
- <td style="padding:15px">Get subscriptions</td>
1970
- <td style="padding:15px">{base_path}/{version}/v1.0/subscriptions?{query}</td>
1971
- <td style="padding:15px">Yes</td>
1972
- </tr>
1973
- <tr>
1974
- <td style="padding:15px">updatesubscription(subscriptionId, body, callback)</td>
1975
- <td style="padding:15px">Update subscription</td>
1976
- <td style="padding:15px">{base_path}/{version}/v1.0/subscriptions/{pathv1}?{query}</td>
1977
- <td style="padding:15px">Yes</td>
1978
- </tr>
1979
- <tr>
1980
- <td style="padding:15px">createsubscription(body, callback)</td>
1981
- <td style="padding:15px">Create subscription</td>
1982
- <td style="padding:15px">{base_path}/{version}/beta/subscriptions?{query}</td>
1983
- <td style="padding:15px">Yes</td>
1984
- </tr>
1985
- <tr>
1986
- <td style="padding:15px">getPlannertasks(callback)</td>
1987
- <td style="padding:15px">Get Planner tasks</td>
1988
- <td style="padding:15px">{base_path}/{version}/v1.0/me/planner/tasks?{query}</td>
1989
- <td style="padding:15px">Yes</td>
1990
- </tr>
1991
- <tr>
1992
- <td style="padding:15px">getPlannertasksforauser(userName, callback)</td>
1993
- <td style="padding:15px">Get Planner tasks for a user</td>
1994
- <td style="padding:15px">{base_path}/{version}/v1.0/users/{pathv1}/planner/tasks?{query}</td>
1995
- <td style="padding:15px">Yes</td>
1996
- </tr>
1997
- <tr>
1998
- <td style="padding:15px">getPlannerplansassociatedwithgroup(groupId, callback)</td>
1999
- <td style="padding:15px">Get Planner plans associated with group</td>
2000
- <td style="padding:15px">{base_path}/{version}/v1.0/groups/{pathv1}/planner/plans?{query}</td>
2001
- <td style="padding:15px">Yes</td>
2002
- </tr>
2003
- <tr>
2004
- <td style="padding:15px">getplan(planId, callback)</td>
2005
- <td style="padding:15px">Get plan</td>
2006
- <td style="padding:15px">{base_path}/{version}/v1.0/planner/plans/{pathv1}?{query}</td>
2007
- <td style="padding:15px">Yes</td>
2008
- </tr>
2009
- <tr>
2010
- <td style="padding:15px">updateplan(planId, body, callback)</td>
2011
- <td style="padding:15px">Update plan</td>
2012
- <td style="padding:15px">{base_path}/{version}/v1.0/planner/plans/{pathv1}?{query}</td>
2013
- <td style="padding:15px">Yes</td>
2014
- </tr>
2015
- <tr>
2016
- <td style="padding:15px">getplanbuckets(planId, callback)</td>
2017
- <td style="padding:15px">Get plan buckets</td>
2018
- <td style="padding:15px">{base_path}/{version}/v1.0/planner/plans/{pathv1}/buckets?{query}</td>
2019
- <td style="padding:15px">Yes</td>
2020
- </tr>
2021
- <tr>
2022
- <td style="padding:15px">createabucketinaplan(body, callback)</td>
2023
- <td style="padding:15px">Create a bucket in a plan</td>
2024
- <td style="padding:15px">{base_path}/{version}/v1.0/planner/buckets?{query}</td>
2025
- <td style="padding:15px">Yes</td>
2026
- </tr>
2027
- <tr>
2028
- <td style="padding:15px">updateabucket(bucketId, body, callback)</td>
2029
- <td style="padding:15px">Update a bucket</td>
2030
- <td style="padding:15px">{base_path}/{version}/v1.0/planner/buckets/{pathv1}?{query}</td>
2031
- <td style="padding:15px">Yes</td>
2032
- </tr>
2033
- <tr>
2034
- <td style="padding:15px">getPlannertasksforaplan(planId, callback)</td>
2035
- <td style="padding:15px">Get Planner tasks for a plan</td>
2036
- <td style="padding:15px">{base_path}/{version}/v1.0/planner/plans/{pathv1}/tasks?{query}</td>
2037
- <td style="padding:15px">Yes</td>
2038
- </tr>
2039
- <tr>
2040
- <td style="padding:15px">getPlannertaskbyid(taskId, callback)</td>
2041
- <td style="padding:15px">Get Planner task by id</td>
2042
- <td style="padding:15px">{base_path}/{version}/v1.0/planner/tasks/{pathv1}?{query}</td>
2043
- <td style="padding:15px">Yes</td>
2044
- </tr>
2045
- <tr>
2046
- <td style="padding:15px">updateaPlannertask(taskId, body, callback)</td>
2047
- <td style="padding:15px">Update a Planner task</td>
2048
- <td style="padding:15px">{base_path}/{version}/v1.0/planner/tasks/{pathv1}?{query}</td>
2049
- <td style="padding:15px">Yes</td>
2050
- </tr>
2051
- <tr>
2052
- <td style="padding:15px">createaPlannertask(body, callback)</td>
2053
- <td style="padding:15px">Create a Planner task</td>
2054
- <td style="padding:15px">{base_path}/{version}/v1.0/planner/tasks?{query}</td>
2055
- <td style="padding:15px">Yes</td>
2056
- </tr>
2057
- <tr>
2058
- <td style="padding:15px">getPlannertaskdetails(taskId, callback)</td>
2059
- <td style="padding:15px">Get Planner task details</td>
2060
- <td style="padding:15px">{base_path}/{version}/v1.0/planner/tasks/{pathv1}/details?{query}</td>
2061
- <td style="padding:15px">Yes</td>
2062
- </tr>
2063
- <tr>
2064
- <td style="padding:15px">getmyToDolists(callback)</td>
2065
- <td style="padding:15px">Get my To Do lists</td>
2066
- <td style="padding:15px">{base_path}/{version}/v1.0/me/todo/lists?{query}</td>
2067
- <td style="padding:15px">Yes</td>
2068
- </tr>
2069
- <tr>
2070
- <td style="padding:15px">createaToDolist(body, callback)</td>
2071
- <td style="padding:15px">Create a To Do list</td>
2072
- <td style="padding:15px">{base_path}/{version}/v1.0/me/todo/lists?{query}</td>
2073
- <td style="padding:15px">Yes</td>
2074
- </tr>
2075
- <tr>
2076
- <td style="padding:15px">getmyToDolist(taskListId, callback)</td>
2077
- <td style="padding:15px">Get my To Do list</td>
2078
- <td style="padding:15px">{base_path}/{version}/v1.0/me/todo/lists/{pathv1}?{query}</td>
2079
- <td style="padding:15px">Yes</td>
2080
- </tr>
2081
- <tr>
2082
- <td style="padding:15px">updateaToDolist(taskListId, body, callback)</td>
2083
- <td style="padding:15px">Update a To Do list</td>
2084
- <td style="padding:15px">{base_path}/{version}/v1.0/me/todo/lists/{pathv1}?{query}</td>
2085
- <td style="padding:15px">Yes</td>
2086
- </tr>
2087
- <tr>
2088
- <td style="padding:15px">deleteaToDolist(taskListId, callback)</td>
2089
- <td style="padding:15px">Delete a To Do list</td>
2090
- <td style="padding:15px">{base_path}/{version}/v1.0/me/todo/lists/{pathv1}?{query}</td>
2091
- <td style="padding:15px">Yes</td>
2092
- </tr>
2093
- <tr>
2094
- <td style="padding:15px">getmyToDolisttasks(taskListId, callback)</td>
2095
- <td style="padding:15px">Get my To Do list tasks</td>
2096
- <td style="padding:15px">{base_path}/{version}/v1.0/me/todo/lists/{pathv1}/tasks?{query}</td>
2097
- <td style="padding:15px">Yes</td>
2098
- </tr>
2099
- <tr>
2100
- <td style="padding:15px">createaToDotaskinalist(taskListId, body, callback)</td>
2101
- <td style="padding:15px">Create a To Do task in a list</td>
2102
- <td style="padding:15px">{base_path}/{version}/v1.0/me/todo/lists/{pathv1}/tasks?{query}</td>
2103
- <td style="padding:15px">Yes</td>
2104
- </tr>
2105
- <tr>
2106
- <td style="padding:15px">updateaToDotaskinalist(taskListId, taskId, body, callback)</td>
2107
- <td style="padding:15px">Update a To Do task in a list</td>
2108
- <td style="padding:15px">{base_path}/{version}/v1.0/me/todo/lists/{pathv1}/tasks/{pathv2}?{query}</td>
2109
- <td style="padding:15px">Yes</td>
2110
- </tr>
2111
- <tr>
2112
- <td style="padding:15px">deleteaToDotaskinalist(taskListId, taskId, callback)</td>
2113
- <td style="padding:15px">Delete a To Do task in a list</td>
2114
- <td style="padding:15px">{base_path}/{version}/v1.0/me/todo/lists/{pathv1}/tasks/{pathv2}?{query}</td>
2115
- <td style="padding:15px">Yes</td>
2116
- </tr>
2117
- <tr>
2118
- <td style="padding:15px">getmyaboutme(callback)</td>
2119
- <td style="padding:15px">Get my about me</td>
2120
- <td style="padding:15px">{base_path}/{version}/v1.0/me/aboutMe?{query}</td>
2121
- <td style="padding:15px">Yes</td>
2122
- </tr>
2123
- <tr>
2124
- <td style="padding:15px">getmymanager(callback)</td>
2125
- <td style="padding:15px">Get my manager</td>
2126
- <td style="padding:15px">{base_path}/{version}/v1.0/me/manager?{query}</td>
2127
- <td style="padding:15px">Yes</td>
2128
- </tr>
2129
- <tr>
2130
- <td style="padding:15px">getmydirectreports(callback)</td>
2131
- <td style="padding:15px">Get my direct reports</td>
2132
- <td style="padding:15px">{base_path}/{version}/v1.0/me/directReports?{query}</td>
2133
- <td style="padding:15px">Yes</td>
2134
- </tr>
2135
- <tr>
2136
- <td style="padding:15px">getmygroups(callback)</td>
2137
- <td style="padding:15px">Get my groups</td>
2138
- <td style="padding:15px">{base_path}/{version}/v1.0/me/memberOf?{query}</td>
2139
- <td style="padding:15px">Yes</td>
2140
- </tr>
2141
- <tr>
2142
- <td style="padding:15px">getmyphoto(callback)</td>
2143
- <td style="padding:15px">Get my photo</td>
2144
- <td style="padding:15px">{base_path}/{version}/v1.0/me/photo/$value?{query}</td>
2145
- <td style="padding:15px">Yes</td>
2146
- </tr>
2147
- <tr>
2148
- <td style="padding:15px">getusers(callback)</td>
2149
- <td style="padding:15px">Get users</td>
2150
- <td style="padding:15px">{base_path}/{version}/v1.0/users?{query}</td>
2151
- <td style="padding:15px">Yes</td>
2152
- </tr>
2153
- <tr>
2154
- <td style="padding:15px">getuserSprofilebyemail(userName, callback)</td>
2155
- <td style="padding:15px">Get user's profile by email</td>
2156
- <td style="padding:15px">{base_path}/{version}/v1.0/users/{pathv1}?{query}</td>
2157
- <td style="padding:15px">Yes</td>
2158
- </tr>
2159
- <tr>
2160
- <td style="padding:15px">getauserSprofilebyid(userId, callback)</td>
2161
- <td style="padding:15px">Get a user's profile by id</td>
2162
- <td style="padding:15px">{base_path}/{version}/v1.0/users/{pathv1}?{query}</td>
2163
- <td style="padding:15px">Yes</td>
2164
- </tr>
2165
- <tr>
2166
- <td style="padding:15px">getauserSphoto(userId, callback)</td>
2167
- <td style="padding:15px">Get a user's photo</td>
2168
- <td style="padding:15px">{base_path}/{version}/v1.0/users/{pathv1}/photo/$value?{query}</td>
2169
- <td style="padding:15px">Yes</td>
2170
- </tr>
2171
- <tr>
2172
- <td style="padding:15px">inviteaguestuser(body, callback)</td>
2173
- <td style="padding:15px">Invite a guest user</td>
2174
- <td style="padding:15px">{base_path}/{version}/v1.0/invitations?{query}</td>
2175
- <td style="padding:15px">Yes</td>
2176
- </tr>
2177
- <tr>
2178
- <td style="padding:15px">listcatalogentries(callback)</td>
2179
- <td style="padding:15px">List catalog entries</td>
2180
- <td style="padding:15px">{base_path}/{version}/beta/admin/windows/updates/catalog/entries?{query}</td>
2181
- <td style="padding:15px">Yes</td>
2182
- </tr>
2183
- <tr>
2184
- <td style="padding:15px">listmembers(deploymentId, callback)</td>
2185
- <td style="padding:15px">List members</td>
2186
- <td style="padding:15px">{base_path}/{version}/beta/admin/windows/updates/deployments/{pathv1}/audience/members?{query}</td>
2187
- <td style="padding:15px">Yes</td>
2188
- </tr>
2189
- <tr>
2190
- <td style="padding:15px">listexclusions(deploymentId, callback)</td>
2191
- <td style="padding:15px">List exclusions</td>
2192
- <td style="padding:15px">{base_path}/{version}/beta/admin/windows/updates/deployments/{pathv1}/audience/exclusions?{query}</td>
2193
- <td style="padding:15px">Yes</td>
2194
- </tr>
2195
- <tr>
2196
- <td style="padding:15px">updateaudienceAddmembers(deploymentId, body, callback)</td>
2197
- <td style="padding:15px">Update audience (add members)</td>
2198
- <td style="padding:15px">{base_path}/{version}/beta/admin/windows/updates/deployments/{pathv1}/audience/updateAudience?{query}</td>
2199
- <td style="padding:15px">Yes</td>
2200
- </tr>
2201
- <tr>
2202
- <td style="padding:15px">createdeploymentFeatureupdate(body, callback)</td>
2203
- <td style="padding:15px">Create deployment (feature update)</td>
2204
- <td style="padding:15px">{base_path}/{version}/beta/admin/windows/updates/deployments?{query}</td>
2205
- <td style="padding:15px">Yes</td>
2206
- </tr>
2207
- <tr>
2208
- <td style="padding:15px">listdeployments(callback)</td>
2209
- <td style="padding:15px">List deployments</td>
2210
- <td style="padding:15px">{base_path}/{version}/beta/admin/windows/updates/deployments?{query}</td>
2211
- <td style="padding:15px">Yes</td>
2212
- </tr>
2213
- <tr>
2214
- <td style="padding:15px">getdeployment(deploymentId, callback)</td>
2215
- <td style="padding:15px">Get deployment</td>
2216
- <td style="padding:15px">{base_path}/{version}/beta/admin/windows/updates/deployments/{pathv1}?{query}</td>
2217
- <td style="padding:15px">Yes</td>
2218
- </tr>
2219
- <tr>
2220
- <td style="padding:15px">updatedeploymentReplacemonitoringrules(deploymentId, body, callback)</td>
2221
- <td style="padding:15px">Update deployment (replace monitoring rules)</td>
2222
- <td style="padding:15px">{base_path}/{version}/beta/admin/windows/updates/deployments/{pathv1}?{query}</td>
2223
- <td style="padding:15px">Yes</td>
2224
- </tr>
2225
- <tr>
2226
- <td style="padding:15px">deletedeployment(deploymentId, callback)</td>
2227
- <td style="padding:15px">Delete deployment</td>
2228
- <td style="padding:15px">{base_path}/{version}/beta/admin/windows/updates/deployments/{pathv1}?{query}</td>
2229
- <td style="padding:15px">Yes</td>
2230
- </tr>
2231
- <tr>
2232
- <td style="padding:15px">listAzureADdevices(filter, callback)</td>
2233
- <td style="padding:15px">List Azure AD devices</td>
2234
- <td style="padding:15px">{base_path}/{version}/beta/admin/windows/updates/updatableAssets?{query}</td>
2235
- <td style="padding:15px">Yes</td>
2236
- </tr>
2237
- <tr>
2238
- <td style="padding:15px">getAzureADdevice(updatableAssetId, callback)</td>
2239
- <td style="padding:15px">Get Azure AD device</td>
2240
- <td style="padding:15px">{base_path}/{version}/beta/admin/windows/updates/updatableAssets/{pathv1}?{query}</td>
2241
- <td style="padding:15px">Yes</td>
2242
- </tr>
2243
- <tr>
2244
- <td style="padding:15px">deleteAzureADdevice(updatableAssetId, callback)</td>
2245
- <td style="padding:15px">Delete Azure AD device</td>
2246
- <td style="padding:15px">{base_path}/{version}/beta/admin/windows/updates/deployments/{pathv1}?{query}</td>
2247
- <td style="padding:15px">Yes</td>
2248
- </tr>
2249
- <tr>
2250
- <td style="padding:15px">enrollinfeatureupdatemanagement(body, callback)</td>
2251
- <td style="padding:15px">Enroll in feature update management</td>
2252
- <td style="padding:15px">{base_path}/{version}/beta/admin/windows/updates/updatableAssets/enrollAssets?{query}</td>
2253
- <td style="padding:15px">Yes</td>
2254
- </tr>
2255
- <tr>
2256
- <td style="padding:15px">unenrollfromfeatureupdatemanagement(body, callback)</td>
2257
- <td style="padding:15px">Unenroll from feature update management</td>
2258
- <td style="padding:15px">{base_path}/{version}/beta/admin/windows/updates/updatableAssets/unenrollAssets?{query}</td>
2259
- <td style="padding:15px">Yes</td>
2260
- </tr>
2261
- <tr>
2262
- <td style="padding:15px">getallconnections(callback)</td>
2263
- <td style="padding:15px">Get all connections</td>
2264
- <td style="padding:15px">{base_path}/{version}/v1.0/external/connections?{query}</td>
2265
- <td style="padding:15px">Yes</td>
2266
- </tr>
2267
- <tr>
2268
- <td style="padding:15px">createconnection(body, callback)</td>
2269
- <td style="padding:15px">Create connection</td>
2270
- <td style="padding:15px">{base_path}/{version}/v1.0/external/connections?{query}</td>
2271
- <td style="padding:15px">Yes</td>
2272
- </tr>
2273
- <tr>
2274
- <td style="padding:15px">getconnection(callback)</td>
2275
- <td style="padding:15px">Get connection</td>
2276
- <td style="padding:15px">{base_path}/{version}/v1.0/external/connections/sampleConnectionId?{query}</td>
2277
- <td style="padding:15px">Yes</td>
2278
- </tr>
2279
- <tr>
2280
- <td style="padding:15px">deleteconnection(callback)</td>
2281
- <td style="padding:15px">Delete connection</td>
2282
- <td style="padding:15px">{base_path}/{version}/v1.0/external/connections/sampleConnectionId?{query}</td>
2283
- <td style="padding:15px">Yes</td>
2284
- </tr>
2285
- <tr>
2286
- <td style="padding:15px">registerschema(body, callback)</td>
2287
- <td style="padding:15px">Register schema</td>
2288
- <td style="padding:15px">{base_path}/{version}/v1.0/external/connections/sampleConnectionId/schema?{query}</td>
2289
- <td style="padding:15px">Yes</td>
2290
- </tr>
2291
- <tr>
2292
- <td style="padding:15px">getschema(callback)</td>
2293
- <td style="padding:15px">Get schema</td>
2294
- <td style="padding:15px">{base_path}/{version}/v1.0/external/connections/sampleConnectionId/schema?{query}</td>
2295
- <td style="padding:15px">Yes</td>
2296
- </tr>
2297
- <tr>
2298
- <td style="padding:15px">getconnectionoperationstatus(callback)</td>
2299
- <td style="padding:15px">Get connection operation status</td>
2300
- <td style="padding:15px">{base_path}/{version}/?{query}</td>
2301
- <td style="padding:15px">Yes</td>
2302
- </tr>
2303
- <tr>
2304
- <td style="padding:15px">putitem(body, callback)</td>
2305
- <td style="padding:15px">Put item</td>
2306
- <td style="padding:15px">{base_path}/{version}/v1.0/external/connections/sampleConnectionId/items/sampleItemId?{query}</td>
2307
- <td style="padding:15px">Yes</td>
2308
- </tr>
2309
- <tr>
2310
- <td style="padding:15px">getitem(callback)</td>
2311
- <td style="padding:15px">Get item</td>
2312
- <td style="padding:15px">{base_path}/{version}/v1.0/external/connections/sampleConnectionId/items/sampleItemId?{query}</td>
2313
- <td style="padding:15px">Yes</td>
2314
- </tr>
2315
- <tr>
2316
- <td style="padding:15px">deleteitem(callback)</td>
2317
- <td style="padding:15px">Delete item</td>
2318
- <td style="padding:15px">{base_path}/{version}/v1.0/external/connections/sampleConnectionId/items/sampleItemId?{query}</td>
2319
- <td style="padding:15px">Yes</td>
2320
- </tr>
2321
- <tr>
2322
- <td style="padding:15px">creategroup(body, callback)</td>
2323
- <td style="padding:15px">Create group</td>
2324
- <td style="padding:15px">{base_path}/{version}/v1.0/external/connections/sampleConnectionId/groups?{query}</td>
2325
- <td style="padding:15px">Yes</td>
2326
- </tr>
2327
- <tr>
2328
- <td style="padding:15px">getgroup(callback)</td>
2329
- <td style="padding:15px">Get group</td>
2330
- <td style="padding:15px">{base_path}/{version}/v1.0/external/connections/sampleConnectionId/groups/graphConnectorGroupId?{query}</td>
2331
- <td style="padding:15px">Yes</td>
2332
- </tr>
2333
- <tr>
2334
- <td style="padding:15px">deletegroup(callback)</td>
2335
- <td style="padding:15px">Delete group</td>
2336
- <td style="padding:15px">{base_path}/{version}/v1.0/external/connections/sampleConnectionId/groups/graphConnectorGroupId?{query}</td>
2337
- <td style="padding:15px">Yes</td>
2338
- </tr>
2339
- <tr>
2340
- <td style="padding:15px">addAADuserasmember(body, callback)</td>
2341
- <td style="padding:15px">Add AAD user as member</td>
2342
- <td style="padding:15px">{base_path}/{version}/v1.0/external/connections/sampleConnectionId/groups/graphConnectorGroupId/members?{query}</td>
2343
- <td style="padding:15px">Yes</td>
2344
- </tr>
2345
- <tr>
2346
- <td style="padding:15px">removemember(callback)</td>
2347
- <td style="padding:15px">Remove member</td>
2348
- <td style="padding:15px">{base_path}/{version}/v1.0/external/connections/sampleConnectionId/groups/graphConnectorGroupId/members/childGraphConnectorGroupId?{query}</td>
2349
- <td style="padding:15px">Yes</td>
2350
- </tr>
2351
- <tr>
2352
- <td style="padding:15px">getteammembers(groupId, callback)</td>
2353
- <td style="padding:15px">Get team members</td>
2354
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/members?{query}</td>
2355
- <td style="padding:15px">Yes</td>
2356
- </tr>
2357
- <tr>
2358
- <td style="padding:15px">addteammember(groupId, body, callback)</td>
2359
- <td style="padding:15px">Add team member</td>
2360
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/members?{query}</td>
2361
- <td style="padding:15px">Yes</td>
2362
- </tr>
2363
- <tr>
2364
- <td style="padding:15px">getsingleteammember(groupId, userId, callback)</td>
2365
- <td style="padding:15px">Get single team member</td>
2366
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/members/{pathv2}?{query}</td>
2367
- <td style="padding:15px">Yes</td>
2368
- </tr>
2369
- <tr>
2370
- <td style="padding:15px">updateteammember(groupId, userId, body, callback)</td>
2371
- <td style="padding:15px">Update team member</td>
2372
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/members/{pathv2}?{query}</td>
2373
- <td style="padding:15px">Yes</td>
2374
- </tr>
2375
- <tr>
2376
- <td style="padding:15px">getchannelmembers(groupId, channelId, callback)</td>
2377
- <td style="padding:15px">Get channel members</td>
2378
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/channels/{pathv2}/members?{query}</td>
2379
- <td style="padding:15px">Yes</td>
2380
- </tr>
2381
- <tr>
2382
- <td style="padding:15px">removeteammember(teamId, userId, callback)</td>
2383
- <td style="padding:15px">Remove team member</td>
2384
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/members/{pathv2}?{query}</td>
2385
- <td style="padding:15px">Yes</td>
2386
- </tr>
2387
- <tr>
2388
- <td style="padding:15px">removechannelmember(teamId, channelId, userId, callback)</td>
2389
- <td style="padding:15px">Remove channel member</td>
2390
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/channels/{pathv2}members/{pathv3}?{query}</td>
2391
- <td style="padding:15px">Yes</td>
2392
- </tr>
2393
- <tr>
2394
- <td style="padding:15px">updatechannelmember(groupId, channelId, userId, body, callback)</td>
2395
- <td style="padding:15px">Update channel member</td>
2396
- <td style="padding:15px">{base_path}/{version}/v1.0/teams/{pathv1}/channels/{pathv2}/members/{pathv3}?{query}</td>
2397
- <td style="padding:15px">Yes</td>
2398
- </tr>
2399
- <tr>
2400
- <td style="padding:15px">subscriptionvalidation(validationToken, callback)</td>
2401
- <td style="padding:15px">Subscription validation</td>
2402
- <td style="padding:15px">{base_path}/{version}/notification?{query}</td>
2403
- <td style="padding:15px">Yes</td>
2404
- </tr>
2405
- <tr>
2406
- <td style="padding:15px">v10Metadata(callback)</td>
2407
- <td style="padding:15px">v1.0 $metadata</td>
2408
- <td style="padding:15px">{base_path}/{version}/v1.0/$metadata?{query}</td>
2409
- <td style="padding:15px">Yes</td>
2410
- </tr>
2411
- <tr>
2412
- <td style="padding:15px">betaMetadata(callback)</td>
2413
- <td style="padding:15px">beta $metadata</td>
2414
- <td style="padding:15px">{base_path}/{version}/beta/$metadata?{query}</td>
2415
- <td style="padding:15px">Yes</td>
2416
- </tr>
2417
- </table>
2418
- <br>
2419
-
2420
- ### Authentication
2421
-
2422
- This document will go through the steps for authenticating the Microsoft_graph adapter with Basic Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/authentication/" target="_blank">HERE</a>.
2423
-
2424
- #### Request Token Authentication
2425
- The Microsoft_graph adapter requires Token Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
2426
-
2427
- STEPS
2428
- 1. Ensure you have access to a Microsoft_graph server and that it is running
2429
- 2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
2430
- 3. Use the properties below for the ```properties.authentication``` field
2431
- 4. Note that the token_URI_path has a variable which should be replaced with a valid tenant value
2432
- ```json
2433
- "authentication": {
2434
- "auth_method": "request_token",
2435
- "username": "",
2436
- "password": "",
2437
- "token": "token",
2438
- "token_timeout": 600000,
2439
- "token_cache": "local",
2440
- "token_URI_path": "/{tenant}/oauth2/v2.0/token",
2441
- "invalid_token_error": 401,
2442
- "auth_field": "header.headers.Authorization",
2443
- "auth_field_format": "Bearer {token}",
2444
- "auth_logging": false,
2445
- "sso": {
2446
- "protocol": "",
2447
- "host": "",
2448
- "port": 0
2449
- }
2450
- }
2451
- ```
2452
- 4. Restart the adapter. If your properties were set correctly, the adapter should go online.
2453
-
2454
- #### Troubleshooting
2455
- - Make sure you copied over the correct username and password.
2456
- - Turn on debug level logs for the adapter in IAP Admin Essentials.
2457
- - Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
2458
- - Investigate the logs - in particular:
2459
- - The FULL REQUEST log to make sure the proper headers are being sent with the request.
2460
- - The FULL BODY log to make sure the payload is accurate.
2461
- - The CALL RETURN log to see what the other system is telling us.
2462
- - Remember when you are done to turn auth_logging off as you do not want to log credentials.
2463
-
2464
- ## Additional Information
2465
-
2466
- ### Enhancements
2467
-
2468
- #### Adding a Second Instance of an Adapter
2469
-
2470
- You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.
2471
-
2472
- #### Adding Adapter Calls
2473
-
2474
- There are multiple ways to add calls to an existing adapter.
2475
-
2476
- The easiest way would be to use the Adapter Builder update process. This process takes in a Swagger or OpenAPI document, allows you to select the calls you want to add and then generates a zip file that can be used to update the adapter. Once you have the zip file simply put it in the adapter directory and execute `npm run adapter:update`.
2477
-
2478
- ```bash
2479
- mv updatePackage.zip adapter-microsoft_graph
2480
- cd adapter-microsoft_graph
2481
- npm run adapter:update
2482
- ```
2483
-
2484
- If you do not have a Swagger or OpenAPI document, you can use a Postman Collection and convert that to an OpenAPI document using APIMatic and then follow the first process.
2485
-
2486
- If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.
2487
-
2488
- ```text
2489
- Files to update
2490
- * entities/<entity>/action.json: add an action
2491
- * entities/<entity>/schema.json (or the schema defined on the action): add action to the enum for ph_request_type
2492
- * adapter.js: add the new method and make sure it calls the proper entity and action
2493
- * pronghorn.json: add the new method
2494
- * test/unit/adapterTestUnit.js (optional but best practice): add unit test(s) - function is there, any required parameters error when not passed in
2495
- * test/integration/adapterTestIntegration.js (optional but best practice): add integration test
2496
- ```
2497
-
2498
- #### Adding Adapter Properties
2499
-
2500
- While changing adapter properties is done in the service instance configuration section of IAP, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.
2501
-
2502
- ```text
2503
- Files to update
2504
- * propertiesSchema.json: add the new property and how it is defined
2505
- * sampleProperties: add the new property with a default value
2506
- * test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
2507
- * test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
2508
- ```
2509
-
2510
- #### Changing Adapter Authentication
2511
-
2512
- Often an adapter is built before knowing the authentication and authentication processes can also change over time. The adapter supports many different kinds of authentication but it does require configuration. Some forms of authentication can be defined entirely with the adapter properties but others require configuration.
2513
-
2514
- ```text
2515
- Files to update
2516
- * entities/.system/action.json: change the getToken action as needed
2517
- * entities/.system/schemaTokenReq.json: add input parameters (external name is name in other system)
2518
- * entities/.system/schemaTokenResp.json: add response parameters (external name is name in other system)
2519
- * propertiesSchema.json: add any new property and how it is defined
2520
- * sampleProperties: add any new property with a default value
2521
- * test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
2522
- * test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
2523
- ```
2524
-
2525
- #### Enhancing Adapter Integration Tests
2526
-
2527
- The adapter integration tests are written to be able to test in either stub (standalone) mode or integrated to the other system. However, if integrating to the other system, you may need to provide better data than what the adapter provides by default as that data is likely to fail for create and update. To provide better data, edit the adapter integration test file. Make sure you do not remove the marker and keep custom code below the marker so you do not impact future migrations. Once the edits are complete, run the integration test as it instructs you to above. When you run integrated to the other system, you can also save mockdata for future use by changing the isSaveMockData flag to true.
2528
-
2529
- ```text
2530
- Files to update
2531
- * test/integration/adapterTestIntegration.js: add better data for the create and update calls so that they will not fail.
2532
- ```
2533
-
2534
- As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.
2535
-
2536
- ### Contributing
2537
-
2538
- First off, thanks for taking the time to contribute!
2539
-
2540
- The following is a set of rules for contributing.
2541
-
2542
- #### Code of Conduct
2543
-
2544
- This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@itential.com.
2545
-
2546
- #### How to Contribute
2547
-
2548
- Follow the contributing guide (here)[https://gitlab.com/itentialopensource/adapters/contributing-guide]
2549
-
2550
- ### Helpful Links
2551
-
2552
- <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a>
2553
-
2554
- ### Node Scripts
2555
-
2556
- There are several node scripts that now accompany the adapter. These scripts are provided to make several activities easier. Many of these scripts can have issues with different versions of IAP as they have dependencies on IAP and Mongo. If you have issues with the scripts please report them to the Itential Adapter Team. Each of these scripts are described below.
2557
-
2558
- <table border="1" class="bordered-table">
2559
- <tr>
2560
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Run</span></th>
2561
- <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
2562
- </tr>
2563
- <tr>
2564
- <td style="padding:15px">npm run adapter:install</td>
2565
- <td style="padding:15px">Provides an easier way to install the adapter.</td>
2566
- </tr>
2567
- <tr>
2568
- <td style="padding:15px">npm run adapter:checkMigrate</td>
2569
- <td style="padding:15px">Checks whether your adapter can and should be migrated to the latest foundation.</td>
2570
- </tr>
2571
- <tr>
2572
- <td style="padding:15px">npm run adapter:findPath</td>
2573
- <td style="padding:15px">Can be used to see if the adapter supports a particular API call.</td>
2574
- </tr>
2575
- <tr>
2576
- <td style="padding:15px">npm run adapter:migrate</td>
2577
- <td style="padding:15px">Provides an easier way to update your adapter after you download the migration zip from Itential DevSite.</td>
2578
- </tr>
2579
- <tr>
2580
- <td style="padding:15px">npm run adapter:update</td>
2581
- <td style="padding:15px">Provides an easier way to update your adapter after you download the update zip from Itential DevSite.</td>
2582
- </tr>
2583
- <tr>
2584
- <td style="padding:15px">npm run adapter:revert</td>
2585
- <td style="padding:15px">Allows you to revert after a migration or update if it resulted in issues.</td>
2586
- </tr>
2587
- <tr>
2588
- <td style="padding:15px">npm run troubleshoot</td>
2589
- <td style="padding:15px">Provides a way to troubleshoot the adapter - runs connectivity, healthcheck and basic get.</td>
2590
- </tr>
2591
- <tr>
2592
- <td style="padding:15px">npm run connectivity</td>
2593
- <td style="padding:15px">Provides a connectivity check to the Servicenow system.</td>
2594
- </tr>
2595
- <tr>
2596
- <td style="padding:15px">npm run healthcheck</td>
2597
- <td style="padding:15px">Checks whether the configured healthcheck call works to Servicenow.</td>
2598
- </tr>
2599
- <tr>
2600
- <td style="padding:15px">npm run basicget</td>
2601
- <td style="padding:15px">Checks whether the basic get calls works to Servicenow.</td>
2602
- </tr>
2603
- </table>
2604
- <br>
2605
-
2606
- ## Troubleshoot
2607
-
2608
- Run `npm run troubleshoot` to start the interactive troubleshooting process. The command allows you to verify and update connection, authentication as well as healthcheck configuration. After that it will test these properties by sending HTTP request to the endpoint. If the tests pass, it will persist these changes into IAP.
2609
-
2610
- You also have the option to run individual commands to perform specific test:
2611
-
2612
- - `npm run healthcheck` will perform a healthcheck request of with current setting.
2613
- - `npm run basicget` will perform some non-parameter GET request with current setting.
2614
- - `npm run connectivity` will perform networking diagnostics of the adatper endpoint.
2615
-
2616
- ### Connectivity Issues
2617
-
2618
- 1. You can run the adapter troubleshooting script which will check connectivity, run the healthcheck and run basic get calls.
2619
-
2620
- ```bash
2621
- npm run troubleshoot
2622
- ```
2623
-
2624
- 2. Verify the adapter properties are set up correctly.
2625
-
2626
- ```text
2627
- Go into the Itential Platform GUI and verify/update the properties
2628
- ```
2629
-
2630
- 3. Verify there is connectivity between the Itential Platform Server and Microsoft_graph Server.
2631
-
2632
- ```text
2633
- ping the ip address of Microsoft_graph server
2634
- try telnet to the ip address port of Microsoft_graph
2635
- execute a curl command to the other system
2636
- ```
2637
-
2638
- 4. Verify the credentials provided for Microsoft_graph.
2639
-
2640
- ```text
2641
- login to Microsoft_graph using the provided credentials
2642
- ```
2643
-
2644
- 5. Verify the API of the call utilized for Microsoft_graph Healthcheck.
2645
-
2646
- ```text
2647
- Go into the Itential Platform GUI and verify/update the properties
2648
- ```
2649
-
2650
- ### Functional Issues
2651
-
2652
- Adapter logs are located in `/var/log/pronghorn`. In older releases of the Itential Platform, there is a `pronghorn.log` file which contains logs for all of the Itential Platform. In newer versions, adapters can be configured to log into their own files.
2653
-
339
+ ## [Generic Adapter Information](https://gitlab.com/itentialopensource/adapters/cloud/adapter-microsoft_graph/-/blob/master/README.md)
2654
340