Preparing search index...
The search index is not available
@zoom/rivet
@zoom/rivet
Users
Module Users
Enumerations
LogLevel
StatusCode
Classes
AwsLambdaReceiver
ConsoleLogger
HttpReceiver
UsersEndpoints
UsersEventProcessor
UsersOAuthClient
UsersS2SAuthClient
Interfaces
BaseResponse
Event
HttpReceiverOptions
Logger
Receiver
ReceiverInitOptions
StateStore
TokenStore
WebEndpointOptions
Type Aliases
AllPropsOptional
ClientConstructorOptions
CommonClientOptions
Constructor
ContactGroupsAddContactGroupMembersPathParams
ContactGroupsAddContactGroupMembersRequestBody
ContactGroupsAddContactGroupMembersResponse
ContactGroupsCreateContactGroupRequestBody
ContactGroupsCreateContactGroupResponse
ContactGroupsDeleteContactGroupPathParams
ContactGroupsGetContactGroupPathParams
ContactGroupsGetContactGroupResponse
ContactGroupsListContactGroupMembersPathParams
ContactGroupsListContactGroupMembersQueryParams
ContactGroupsListContactGroupMembersResponse
ContactGroupsListContactGroupsQueryParams
ContactGroupsListContactGroupsResponse
ContactGroupsRemoveMembersInContactGroupPathParams
ContactGroupsRemoveMembersInContactGroupQueryParams
ContactGroupsUpdateContactGroupPathParams
ContactGroupsUpdateContactGroupRequestBody
Errors
ExactlyOneOf
GenericEventManager
GroupAdminAddedEvent
GroupAdminDeletedEvent
GroupCreatedEvent
GroupDeletedEvent
GroupLockSettingsUpdatedEvent
GroupMemberAddedEvent
GroupMemberDeletedEvent
GroupsAddGroupAdminsPathParams
GroupsAddGroupAdminsRequestBody
GroupsAddGroupMembersPathParams
GroupsAddGroupMembersRequestBody
GroupsCreateGroupRequestBody
GroupsDeleteGroupAdminPathParams
GroupsDeleteGroupMemberPathParams
GroupsDeleteGroupPathParams
GroupsDeleteVirtualBackgroundFilesPathParams
GroupsDeleteVirtualBackgroundFilesQueryParams
GroupSettingsUpdatedEvent
GroupsGetGroupPathParams
GroupsGetGroupResponse
GroupsGetGroupsSettingsPathParams
GroupsGetGroupsSettingsQueryParams
GroupsGetGroupsSettingsResponse
GroupsGetGroupsWebinarRegistrationSettingsPathParams
GroupsGetGroupsWebinarRegistrationSettingsQueryParams
GroupsGetGroupsWebinarRegistrationSettingsResponse
GroupsGetLockedSettingsPathParams
GroupsGetLockedSettingsQueryParams
GroupsGetLockedSettingsResponse
GroupsListGroupAdminsPathParams
GroupsListGroupAdminsQueryParams
GroupsListGroupAdminsResponse
GroupsListGroupChannelsPathParams
GroupsListGroupChannelsResponse
GroupsListGroupMembersPathParams
GroupsListGroupMembersQueryParams
GroupsListGroupMembersResponse
GroupsListGroupsResponse
GroupsUpdateGroupMemberPathParams
GroupsUpdateGroupMemberRequestBody
GroupsUpdateGroupPathParams
GroupsUpdateGroupRequestBody
GroupsUpdateGroupsSettingsPathParams
GroupsUpdateGroupsSettingsQueryParams
GroupsUpdateGroupsSettingsRequestBody
GroupsUpdateGroupsSettingsResponse
GroupsUpdateGroupsWebinarRegistrationSettingsPathParams
GroupsUpdateGroupsWebinarRegistrationSettingsQueryParams
GroupsUpdateGroupsWebinarRegistrationSettingsRequestBody
GroupsUpdateLockedSettingsPathParams
GroupsUpdateLockedSettingsQueryParams
GroupsUpdateLockedSettingsRequestBody
GroupsUploadVirtualBackgroundFilesPathParams
GroupsUploadVirtualBackgroundFilesRequestBody
GroupsUploadVirtualBackgroundFilesResponse
GroupUpdatedEvent
HttpMethod
MaybeArray
MaybePromise
MergedDefaultOptions
NoParams
RequestMimeType
RequiredKeys
StringIndexed
UserActivatedEvent
UserCreatedEvent
UserDeactivatedEvent
UserDeletedEvent
UserDisassociatedEvent
UserInvitationAcceptedEvent
UserPersonalNotesUpdatedEvent
UserPresenceStatusUpdatedEvent
UsersAddAssistantsPathParams
UsersAddAssistantsRequestBody
UsersAddAssistantsResponse
UsersBulkUpdateFeaturesForUserRequestBody
UsersBulkUpdateFeaturesForUserResponse
UsersCheckUserEmailQueryParams
UsersCheckUserEmailResponse
UsersCheckUsersPMRoomQueryParams
UsersCheckUsersPMRoomResponse
UsersCreateUsersRequestBody
UsersCreateUsersResponse
UsersDeleteSchedulerPathParams
UsersDeleteUserAssistantPathParams
UsersDeleteUserAssistantsPathParams
UsersDeleteUserPathParams
UsersDeleteUserQueryParams
UsersDeleteUserSchedulersPathParams
UsersDeleteUsersProfilePicturePathParams
UsersDeleteVirtualBackgroundFilesPathParams
UsersDeleteVirtualBackgroundFilesQueryParams
UserSettingsUpdatedEvent
UsersGetCollaborationDeviceDetailPathParams
UsersGetCollaborationDeviceDetailResponse
UsersGetMeetingTemplateDetailPathParams
UsersGetMeetingTemplateDetailResponse
UsersGetUserPathParams
UsersGetUserPermissionsPathParams
UsersGetUserPermissionsResponse
UsersGetUserPresenceStatusPathParams
UsersGetUserPresenceStatusResponse
UsersGetUserQueryParams
UsersGetUserResponse
UsersGetUserSettingsPathParams
UsersGetUserSettingsQueryParams
UsersGetUserSettingsResponse
UsersGetUsersTokenPathParams
UsersGetUsersTokenQueryParams
UsersGetUsersTokenResponse
UsersGetUserSummaryResponse
UsersGetUsersZAKResponse
UserSignedInEvent
UserSignedOutEvent
UsersListUserAssistantsPathParams
UsersListUserAssistantsResponse
UsersListUserSchedulersPathParams
UsersListUserSchedulersResponse
UsersListUsersCollaborationDevicesPathParams
UsersListUsersCollaborationDevicesResponse
UsersListUsersQueryParams
UsersListUsersResponse
UsersOAuthOptions
UsersRevokeUsersSSOTokenPathParams
UsersS2SAuthOptions
UsersUpdateUserPathParams
UsersUpdateUserQueryParams
UsersUpdateUserRequestBody
UsersUpdateUsersEmailPathParams
UsersUpdateUsersEmailRequestBody
UsersUpdateUserSettingsPathParams
UsersUpdateUserSettingsQueryParams
UsersUpdateUserSettingsRequestBody
UsersUpdateUsersPasswordPathParams
UsersUpdateUsersPasswordRequestBody
UsersUpdateUsersPresenceStatusPathParams
UsersUpdateUsersPresenceStatusRequestBody
UsersUpdateUserStatusPathParams
UsersUpdateUserStatusRequestBody
UsersUploadUsersProfilePicturePathParams
UsersUploadUsersProfilePictureRequestBody
UsersUploadUsersProfilePictureResponse
UsersUploadVirtualBackgroundFilesPathParams
UsersUploadVirtualBackgroundFilesRequestBody
UsersUploadVirtualBackgroundFilesResponse
UserUpdatedEvent
WideInstallerOptions
ZoomResponseError
Variables
ApiResponseError
AwsReceiverRequestError
ClientCredentialsRawResponseError
CommonHttpRequestError
DEFAULT_HTTP_RECEIVER_PORT
HTTPReceiverConstructionError
HTTPReceiverPortNotNumberError
HTTPReceiverRequestError
OAuthInstallerNotInitializedError
OAuthStateVerificationFailedError
OAuthTokenDoesNotExistError
OAuthTokenFetchFailedError
OAuthTokenRawResponseError
OAuthTokenRefreshFailedError
ProductClientConstructionError
ReceiverInconsistentStateError
ReceiverOAuthFlowError
S2SRawResponseError
Functions
isCoreError
isStateStore
mergeDefaultOptions
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Enumerations
Log
Level
Status
Code
Classes
Aws
Lambda
Receiver
Console
Logger
Http
Receiver
Users
Endpoints
Users
Event
Processor
UsersOAuth
Client
Users
S2SAuth
Client
Interfaces
Base
Response
Event
Http
Receiver
Options
Logger
Receiver
Receiver
Init
Options
State
Store
Token
Store
Web
Endpoint
Options
Type Aliases
All
Props
Optional
Client
Constructor
Options
Common
Client
Options
Constructor
Contact
Groups
Add
Contact
Group
Members
Path
Params
Contact
Groups
Add
Contact
Group
Members
Request
Body
Contact
Groups
Add
Contact
Group
Members
Response
Contact
Groups
Create
Contact
Group
Request
Body
Contact
Groups
Create
Contact
Group
Response
Contact
Groups
Delete
Contact
Group
Path
Params
Contact
Groups
Get
Contact
Group
Path
Params
Contact
Groups
Get
Contact
Group
Response
Contact
Groups
List
Contact
Group
Members
Path
Params
Contact
Groups
List
Contact
Group
Members
Query
Params
Contact
Groups
List
Contact
Group
Members
Response
Contact
Groups
List
Contact
Groups
Query
Params
Contact
Groups
List
Contact
Groups
Response
Contact
Groups
Remove
Members
In
Contact
Group
Path
Params
Contact
Groups
Remove
Members
In
Contact
Group
Query
Params
Contact
Groups
Update
Contact
Group
Path
Params
Contact
Groups
Update
Contact
Group
Request
Body
Errors
Exactly
One
Of
Generic
Event
Manager
Group
Admin
Added
Event
Group
Admin
Deleted
Event
Group
Created
Event
Group
Deleted
Event
Group
Lock
Settings
Updated
Event
Group
Member
Added
Event
Group
Member
Deleted
Event
Groups
Add
Group
Admins
Path
Params
Groups
Add
Group
Admins
Request
Body
Groups
Add
Group
Members
Path
Params
Groups
Add
Group
Members
Request
Body
Groups
Create
Group
Request
Body
Groups
Delete
Group
Admin
Path
Params
Groups
Delete
Group
Member
Path
Params
Groups
Delete
Group
Path
Params
Groups
Delete
Virtual
Background
Files
Path
Params
Groups
Delete
Virtual
Background
Files
Query
Params
Group
Settings
Updated
Event
Groups
Get
Group
Path
Params
Groups
Get
Group
Response
Groups
Get
Groups
Settings
Path
Params
Groups
Get
Groups
Settings
Query
Params
Groups
Get
Groups
Settings
Response
Groups
Get
Groups
Webinar
Registration
Settings
Path
Params
Groups
Get
Groups
Webinar
Registration
Settings
Query
Params
Groups
Get
Groups
Webinar
Registration
Settings
Response
Groups
Get
Locked
Settings
Path
Params
Groups
Get
Locked
Settings
Query
Params
Groups
Get
Locked
Settings
Response
Groups
List
Group
Admins
Path
Params
Groups
List
Group
Admins
Query
Params
Groups
List
Group
Admins
Response
Groups
List
Group
Channels
Path
Params
Groups
List
Group
Channels
Response
Groups
List
Group
Members
Path
Params
Groups
List
Group
Members
Query
Params
Groups
List
Group
Members
Response
Groups
List
Groups
Response
Groups
Update
Group
Member
Path
Params
Groups
Update
Group
Member
Request
Body
Groups
Update
Group
Path
Params
Groups
Update
Group
Request
Body
Groups
Update
Groups
Settings
Path
Params
Groups
Update
Groups
Settings
Query
Params
Groups
Update
Groups
Settings
Request
Body
Groups
Update
Groups
Settings
Response
Groups
Update
Groups
Webinar
Registration
Settings
Path
Params
Groups
Update
Groups
Webinar
Registration
Settings
Query
Params
Groups
Update
Groups
Webinar
Registration
Settings
Request
Body
Groups
Update
Locked
Settings
Path
Params
Groups
Update
Locked
Settings
Query
Params
Groups
Update
Locked
Settings
Request
Body
Groups
Upload
Virtual
Background
Files
Path
Params
Groups
Upload
Virtual
Background
Files
Request
Body
Groups
Upload
Virtual
Background
Files
Response
Group
Updated
Event
Http
Method
Maybe
Array
Maybe
Promise
Merged
Default
Options
No
Params
Request
Mime
Type
Required
Keys
String
Indexed
User
Activated
Event
User
Created
Event
User
Deactivated
Event
User
Deleted
Event
User
Disassociated
Event
User
Invitation
Accepted
Event
User
Personal
Notes
Updated
Event
User
Presence
Status
Updated
Event
Users
Add
Assistants
Path
Params
Users
Add
Assistants
Request
Body
Users
Add
Assistants
Response
Users
Bulk
Update
Features
For
User
Request
Body
Users
Bulk
Update
Features
For
User
Response
Users
Check
User
Email
Query
Params
Users
Check
User
Email
Response
Users
Check
UsersPMRoom
Query
Params
Users
Check
UsersPMRoom
Response
Users
Create
Users
Request
Body
Users
Create
Users
Response
Users
Delete
Scheduler
Path
Params
Users
Delete
User
Assistant
Path
Params
Users
Delete
User
Assistants
Path
Params
Users
Delete
User
Path
Params
Users
Delete
User
Query
Params
Users
Delete
User
Schedulers
Path
Params
Users
Delete
Users
Profile
Picture
Path
Params
Users
Delete
Virtual
Background
Files
Path
Params
Users
Delete
Virtual
Background
Files
Query
Params
User
Settings
Updated
Event
Users
Get
Collaboration
Device
Detail
Path
Params
Users
Get
Collaboration
Device
Detail
Response
Users
Get
Meeting
Template
Detail
Path
Params
Users
Get
Meeting
Template
Detail
Response
Users
Get
User
Path
Params
Users
Get
User
Permissions
Path
Params
Users
Get
User
Permissions
Response
Users
Get
User
Presence
Status
Path
Params
Users
Get
User
Presence
Status
Response
Users
Get
User
Query
Params
Users
Get
User
Response
Users
Get
User
Settings
Path
Params
Users
Get
User
Settings
Query
Params
Users
Get
User
Settings
Response
Users
Get
Users
Token
Path
Params
Users
Get
Users
Token
Query
Params
Users
Get
Users
Token
Response
Users
Get
User
Summary
Response
Users
Get
UsersZAKResponse
User
Signed
In
Event
User
Signed
Out
Event
Users
List
User
Assistants
Path
Params
Users
List
User
Assistants
Response
Users
List
User
Schedulers
Path
Params
Users
List
User
Schedulers
Response
Users
List
Users
Collaboration
Devices
Path
Params
Users
List
Users
Collaboration
Devices
Response
Users
List
Users
Query
Params
Users
List
Users
Response
UsersOAuth
Options
Users
Revoke
UsersSSOToken
Path
Params
Users
S2SAuth
Options
Users
Update
User
Path
Params
Users
Update
User
Query
Params
Users
Update
User
Request
Body
Users
Update
Users
Email
Path
Params
Users
Update
Users
Email
Request
Body
Users
Update
User
Settings
Path
Params
Users
Update
User
Settings
Query
Params
Users
Update
User
Settings
Request
Body
Users
Update
Users
Password
Path
Params
Users
Update
Users
Password
Request
Body
Users
Update
Users
Presence
Status
Path
Params
Users
Update
Users
Presence
Status
Request
Body
Users
Update
User
Status
Path
Params
Users
Update
User
Status
Request
Body
Users
Upload
Users
Profile
Picture
Path
Params
Users
Upload
Users
Profile
Picture
Request
Body
Users
Upload
Users
Profile
Picture
Response
Users
Upload
Virtual
Background
Files
Path
Params
Users
Upload
Virtual
Background
Files
Request
Body
Users
Upload
Virtual
Background
Files
Response
User
Updated
Event
Wide
Installer
Options
Zoom
Response
Error
Variables
Api
Response
Error
Aws
Receiver
Request
Error
Client
Credentials
Raw
Response
Error
Common
Http
Request
Error
DEFAULT_
HTTP_
RECEIVER_
PORT
HTTPReceiver
Construction
Error
HTTPReceiver
Port
Not
Number
Error
HTTPReceiver
Request
Error
OAuth
Installer
Not
Initialized
Error
OAuth
State
Verification
Failed
Error
OAuth
Token
Does
Not
Exist
Error
OAuth
Token
Fetch
Failed
Error
OAuth
Token
Raw
Response
Error
OAuth
Token
Refresh
Failed
Error
Product
Client
Construction
Error
Receiver
Inconsistent
State
Error
ReceiverOAuth
Flow
Error
S2SRaw
Response
Error
Functions
is
Core
Error
is
State
Store
merge
Default
Options
@zoom/rivet
Loading...