user

Source:
Author:
  • Aryan Pandey
Category of endpoints for Zoom users

Methods

activate(opts)

Source:
Author:
  • Gabe Abrams
(Re)activate a user and promote them to a "licensed" user (unless dontPromoteToLicensed is true)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Attributes Description
userId the user ID or email address of the user
dontPromoteToLicensed <optional>
 if true, the user will not be promoted to a "licensed" user just after activation

addWebinarLicense(opts)

Source:
Author:
  • Gabe Abrams
Add a webinar license to the user of interest
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Attributes Default Description
userId the user ID or email address of the user
webinarCapacity <optional>
 500 the max capacity for this user's webinars. Allowed values: 100, 500, 1000, 3000, 5000, 10000

get(opts)

Source:
Author:
  • Gabe Abrams
Get a user
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Description
userId the user ID or email address of the user
Returns:
Zoom user object https://marketplace.zoom.us/docs/api-reference/zoom-api/methods/#operation/user

getZAKToken(opts)

Source:
Author:
  • Aryan Pandey
Retrieve a user's ZAK token
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Description
userId the user ID or email address of the user
Returns:
the ZAK token of the user

promoteToLicensed(opts)

Source:
Author:
  • Gabe Abrams
Promote a user to "licensed" type
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Description
userId the user ID or email address of the user