Skip to content

Commit ff16a15

Browse files
authored
Update README.md
Removed language explaining deprecation of JWT. Changed header types.
1 parent 3d801f6 commit ff16a15

File tree

1 file changed

+17
-25
lines changed

1 file changed

+17
-25
lines changed

README.md

Lines changed: 17 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,20 @@
11
[![Build status](https://ci.appveyor.com/api/projects/status/e7svaoe2hmlrrnje?svg=true)](https://ci.appveyor.com/project/JosephMcEvoy/pszoom)
22

3-
# Update - PSZoom 2.0 #
4-
PSZoom is ending support for JWT. As of 2.0 only Server-to-Server OAuth is supported. JWT authorization is supported in versions prior to 2.0. If you are using JWT, you should update your code to support Server-To-Server Oauth. Zoom will be dropping support of JWT in June of 2023.
5-
6-
A new cmdlet, Connect-PSZoom, must be run before using any other PSZoom cmdlets. This change, along with the dropping of support for JWT, means that old scripts will not work with this version. Instead of declaring variables such as ZoomApiKey and ZoomApiSecret, you should use Connect-PSZoom.
7-
8-
You can read more about JWT deprecation at [https://marketplace.zoom.us/docs/guides/build/jwt-app/jwt-faq/](https://marketplace.zoom.us/docs/guides/build/jwt-app/jwt-faq/) and more about a Zoom server-to-server Oauth app at [https://marketplace.zoom.us/docs/guides/build/server-to-server-oauth-app/](https://marketplace.zoom.us/docs/guides/build/server-to-server-oauth-app/).
9-
103
# PSZoom #
11-
- - - -
124
PSZoom is a Powershell wrapper to interface with Zoom's API (Zoom Video Communications). The module wraps many API calls from Zoom's API v2 documentation. You can find Zoom's documentation at https://marketplace.zoom.us/docs/api-reference/zoom-api. PSZoom is not an official module.
135

146
Cmdlets are named with approved Powershell verbs but keeping to as close to Zoom's API reference as possible. For example, Zoom has two API calls that they named "List User Assistants" and "Update Zoom Meeting". In PSZoom they are named Get-ZoomUserAssistants and Update-ZoomMeeting, respectively. In general, each cmdlet has associated help which includes a link (found under .LINK) to the API call that it is wrapping.
157

168
Zoom has a rate limit that varies depending on your account and the type of request. If you're making too many requests, the cmdlet will automatically retry after one second.
179

18-
# Getting started #
19-
## Using PowershellGallery ##
10+
## Getting started ##
11+
### Using PowershellGallery ###
2012
```
2113
Install-Module PSZoom
2214
Import-Module PSZoom
2315
```
2416

25-
## Using Git ##
17+
### Using Git ###
2618
Clone the repository.
2719
```
2820
git clone "https://github.com/JosephMcEvoy/PSZoom.git"
@@ -36,30 +28,30 @@ Import the module.
3628
Import-Module PSZoom
3729
```
3830

39-
# Using your API key and API secret #
31+
## Using your API key and API secret ##
4032
All commands require a Client ID and Client Secret. As of PSZoom 2.0, PSZoom only supports Server-to-Server OAuth authorization. You can generate the Server-to-Server OAuth key/secret from https://marketplace.zoom.us/develop/create, then click on 'Create' under Server-to-Server OAuth.
4133

4234

43-
# Example script #
35+
## Example script ##
4436
```
4537
import-module PSZoom
4638
Connect-PSZoom -AccountID 'account_id' -ClientID 'client_id' -ClientSecret 'secret'
4739
Get-ZoomMeeting 123456789
4840
```
4941

50-
# Available functions #
42+
## Available functions ##
5143
Use get-help for more information about each function.
5244

5345

54-
## Cloud Recordings ##
46+
### Cloud Recordings ###
5547
Get-ZoomAccountRecordings
5648
Get-ZoomAccountRecordings
5749
Get-ZoomMeetingCloudRecordings
5850
Remove-ZoomMeetingRecordingFile
5951
Remove-ZoomMeetingRecordings
6052
Show-ZoomRecordings
6153

62-
## Groups ##
54+
### Groups ###
6355
Add-ZoomGroupMember
6456
Get-ZoomGroup
6557
Get-ZoomGroupLockSettings
@@ -73,7 +65,7 @@ Update-ZoomGroup
7365
Update-ZoomGroupLockSettings
7466
Update-ZoomGroupSettings
7567

76-
## Meetings ##
68+
### Meetings ###
7769
Add-ZoomRegistrant
7870
Get-ZoomEndedMeetingInstances
7971
Get-ZoomMeeting
@@ -102,7 +94,7 @@ Update-ZoomMeetingRegistrantStatus
10294
Update-ZoomMeetingRegistrationQuestions
10395
Update-ZoomMeetingStatus
10496

105-
## Phones ##
97+
### Phones ###
10698
Add-ZoomPhoneUserCallingPlans
10799
Add-ZoomPhoneUserNumber
108100
Get-ZoomPhoneCallingPlans
@@ -116,11 +108,11 @@ Remove-ZoomPhoneUserCallingPlans
116108
Remove-ZoomPhoneUserNumber
117109
Update-ZoomPhoneUserCallingPlans
118110

119-
## Phone Sites ##
111+
### Phone Sites ###
120112
Get-ZoomPhoneSite
121113
Get-ZoomPhoneSites
122114

123-
## Reports ##
115+
### Reports ###
124116
Get-ZoomActiveInactiveHostReports
125117
Get-ZoomDailyUsageReport
126118
Get-ZoomMeetingParticipantsReport
@@ -129,7 +121,7 @@ Get-ZoomTelephoneReports
129121
Get-ZoomWebinarDetailsReport
130122
Get-ZoomWebinarParticipantsReport
131123

132-
## Rooms ##
124+
### Rooms ###
133125
Get-ZoomRooms
134126
Get-ZoomRoomsDashboard
135127
Get-ZoomRoomDevices
@@ -142,7 +134,7 @@ Restart-ZoomRoom
142134
Remove-ZoomRoomMeeting
143135
Stop-ZoomRoomMeeting
144136

145-
## Users ##
137+
### Users ###
146138
Add-ZoomUserAssistants
147139
Get-ZoomUser
148140
Get-ZoomUserEmailStatus
@@ -165,17 +157,17 @@ Update-ZoomUserpassword
165157
Update-ZoomUserSettings
166158
Update-ZoomUserStatus
167159

168-
## Webinars ##
160+
### Webinars ###
169161
Get-ZoomWebinar
170162
Get-ZoomWebinarsFromUser
171163
Get-ZoomWebinarPanelists
172164

173-
## Utility ##
165+
### Utility ###
174166
Invoke-ZoomRetMethod
175167
Join-ZoomPages
176168
New-ZoomApiToken
177169

178-
# Contributing
170+
## Contributing ##
179171

180172
1. Fork the Project
181173
2. Create your Feature Branch (`git checkout -b feature/FeatureName`)

0 commit comments

Comments
 (0)