- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/Groups.html b/docs/jsdoc/Groups.html
index a7640eb0..b9030929 100644
--- a/docs/jsdoc/Groups.html
+++ b/docs/jsdoc/Groups.html
@@ -265,7 +265,7 @@ Type:
Source:
@@ -337,7 +337,7 @@ Type:
Source:
@@ -3014,6 +3014,169 @@ Returns:
+ terminateSession(groupIDs) → {Promise.<Object>}
+
+
+
+
+
+
+
+ Validates the roles and permissions of the group,
+and creates asynchronous jobs to terminate the group's sessions.
+
+API Endpoint: '/groups/terminate_sessions'
+Method: POST
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ groupIDs
+
+
+
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+ A list of group IDs
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ A promise resolving a message about the request status.
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Object>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
update(groupID, updates, callbackopt ) → {Promise.<Object>}
@@ -3502,7 +3665,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/LegalHoldPolicies.html b/docs/jsdoc/LegalHoldPolicies.html
index e6ac8e74..1b5993ec 100644
--- a/docs/jsdoc/LegalHoldPolicies.html
+++ b/docs/jsdoc/LegalHoldPolicies.html
@@ -3368,7 +3368,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/Metadata.html b/docs/jsdoc/Metadata.html
index 0a244877..9748f247 100644
--- a/docs/jsdoc/Metadata.html
+++ b/docs/jsdoc/Metadata.html
@@ -3601,7 +3601,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/PagingIterator.html b/docs/jsdoc/PagingIterator.html
index 123ac9d5..1d4925b6 100644
--- a/docs/jsdoc/PagingIterator.html
+++ b/docs/jsdoc/PagingIterator.html
@@ -776,7 +776,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/PersistentSession.html b/docs/jsdoc/PersistentSession.html
index 821261f3..43f16cc7 100644
--- a/docs/jsdoc/PersistentSession.html
+++ b/docs/jsdoc/PersistentSession.html
@@ -1130,7 +1130,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/RecentItems.html b/docs/jsdoc/RecentItems.html
index 24bab313..5ad31ddd 100644
--- a/docs/jsdoc/RecentItems.html
+++ b/docs/jsdoc/RecentItems.html
@@ -566,7 +566,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/RetentionPolicies.html b/docs/jsdoc/RetentionPolicies.html
index a4e7a179..7f8f66c1 100644
--- a/docs/jsdoc/RetentionPolicies.html
+++ b/docs/jsdoc/RetentionPolicies.html
@@ -4433,7 +4433,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/Search.html b/docs/jsdoc/Search.html
index 068db980..eac4a2a1 100644
--- a/docs/jsdoc/Search.html
+++ b/docs/jsdoc/Search.html
@@ -1208,7 +1208,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SharedItems.html b/docs/jsdoc/SharedItems.html
index 74e581af..448d7d92 100644
--- a/docs/jsdoc/SharedItems.html
+++ b/docs/jsdoc/SharedItems.html
@@ -503,7 +503,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SignRequest.html b/docs/jsdoc/SignRequest.html
index c8f7526d..cc4f9f2d 100644
--- a/docs/jsdoc/SignRequest.html
+++ b/docs/jsdoc/SignRequest.html
@@ -748,7 +748,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:59 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SignRequestCreateRequest.html b/docs/jsdoc/SignRequestCreateRequest.html
index 013692df..bf52e35e 100644
--- a/docs/jsdoc/SignRequestCreateRequest.html
+++ b/docs/jsdoc/SignRequestCreateRequest.html
@@ -1162,7 +1162,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:59 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SignRequestCreateSigner.html b/docs/jsdoc/SignRequestCreateSigner.html
index 9820b861..6d05cdd2 100644
--- a/docs/jsdoc/SignRequestCreateSigner.html
+++ b/docs/jsdoc/SignRequestCreateSigner.html
@@ -812,7 +812,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:59 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SignRequestPrefillTag.html b/docs/jsdoc/SignRequestPrefillTag.html
index 6f35d60b..0e286517 100644
--- a/docs/jsdoc/SignRequestPrefillTag.html
+++ b/docs/jsdoc/SignRequestPrefillTag.html
@@ -422,7 +422,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:59 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SignRequestSigner.html b/docs/jsdoc/SignRequestSigner.html
index 8f53134a..0a061962 100644
--- a/docs/jsdoc/SignRequestSigner.html
+++ b/docs/jsdoc/SignRequestSigner.html
@@ -347,7 +347,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:59 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SignRequestSignerInput.html b/docs/jsdoc/SignRequestSignerInput.html
index f9d66cc7..2bf4d9c1 100644
--- a/docs/jsdoc/SignRequestSignerInput.html
+++ b/docs/jsdoc/SignRequestSignerInput.html
@@ -390,7 +390,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:59 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SignRequests.html b/docs/jsdoc/SignRequests.html
index 8c8f00c6..76074834 100644
--- a/docs/jsdoc/SignRequests.html
+++ b/docs/jsdoc/SignRequests.html
@@ -351,7 +351,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:59 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SignRequestsManager.html b/docs/jsdoc/SignRequestsManager.html
index e64a1358..c7b55e54 100644
--- a/docs/jsdoc/SignRequestsManager.html
+++ b/docs/jsdoc/SignRequestsManager.html
@@ -1512,7 +1512,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:59 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/StoragePolicies.html b/docs/jsdoc/StoragePolicies.html
index e6198378..710391e8 100644
--- a/docs/jsdoc/StoragePolicies.html
+++ b/docs/jsdoc/StoragePolicies.html
@@ -2200,7 +2200,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:59 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/Tasks.html b/docs/jsdoc/Tasks.html
index 951186fe..49ddd057 100644
--- a/docs/jsdoc/Tasks.html
+++ b/docs/jsdoc/Tasks.html
@@ -2896,7 +2896,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:59 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/TermsOfService.html b/docs/jsdoc/TermsOfService.html
index da31d621..9ed58679 100644
--- a/docs/jsdoc/TermsOfService.html
+++ b/docs/jsdoc/TermsOfService.html
@@ -2754,7 +2754,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:59 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/TokenManager.html b/docs/jsdoc/TokenManager.html
index 0aa40b38..0e5e8f2f 100644
--- a/docs/jsdoc/TokenManager.html
+++ b/docs/jsdoc/TokenManager.html
@@ -2209,7 +2209,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:59 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/Trash.html b/docs/jsdoc/Trash.html
index ac62c6f1..57bcfd03 100644
--- a/docs/jsdoc/Trash.html
+++ b/docs/jsdoc/Trash.html
@@ -500,7 +500,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:59 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/Users.html b/docs/jsdoc/Users.html
index 2a17bb00..438495ca 100644
--- a/docs/jsdoc/Users.html
+++ b/docs/jsdoc/Users.html
@@ -260,7 +260,7 @@ Type:
Source:
@@ -2623,6 +2623,263 @@ Returns:
+ terminateSession(options) → {Promise.<Object>}
+
+
+
+
+
+
+
+ Validates the roles and permissions of the user,
+and creates asynchronous jobs to terminate the user's sessions.
+
+API Endpoint: '/users/terminate_sessions'
+Method: POST
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The user IDs or logins to terminate sessions
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userIDs
+
+
+
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ The user IDs to terminate sessions
+
+
+
+
+
+
+ userLogins
+
+
+
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ The user logins to terminate sessions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ A promise resolving a message about the request status.
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Object>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
update(userID, updates, callbackopt ) → {Promise.<Object>}
@@ -2875,7 +3132,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:59 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/WebLinks.html b/docs/jsdoc/WebLinks.html
index d956d9cf..e81f118e 100644
--- a/docs/jsdoc/WebLinks.html
+++ b/docs/jsdoc/WebLinks.html
@@ -2406,7 +2406,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:59 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/Webhooks.html b/docs/jsdoc/Webhooks.html
index 01dd88d7..a4750f70 100644
--- a/docs/jsdoc/Webhooks.html
+++ b/docs/jsdoc/Webhooks.html
@@ -2700,7 +2700,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:59 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/api-request-manager.ts.html b/docs/jsdoc/api-request-manager.ts.html
index 2490768a..b7e395d1 100644
--- a/docs/jsdoc/api-request-manager.ts.html
+++ b/docs/jsdoc/api-request-manager.ts.html
@@ -129,7 +129,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/api-request.ts.html b/docs/jsdoc/api-request.ts.html
index 7352b906..29ddf352 100644
--- a/docs/jsdoc/api-request.ts.html
+++ b/docs/jsdoc/api-request.ts.html
@@ -467,7 +467,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/box-client.ts.html b/docs/jsdoc/box-client.ts.html
index 332ec8ee..85a9a22e 100644
--- a/docs/jsdoc/box-client.ts.html
+++ b/docs/jsdoc/box-client.ts.html
@@ -926,7 +926,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/box-node-sdk.ts.html b/docs/jsdoc/box-node-sdk.ts.html
index b0f82269..d057e705 100644
--- a/docs/jsdoc/box-node-sdk.ts.html
+++ b/docs/jsdoc/box-node-sdk.ts.html
@@ -535,7 +535,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/chunked-uploader.ts.html b/docs/jsdoc/chunked-uploader.ts.html
index 92bb4e10..ca387805 100644
--- a/docs/jsdoc/chunked-uploader.ts.html
+++ b/docs/jsdoc/chunked-uploader.ts.html
@@ -484,7 +484,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/enterprise-event-stream.ts.html b/docs/jsdoc/enterprise-event-stream.ts.html
index 08dfe521..a7ac8387 100644
--- a/docs/jsdoc/enterprise-event-stream.ts.html
+++ b/docs/jsdoc/enterprise-event-stream.ts.html
@@ -317,7 +317,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/event-stream.ts.html b/docs/jsdoc/event-stream.ts.html
index c3b0a44e..7944fcb1 100644
--- a/docs/jsdoc/event-stream.ts.html
+++ b/docs/jsdoc/event-stream.ts.html
@@ -404,7 +404,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/global.html b/docs/jsdoc/global.html
index 2a00188b..e6593411 100644
--- a/docs/jsdoc/global.html
+++ b/docs/jsdoc/global.html
@@ -7733,7 +7733,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/index.html b/docs/jsdoc/index.html
index ae67fb99..47a235c0 100644
--- a/docs/jsdoc/index.html
+++ b/docs/jsdoc/index.html
@@ -2195,7 +2195,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_collaboration-allowlist.ts.html b/docs/jsdoc/managers_collaboration-allowlist.ts.html
index 796d6fdd..c1522edc 100644
--- a/docs/jsdoc/managers_collaboration-allowlist.ts.html
+++ b/docs/jsdoc/managers_collaboration-allowlist.ts.html
@@ -333,7 +333,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_collaborations.ts.html b/docs/jsdoc/managers_collaborations.ts.html
index 1d00dda3..293b00b9 100644
--- a/docs/jsdoc/managers_collaborations.ts.html
+++ b/docs/jsdoc/managers_collaborations.ts.html
@@ -430,7 +430,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_collections.ts.html b/docs/jsdoc/managers_collections.ts.html
index 590a3f1d..dcfd0e1a 100644
--- a/docs/jsdoc/managers_collections.ts.html
+++ b/docs/jsdoc/managers_collections.ts.html
@@ -131,7 +131,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_comments.ts.html b/docs/jsdoc/managers_comments.ts.html
index fc96cdd5..118cea23 100644
--- a/docs/jsdoc/managers_comments.ts.html
+++ b/docs/jsdoc/managers_comments.ts.html
@@ -274,7 +274,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_device-pins.ts.html b/docs/jsdoc/managers_device-pins.ts.html
index 527187e2..206c0100 100644
--- a/docs/jsdoc/managers_device-pins.ts.html
+++ b/docs/jsdoc/managers_device-pins.ts.html
@@ -169,7 +169,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_enterprise.ts.html b/docs/jsdoc/managers_enterprise.ts.html
index 67cf252d..a8a2873e 100644
--- a/docs/jsdoc/managers_enterprise.ts.html
+++ b/docs/jsdoc/managers_enterprise.ts.html
@@ -338,7 +338,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_events.ts.html b/docs/jsdoc/managers_events.ts.html
index c94f95b6..add77f60 100644
--- a/docs/jsdoc/managers_events.ts.html
+++ b/docs/jsdoc/managers_events.ts.html
@@ -408,7 +408,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_file-requests-manager.ts.html b/docs/jsdoc/managers_file-requests-manager.ts.html
index 731201c3..9d47aef3 100644
--- a/docs/jsdoc/managers_file-requests-manager.ts.html
+++ b/docs/jsdoc/managers_file-requests-manager.ts.html
@@ -144,7 +144,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_files.ts.html b/docs/jsdoc/managers_files.ts.html
index fd7fc907..cf0754ee 100644
--- a/docs/jsdoc/managers_files.ts.html
+++ b/docs/jsdoc/managers_files.ts.html
@@ -2164,7 +2164,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_folders.ts.html b/docs/jsdoc/managers_folders.ts.html
index 594a9758..b6ec0f9c 100644
--- a/docs/jsdoc/managers_folders.ts.html
+++ b/docs/jsdoc/managers_folders.ts.html
@@ -911,7 +911,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_groups.ts.html b/docs/jsdoc/managers_groups.ts.html
index 452f861f..fc2ad20d 100644
--- a/docs/jsdoc/managers_groups.ts.html
+++ b/docs/jsdoc/managers_groups.ts.html
@@ -420,6 +420,32 @@ Source: managers/groups.ts
callback
);
}
+
+
+ /**
+ * Validates the roles and permissions of the group,
+ * and creates asynchronous jobs to terminate the group's sessions.
+ *
+ * API Endpoint: '/groups/terminate_sessions'
+ * Method: POST
+ *
+ * @param {string[]} groupIDs A list of group IDs
+ * @returns {Promise<Object>} A promise resolving a message about the request status.
+ */
+ terminateSession(groupIDs: string[], callback?: Function) {
+ var apiPath = urlPath(BASE_PATH, 'terminate_sessions'),
+ params = {
+ body: {
+ group_ids: groupIDs
+ }
+ };
+
+ return this.client.wrapWithDefaultHandler(this.client.post)(
+ apiPath,
+ params,
+ callback
+ )
+ }
}
/**
@@ -452,7 +478,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_legal-hold-policies.ts.html b/docs/jsdoc/managers_legal-hold-policies.ts.html
index afc46a06..def1162e 100644
--- a/docs/jsdoc/managers_legal-hold-policies.ts.html
+++ b/docs/jsdoc/managers_legal-hold-policies.ts.html
@@ -433,7 +433,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_metadata.ts.html b/docs/jsdoc/managers_metadata.ts.html
index b39df21e..a40e5858 100644
--- a/docs/jsdoc/managers_metadata.ts.html
+++ b/docs/jsdoc/managers_metadata.ts.html
@@ -495,7 +495,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_recent-items.ts.html b/docs/jsdoc/managers_recent-items.ts.html
index d61d0caf..76a74bf6 100644
--- a/docs/jsdoc/managers_recent-items.ts.html
+++ b/docs/jsdoc/managers_recent-items.ts.html
@@ -115,7 +115,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_retention-policies.ts.html b/docs/jsdoc/managers_retention-policies.ts.html
index 0f1c5b8a..6063e083 100644
--- a/docs/jsdoc/managers_retention-policies.ts.html
+++ b/docs/jsdoc/managers_retention-policies.ts.html
@@ -611,7 +611,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_search.ts.html b/docs/jsdoc/managers_search.ts.html
index f274a0ba..703bf1f3 100644
--- a/docs/jsdoc/managers_search.ts.html
+++ b/docs/jsdoc/managers_search.ts.html
@@ -191,7 +191,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_shared-items.ts.html b/docs/jsdoc/managers_shared-items.ts.html
index 75544447..8424809b 100644
--- a/docs/jsdoc/managers_shared-items.ts.html
+++ b/docs/jsdoc/managers_shared-items.ts.html
@@ -134,7 +134,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_sign-requests.generated.ts.html b/docs/jsdoc/managers_sign-requests.generated.ts.html
index 907504b9..1ca0026c 100644
--- a/docs/jsdoc/managers_sign-requests.generated.ts.html
+++ b/docs/jsdoc/managers_sign-requests.generated.ts.html
@@ -210,7 +210,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_storage-policies.ts.html b/docs/jsdoc/managers_storage-policies.ts.html
index 4f33d934..e1fcd02a 100644
--- a/docs/jsdoc/managers_storage-policies.ts.html
+++ b/docs/jsdoc/managers_storage-policies.ts.html
@@ -295,7 +295,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_tasks.ts.html b/docs/jsdoc/managers_tasks.ts.html
index 3f5c0615..49fa11e1 100644
--- a/docs/jsdoc/managers_tasks.ts.html
+++ b/docs/jsdoc/managers_tasks.ts.html
@@ -398,7 +398,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_terms-of-service.ts.html b/docs/jsdoc/managers_terms-of-service.ts.html
index 2d40d01d..944d92b5 100644
--- a/docs/jsdoc/managers_terms-of-service.ts.html
+++ b/docs/jsdoc/managers_terms-of-service.ts.html
@@ -436,7 +436,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_trash.ts.html b/docs/jsdoc/managers_trash.ts.html
index 2e79a910..08f5c3af 100644
--- a/docs/jsdoc/managers_trash.ts.html
+++ b/docs/jsdoc/managers_trash.ts.html
@@ -111,7 +111,7 @@ Classes
- Documentation generated by JSDoc 3.6.11 on Thu Nov 10 2022 05:48:07 GMT-0800 (Pacific Standard Time)
+ Documentation generated by JSDoc 3.6.11 on Wed Dec 21 2022 06:25:58 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_users.ts.html b/docs/jsdoc/managers_users.ts.html
index 5d5dfbd3..0cbb2589 100644
--- a/docs/jsdoc/managers_users.ts.html
+++ b/docs/jsdoc/managers_users.ts.html
@@ -184,9 +184,11 @@ Source: managers/users.ts
addEmailAlias(
userID: string,
email: string,
- options?: {
- is_confirmed?: boolean;
- } | Function,
+ options?:
+ | {
+ is_confirmed?: boolean;
+ }
+ | Function,
callback?: Function
) {
options = options || {};
@@ -292,24 +294,28 @@ Source: managers/users.ts
/**
* Set the user's avatar image.
- *
+ *
* API Endpoint: '/users/:userID/avatar'
* Method: POST
- *
+ *
* @param {string} userID The ID of the user whose avatar should be set
* @param {string|Buffer|ReadStream} avatar - the content of the file. It can be a string, a Buffer, or a read stream
* (like that returned by fs.createReadStream()).
* @param {Function} [callback] Passed dictionary of picture urls if successful
* @returns {Promise<Object>} A promise resolving to the picture urls
*/
- setAvatar(userID: string, avatar: string | Buffer | Readable, callback?: Function) {
+ setAvatar(
+ userID: string,
+ avatar: string | Buffer | Readable,
+ callback?: Function
+ ) {
var apiPath = urlPath(BASE_PATH, userID, 'avatar'),
params = {
formData: {
pic: avatar,
- }
+ },
};
-
+
return this.client.wrapWithDefaultHandler(this.client.post)(
apiPath,
params,
@@ -319,10 +325,10 @@ Source: managers/users.ts
/**
* Delete the user's avatar image.
- *
+ *
* API Endpoint: '/users/:userID/avatar'
* Method: DELETE
- *
+ *
* @param {string} userID The ID of the user whose avatar should be deleted
* @param {Function} [callback] Passed nothing if successful
* @returns {Promise<void>} A promise resolving to nothing
@@ -330,7 +336,7 @@ Source: managers/users.ts
deleteAvatar(userID: string, callback?: Function) {
var apiPath = urlPath(BASE_PATH, userID, 'avatar'),
params = {};
-
+
return this.client.wrapWithDefaultHandler(this.client.del)(
apiPath,
params,
@@ -338,10 +344,34 @@ Source: managers/users.ts
);
}
- // @NOTE(fschott) 2014-05-06: Still need to implement get, edit, create, etc.
- // The problem is that they are only available to enterprise admins, so we'll
- // first need to figure out how we want to handle access to those methods.
- // Remove this comment once we have.
+ /**
+ * Validates the roles and permissions of the user,
+ * and creates asynchronous jobs to terminate the user's sessions.
+ *
+ * API Endpoint: '/users/terminate_sessions'
+ * Method: POST
+ *
+ * @param {Object} options - The user IDs or logins to terminate sessions
+ * @param {string[]} [options.userIDs] - The user IDs to terminate sessions
+ * @param {string[]} [options.userLogins] - The user logins to terminate sessions
+ * @returns {Promise<Object>} A promise resolving a message about the request status.
+ */
+ terminateSession(options: {
+ userIDs?: string[],
+ userLogins?: string[],
+ },
+ callback?: Function
+ ) {
+ var apiPath = urlPath(BASE_PATH, 'terminate_sessions'),
+ params = {
+ body: options
+ };
+ return this.client.wrapWithDefaultHandler(this.client.post)(
+ apiPath,
+ params,
+ callback
+ );
+ }
}
/** @const {string} */
@@ -368,7 +398,7 @@ Classes