Skip to content

Commit

Permalink
Get-zoomuser & get-zoomusers combined (#116)
Browse files Browse the repository at this point in the history 
* Added additional logic for changes zoom made

* Combined cmdlets into one while preserving legacy functionality.

* Updated readme with combined cmdlet

---------

Co-authored-by: Andrew Hoggins <[email protected]>
  • Loading branch information
@andrew-hoggins
andrew-hoggins and Andrew Hoggins authored May 6, 2024
1 parent 22e3cb7 commit baa9ea4
Show file tree
Hide file tree
Showing 4 changed files with 205 additions and 204 deletions.
6 changes: 4 additions & 2 deletions PSZoom/Private/Get-ZoomPaginatedData.ps1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,10 @@ function Get-ZoomPaginatedData {

$response = Invoke-ZoomRestMethod -Uri $request.Uri -Method GET -ErrorAction Stop

if ($response.total_records -ne 0) {
$TargetProperty = $response.PSobject.Properties.name | Where-Object {($_ -ne "next_page_token") -and ($_ -ne "page_size") -and ($_ -ne "total_records")}
if ($response.PSobject.Properties.name -notcontains "total_records"){
$AggregatedResponse = $response
}elseif ($response.total_records -ne 0) {
$TargetProperty = $response.PSobject.Properties.name | Where-Object {($_ -ne "next_page_token") -and ($_ -ne "page_size") -and ($_ -ne "total_records") -and ($_ -ne "page_count") -and ($_ -ne "page_number")}
$AggregatedResponse += $response | Select-Object -ExpandProperty $TargetProperty
}

Expand Down
227 changes: 201 additions & 26 deletions PSZoom/Public/Users/Get-ZoomUser.ps1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ List specific user(s) on a Zoom account.
List specific user(s) on a Zoom account.
.PARAMETER UserId
The user ID or email address.
The Unique Identifier or email address.
.PARAMETER LoginType
The user's login method:
Expand All @@ -26,65 +26,240 @@ The following login methods are only available in China:
21 — WeChat
23 — Alipay
You can use the number or corresponding text (e.g. 'FacebookOauth' or '0').
You can use the number or corresponding text (e.g. 'FacebookOauth' or '0')
.PARAMETER EncryptedEmail
Whether the email address passed for the $UserId value is an encrypted email address.
Add the -EncryptedEmail switch to specify this is $True.
.PARAMETER SearchByUniqueId
Whether the queried userId value is an employee unique ID.
true - The queried ID is an employee's unique ID. Add the -SearchByUniqueId
false - The queried ID is not an employee's unique ID.
.PARAMETER Status
User statuses:
Active - Users with an active status. This is the default status.
Inactive - Users with an inactive status.
Pending - Users with a pending status.
All - Returns all users
.PARAMETER RoleId
The role's unique ID. Use this parameter to filter the response by a specific role. You can use the List roles API to get a role's unique ID value.
.PARAMETER License
The user's license. Filter the response by a specific license.
Allowed: zoom_workforce_management ┃ zoom_compliance_management
.PARAMETER FullApiResponse
The switch FullApiResponse will return the default Zoom API response.
.PARAMETER PageSize
The number of records returned within a single API call (Min 30 - MAX 100).
.PARAMETER NextPageToken
The next page token is used to paginate through large result sets. A next page token will be returned whenever the set
of available results exceeds the current page size. The expiration period for this token is 15 minutes.
.PARAMETER Full
When using -Full switch, receive the full JSON Response to see the next_page_token.
.OUTPUTS
An object with the Zoom API response.
.LINK
https://developers.zoom.us/docs/api/rest/reference/user/methods/#operation/users
https://developers.zoom.us/docs/api/rest/reference/user/methods/#operation/user
.EXAMPLE
Retrieve a user's info.
Get-ZoomUser [email protected]
Return a list of all the zoom users.
Get-ZoomUsers
.EXAMPLE
Get the host of a Zoom meeting.
Get-ZoomMeeting 123456789 | Select-Object host_id | Get-ZoomUser
Return an entry for a specific user
Get-ZoomUser -UserId "284bqlwmrtg9uwsrg"
.LINK
https://marketplace.zoom.us/docs/api-reference/zoom-api/users/user
.EXAMPLE
Return a user that matches userid and logintype
Get-ZoomUser -UserId "284bqlwmrtg9uwsrg" -LoginType "Zoom Work email"
.EXAMPLE
Get a page of zoom users with accounts.
Get-ZoomUsers -PageSize 100 -NextPageToken "8w7vt487wqtb457qwt4"
#>

function Get-ZoomUser {
[CmdletBinding()]
[CmdletBinding(DefaultParameterSetName="SpecificQuery")]
[Alias("Get-ZoomUsers")]
param (
[Parameter(
ParameterSetName="SelectedRecord",
Mandatory = $True,
Position = 0,
ValueFromPipeline = $True,
ValueFromPipelineByPropertyName = $True
)]
[Alias('email', 'emailaddress', 'id', 'user_id', 'ids', 'userids', 'emails', 'emailaddresses', 'host_id')]
[Parameter(
ParameterSetName="SelectedRecordQuery",
Mandatory = $True,
Position = 0,
ValueFromPipeline = $True,
ValueFromPipelineByPropertyName = $True
)]
[Alias('id', 'User_Id')]
[string[]]$UserId,


[Parameter(
ParameterSetName="SelectedRecordQuery",
Mandatory = $True
)]
[Alias('login_type')]
[ValidateSet(0,1,24,27,97,98,99,100,101,11,21,23)]
[string]$LoginType,


[Parameter(ParameterSetName="SelectedRecordQuery")]
[Alias('encrypted_email')]
[switch]$EncryptedEmail
)
[switch]$EncryptedEmail,


[Parameter(ParameterSetName="SelectedRecordQuery")]
[Alias('search_by_unique_id')]
[switch]$SearchByUniqueId,




[Parameter(
ValueFromPipelineByPropertyName = $True,
ParameterSetName = 'SpecificQuery'
)]
[ValidateSet('active', 'inactive', 'pending', 'all')]
[string]$Status = 'all',


[Parameter(
ValueFromPipelineByPropertyName = $True,
ParameterSetName = 'SpecificQuery'
)]
[Alias('role_id')]
[int]$RoleId,


[Parameter(
ParameterSetName = 'SpecificQuery'
)]
[ValidateSet('zoom_workforce_management', 'zoom_compliance_management')]
[string]$License,




[parameter(ParameterSetName="NextRecords")]
[ValidateRange(1, 100)]
[Alias('page_size')]
[int]$PageSize = 100,

# The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
[parameter(ParameterSetName="NextRecords")]
[Alias('next_page_token')]
[string]$NextPageToken,

#[parameter(ParameterSetName="SelectedRecordQuery")]
[parameter(ParameterSetName="AllData")]
[switch]$Full = $False
)

process {
foreach ($id in $UserId) {
$request = [System.UriBuilder]"https://api.$ZoomURI/v2/users/$id"
$query = [System.Web.HttpUtility]::ParseQueryString([String]::Empty)
$baseURI = "https://api.$ZoomURI/v2/users/"

switch ($PSCmdlet.ParameterSetName) {
"NextRecords" {
$AggregatedResponse = Get-ZoomPaginatedData -URI $baseURI -PageSize $PageSize -NextPageToken $NextPageToken
}

"SelectedRecord" {
foreach ($id in $UserId) {

$AggregatedResponse = Get-ZoomPaginatedData -URI $baseURI -ObjectId $id
}
}

"AllData" {
$AggregatedResponse = Get-ZoomPaginatedData -URI $baseURI -PageSize 100
}

"SpecificQuery" {
$AggregatedResponse = @()
$QueryStatements = @{}

if (($PSBoundParameters.ContainsKey('Status')) -and ($Status -ne "all")) {
$QueryStatements.Add('status', $Status)
}

if ($PSBoundParameters.ContainsKey('RoleId')) {
$QueryStatements.Add('role_id', $RoleId)
}

if ($PSBoundParameters.ContainsKey('License')) {
$QueryStatements.Add('license', $License)
}



if ($Status -eq "all") {

$StatusOptions = 'inactive', 'pending', 'active'
foreach ($Option in $StatusOptions) {

$QueryStatements.Remove('status')
$QueryStatements.Add('status', $Option)

if ($PSBoundParameters.ContainsKey('EncryptedEmail')) {
$query.Add('EncryptedEmail', $True)
$AggregatedResponse += Get-ZoomPaginatedData -URI $baseURI -PageSize 100 -AdditionalQueryStatements $QueryStatements
}
}else {

$AggregatedResponse += Get-ZoomPaginatedData -URI $baseURI -PageSize 100 -AdditionalQueryStatements $QueryStatements
}

}
"SelectedRecordQuery" {

$QueryStatements = @{}
$AggregatedResponse = @()

if ($PSBoundParameters.ContainsKey('EncryptedEmail')) {
$QueryStatements.Add('encrypted_email', $True)
}

if ($PSBoundParameters.ContainsKey('LoginType')) {
$LoginType = ConvertTo-LoginTypeCode -Code $LoginType
$QueryStatements.Add('login_type', $LoginType)
}

if ($PSBoundParameters.ContainsKey('SearchByUniqueId')) {
$QueryStatements.Add('search_by_unique_id', $True)
}

if ($PSBoundParameters.ContainsKey('LoginType')) {
$LoginType = ConvertTo-LoginTypeCode -Code $LoginType
$query.Add('login_type', $LoginType)
foreach ($id in $UserId) {

$baseURIplusUserID = "{0}{1}/" -f $baseURI,$id
$AggregatedResponse += Get-ZoomPaginatedData -URI $baseURIplusUserID -PageSize 100 -AdditionalQueryStatements $QueryStatements
}
}

$Request.Query = $query.ToString()
$response = Invoke-ZoomRestMethod -Uri $request.Uri -Method GET
}

Write-Output $response

if ($Full) {
$AggregatedIDs = $AggregatedResponse | select-object -ExpandProperty id
$AggregatedResponse = Get-ZoomItemFullDetails -ObjectIds $AggregatedIDs -CmdletToRun $MyInvocation.MyCommand.Name
}
}
}

Write-Output $AggregatedResponse
}
}
Loading

0 comments on commit baa9ea4

Please sign in to comment.