Api/UsersApi.ps1
|
# # Cloud Governance Api # Contact: support@avepoint.com # <# .SYNOPSIS filter users by property value .DESCRIPTION No description available. .PARAMETER AttributeName azure ad attribute name .PARAMETER AttributeValue value of attribute name .PARAMETER Office365TenantId office 365 tenant id, optional, if not specified, only return the first tenant's result which is not empty .PARAMETER ReturnType Select the return type (optional): text/plain, application/json .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS ApiUser[] #> function Invoke-FilterUsersByAttribute { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${AttributeName}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${AttributeValue}, [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Office365TenantId}, [String] [ValidateSet("text/plain", "application/json")] $ReturnType, [Switch] $WithHttpInfo ) Process { 'Calling method: Invoke-FilterUsersByAttribute' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-Configuration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('text/plain', 'application/json') if ($ReturnType) { # use the return type (MIME) provided by the user $LocalVarAccepts = @($ReturnType) } $LocalVarUri = '/users/filter' if (!$AttributeName) { throw "Error! The required parameter `AttributeName` missing when calling filterUsersByAttribute." } $LocalVarQueryParameters['attributeName'] = $AttributeName if (!$AttributeValue) { throw "Error! The required parameter `AttributeValue` missing when calling filterUsersByAttribute." } $LocalVarQueryParameters['attributeValue'] = $AttributeValue if ($Office365TenantId) { $LocalVarQueryParameters['office365TenantId'] = $Office365TenantId } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["clientSecret"]) { $LocalVarHeaderParameters['clientSecret'] = $Configuration["ApiKey"]["clientSecret"] Write-Verbose ("Using API key 'clientSecret' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["userPrincipalName"]) { $LocalVarHeaderParameters['userPrincipalName'] = $Configuration["ApiKey"]["userPrincipalName"] Write-Verbose ("Using API key 'userPrincipalName' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-ApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "ApiUser[]" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS get Azure Ad user's property value .DESCRIPTION No description available. .PARAMETER Username No description available. .PARAMETER PropertyName No description available. .PARAMETER ReturnType Select the return type (optional): text/plain, application/json .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS StringModel #> function Get-AzureAdUserPropertyValue { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Username}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${PropertyName}, [String] [ValidateSet("text/plain", "application/json")] $ReturnType, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-AzureAdUserPropertyValue' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-Configuration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('text/plain', 'application/json') if ($ReturnType) { # use the return type (MIME) provided by the user $LocalVarAccepts = @($ReturnType) } $LocalVarUri = '/users/{username}/azuread/property' if (!$Username) { throw "Error! The required parameter `Username` missing when calling getAzureAdUserPropertyValue." } $LocalVarUri = $LocalVarUri.replace('{username}', $Username) if (!$PropertyName) { throw "Error! The required parameter `PropertyName` missing when calling getAzureAdUserPropertyValue." } $LocalVarQueryParameters['propertyName'] = $PropertyName if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["clientSecret"]) { $LocalVarHeaderParameters['clientSecret'] = $Configuration["ApiKey"]["clientSecret"] Write-Verbose ("Using API key 'clientSecret' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["userPrincipalName"]) { $LocalVarHeaderParameters['userPrincipalName'] = $Configuration["ApiKey"]["userPrincipalName"] Write-Verbose ("Using API key 'userPrincipalName' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-ApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "StringModel" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS get user's extension property value from azure ad .DESCRIPTION No description available. .PARAMETER Username No description available. .PARAMETER ReturnType Select the return type (optional): text/plain, application/json .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS StringModel[] #> function Get-ExtensionAzureAdUserPropertyValues { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Username}, [String] [ValidateSet("text/plain", "application/json")] $ReturnType, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-ExtensionAzureAdUserPropertyValues' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-Configuration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('text/plain', 'application/json') if ($ReturnType) { # use the return type (MIME) provided by the user $LocalVarAccepts = @($ReturnType) } $LocalVarUri = '/users/{username}/azuread/extensionproperties' if (!$Username) { throw "Error! The required parameter `Username` missing when calling getExtensionAzureAdUserPropertyValues." } $LocalVarUri = $LocalVarUri.replace('{username}', $Username) if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["clientSecret"]) { $LocalVarHeaderParameters['clientSecret'] = $Configuration["ApiKey"]["clientSecret"] Write-Verbose ("Using API key 'clientSecret' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["userPrincipalName"]) { $LocalVarHeaderParameters['userPrincipalName'] = $Configuration["ApiKey"]["userPrincipalName"] Write-Verbose ("Using API key 'userPrincipalName' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-ApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "StringModel[]" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Is Member Of Group .DESCRIPTION No description available. .PARAMETER Userprincipalname No description available. .PARAMETER Groupid No description available. .PARAMETER ReturnType Select the return type (optional): text/plain, application/json .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS Boolean #> function Invoke-IsMemberOfGroup { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Userprincipalname}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Groupid}, [String] [ValidateSet("text/plain", "application/json")] $ReturnType, [Switch] $WithHttpInfo ) Process { 'Calling method: Invoke-IsMemberOfGroup' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-Configuration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('text/plain', 'application/json') if ($ReturnType) { # use the return type (MIME) provided by the user $LocalVarAccepts = @($ReturnType) } $LocalVarUri = '/users/{userprincipalname}/ismemberof/{groupid}' if (!$Userprincipalname) { throw "Error! The required parameter `Userprincipalname` missing when calling isMemberOfGroup." } $LocalVarUri = $LocalVarUri.replace('{userprincipalname}', $Userprincipalname) if (!$Groupid) { throw "Error! The required parameter `Groupid` missing when calling isMemberOfGroup." } $LocalVarUri = $LocalVarUri.replace('{groupid}', $Groupid) if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["clientSecret"]) { $LocalVarHeaderParameters['clientSecret'] = $Configuration["ApiKey"]["clientSecret"] Write-Verbose ("Using API key 'clientSecret' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["userPrincipalName"]) { $LocalVarHeaderParameters['userPrincipalName'] = $Configuration["ApiKey"]["userPrincipalName"] Write-Verbose ("Using API key 'userPrincipalName' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-ApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "Boolean" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS resolve users .DESCRIPTION No description available. .PARAMETER Keyword No description available. .PARAMETER UserType No description available. .PARAMETER UserSource No description available. .PARAMETER SharingOptions No description available. .PARAMETER SiteUrlOrTenantId No description available. .PARAMETER GroupEmail No description available. .PARAMETER PeopleFilterProfileId No description available. .PARAMETER IsGetTenantBySiteUrl No description available. .PARAMETER ReturnType Select the return type (optional): text/plain, application/json .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS ApiUser[] #> function Resolve-ACGUsers { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Keyword}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${UserType}, [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${UserSource}, [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${SharingOptions}, [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${SiteUrlOrTenantId}, [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${GroupEmail}, [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${PeopleFilterProfileId}, [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [System.Nullable[Boolean]] ${IsGetTenantBySiteUrl}, [String] [ValidateSet("text/plain", "application/json")] $ReturnType, [Switch] $WithHttpInfo ) Process { 'Calling method: Resolve-ACGUsers' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-Configuration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('text/plain', 'application/json') if ($ReturnType) { # use the return type (MIME) provided by the user $LocalVarAccepts = @($ReturnType) } $LocalVarUri = '/users/resolve' if (!$Keyword) { throw "Error! The required parameter `Keyword` missing when calling resolveUsers." } $LocalVarQueryParameters['keyword'] = $Keyword if (!$UserType) { throw "Error! The required parameter `UserType` missing when calling resolveUsers." } $LocalVarQueryParameters['userType'] = $UserType if (!$UserSource) { throw "Error! The required parameter `UserSource` missing when calling resolveUsers." } $LocalVarQueryParameters['userSource'] = $UserSource if (!$SharingOptions) { throw "Error! The required parameter `SharingOptions` missing when calling resolveUsers." } $LocalVarQueryParameters['sharingOptions'] = $SharingOptions if ($SiteUrlOrTenantId) { $LocalVarQueryParameters['siteUrlOrTenantId'] = $SiteUrlOrTenantId } if ($GroupEmail) { $LocalVarQueryParameters['groupEmail'] = $GroupEmail } if ($PeopleFilterProfileId) { $LocalVarQueryParameters['peopleFilterProfileId'] = $PeopleFilterProfileId } if ($IsGetTenantBySiteUrl) { $LocalVarQueryParameters['isGetTenantBySiteUrl'] = $IsGetTenantBySiteUrl } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["clientSecret"]) { $LocalVarHeaderParameters['clientSecret'] = $Configuration["ApiKey"]["clientSecret"] Write-Verbose ("Using API key 'clientSecret' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["userPrincipalName"]) { $LocalVarHeaderParameters['userPrincipalName'] = $Configuration["ApiKey"]["userPrincipalName"] Write-Verbose ("Using API key 'userPrincipalName' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-ApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "ApiUser[]" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS search users .DESCRIPTION No description available. .PARAMETER Keyword No description available. .PARAMETER UserType No description available. .PARAMETER UserSource No description available. .PARAMETER SharingOptions No description available. .PARAMETER SiteUrlOrTenantId No description available. .PARAMETER GroupEmail No description available. .PARAMETER PeopleFilterProfileId No description available. .PARAMETER IsGetTenantBySiteUrl No description available. .PARAMETER ReturnType Select the return type (optional): text/plain, application/json .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS ApiUser[] #> function Search-ACGUsers { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Keyword}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${UserType}, [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${UserSource}, [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${SharingOptions}, [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${SiteUrlOrTenantId}, [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${GroupEmail}, [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${PeopleFilterProfileId}, [Parameter(Position = 7, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [System.Nullable[Boolean]] ${IsGetTenantBySiteUrl}, [String] [ValidateSet("text/plain", "application/json")] $ReturnType, [Switch] $WithHttpInfo ) Process { 'Calling method: Search-ACGUsers' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-Configuration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('text/plain', 'application/json') if ($ReturnType) { # use the return type (MIME) provided by the user $LocalVarAccepts = @($ReturnType) } $LocalVarUri = '/users/search' if (!$Keyword) { throw "Error! The required parameter `Keyword` missing when calling searchUsers." } $LocalVarQueryParameters['keyword'] = $Keyword if (!$UserType) { throw "Error! The required parameter `UserType` missing when calling searchUsers." } $LocalVarQueryParameters['userType'] = $UserType if (!$UserSource) { throw "Error! The required parameter `UserSource` missing when calling searchUsers." } $LocalVarQueryParameters['userSource'] = $UserSource if (!$SharingOptions) { throw "Error! The required parameter `SharingOptions` missing when calling searchUsers." } $LocalVarQueryParameters['sharingOptions'] = $SharingOptions if ($SiteUrlOrTenantId) { $LocalVarQueryParameters['siteUrlOrTenantId'] = $SiteUrlOrTenantId } if ($GroupEmail) { $LocalVarQueryParameters['groupEmail'] = $GroupEmail } if ($PeopleFilterProfileId) { $LocalVarQueryParameters['peopleFilterProfileId'] = $PeopleFilterProfileId } if ($IsGetTenantBySiteUrl) { $LocalVarQueryParameters['isGetTenantBySiteUrl'] = $IsGetTenantBySiteUrl } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["clientSecret"]) { $LocalVarHeaderParameters['clientSecret'] = $Configuration["ApiKey"]["clientSecret"] Write-Verbose ("Using API key 'clientSecret' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["userPrincipalName"]) { $LocalVarHeaderParameters['userPrincipalName'] = $Configuration["ApiKey"]["userPrincipalName"] Write-Verbose ("Using API key 'userPrincipalName' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-ApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "ApiUser[]" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } |