Api/PVEAccessApi.ps1
|
# # Proxmox VE # Generated module to access all Proxmox VE Api Endpoints # Version: 0.3 # Contact: amna.wolf@gmail.com # Generated by OpenAPI Generator: https://openapi-generator.tech # <# .SYNOPSIS Directory index. .DESCRIPTION No description available. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Get-PVEAccess { [CmdletBinding()] Param ( [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccess' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration $LocalVarUri = '/access' $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Get Access Control List (ACLs). .DESCRIPTION No description available. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessAclInner[] #> function Get-PVEAccessAcl { [CmdletBinding()] Param ( [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessAcl' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/access/acl' $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessAclInner[]" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Authentication domain index. .DESCRIPTION No description available. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessDomainsInner[] #> function Get-PVEAccessDomains { [CmdletBinding()] Param ( [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessDomains' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/access/domains' $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessDomainsInner[]" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Get auth server configuration. .DESCRIPTION No description available. .PARAMETER Realm Authentication domain ID .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Get-PVEAccessDomainsByRealm { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Realm}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessDomainsByRealm' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration $LocalVarUri = '/access/domains/{realm}' if (!$Realm) { throw "Error! The required parameter `Realm` missing when calling getAccessDomainsByRealm." } $LocalVarUri = $LocalVarUri.replace('{realm}', [System.Web.HTTPUtility]::UrlEncode($Realm)) $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Group index. .DESCRIPTION No description available. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessGroupsGETInner[] #> function Get-PVEAccessGroups { [CmdletBinding()] Param ( [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessGroups' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/access/groups' $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessGroupsGETInner[]" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Get group configuration. .DESCRIPTION No description available. .PARAMETER Groupid No description available. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessGroups #> function Get-PVEAccessGroupsByGroupid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Groupid}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessGroupsByGroupid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/access/groups/{groupid}' if (!$Groupid) { throw "Error! The required parameter `Groupid` missing when calling getAccessGroupsByGroupid." } $LocalVarUri = $LocalVarUri.replace('{groupid}', [System.Web.HTTPUtility]::UrlEncode($Groupid)) $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessGroups" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Directory index. .DESCRIPTION No description available. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Get-PVEAccessOpenid { [CmdletBinding()] Param ( [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessOpenid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration $LocalVarUri = '/access/openid' $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Retrieve effective permissions of given user/token. .DESCRIPTION No description available. .PARAMETER GETAccessPermissionsRB Retrieve effective permissions of given user/token. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Get-PVEAccessPermissions { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${GETAccessPermissionsRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessPermissions' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/permissions' $LocalVarBodyParameter = $GETAccessPermissionsRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Role index. .DESCRIPTION No description available. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessRolesGETInner[] #> function Get-PVEAccessRoles { [CmdletBinding()] Param ( [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessRoles' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/access/roles' $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessRolesGETInner[]" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Get role configuration. .DESCRIPTION No description available. .PARAMETER Roleid No description available. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessRoles #> function Get-PVEAccessRolesByRoleid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Roleid}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessRolesByRoleid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/access/roles/{roleid}' if (!$Roleid) { throw "Error! The required parameter `Roleid` missing when calling getAccessRolesByRoleid." } $LocalVarUri = $LocalVarUri.replace('{roleid}', [System.Web.HTTPUtility]::UrlEncode($Roleid)) $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessRoles" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS List TFA configurations of users. .DESCRIPTION No description available. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessTfaGET #> function Get-PVEAccessTfa { [CmdletBinding()] Param ( [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessTfa' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/access/tfa' $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessTfaGET" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS List TFA configurations of users. .DESCRIPTION No description available. .PARAMETER Userid Full User ID, in the `name@realm` format. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessTfaGETAVInner[] #> function Get-PVEAccessTfaByUserid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Userid}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessTfaByUserid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/access/tfa/{userid}' if (!$Userid) { throw "Error! The required parameter `Userid` missing when calling getAccessTfaByUserid." } $LocalVarUri = $LocalVarUri.replace('{userid}', [System.Web.HTTPUtility]::UrlEncode($Userid)) $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessTfaGETAVInner[]" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Fetch a requested TFA entry if present. .DESCRIPTION No description available. .PARAMETER Id A TFA entry id. .PARAMETER Userid Full User ID, in the `name@realm` format. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessTfaGET #> function Get-PVEAccessTfaByUseridAndId { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Id}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Userid}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessTfaByUseridAndId' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/access/tfa/{userid}/{id}' if (!$Id) { throw "Error! The required parameter `Id` missing when calling getAccessTfaByUseridAndId." } $LocalVarUri = $LocalVarUri.replace('{id}', [System.Web.HTTPUtility]::UrlEncode($Id)) if (!$Userid) { throw "Error! The required parameter `Userid` missing when calling getAccessTfaByUseridAndId." } $LocalVarUri = $LocalVarUri.replace('{userid}', [System.Web.HTTPUtility]::UrlEncode($Userid)) $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessTfaGET" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Dummy. Useful for formatters which want to provide a login page. .DESCRIPTION No description available. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Get-PVEAccessTicket { [CmdletBinding()] Param ( [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessTicket' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration $LocalVarUri = '/access/ticket' $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS User index. .DESCRIPTION No description available. .PARAMETER GETAccessUsersRB User index. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessUsersGETInner[] #> function Get-PVEAccessUsers { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${GETAccessUsersRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessUsers' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/users' $LocalVarBodyParameter = $GETAccessUsersRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessUsersGETInner[]" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Get user configuration. .DESCRIPTION No description available. .PARAMETER Userid Full User ID, in the `name@realm` format. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessUsers #> function Get-PVEAccessUsersByUserid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Userid}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessUsersByUserid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/access/users/{userid}' if (!$Userid) { throw "Error! The required parameter `Userid` missing when calling getAccessUsersByUserid." } $LocalVarUri = $LocalVarUri.replace('{userid}', [System.Web.HTTPUtility]::UrlEncode($Userid)) $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessUsers" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Get user TFA types (Personal and Realm). .DESCRIPTION No description available. .PARAMETER Userid Full User ID, in the `name@realm` format. .PARAMETER GETAccessUsersTfaRB Get user TFA types (Personal and Realm). .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessUsersTfa #> function Get-PVEAccessUsersTfaByUserid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Userid}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${GETAccessUsersTfaRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessUsersTfaByUserid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/users/{userid}/tfa' if (!$Userid) { throw "Error! The required parameter `Userid` missing when calling getAccessUsersTfaByUserid." } $LocalVarUri = $LocalVarUri.replace('{userid}', [System.Web.HTTPUtility]::UrlEncode($Userid)) $LocalVarBodyParameter = $GETAccessUsersTfaRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessUsersTfa" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Get user API tokens. .DESCRIPTION No description available. .PARAMETER Userid Full User ID, in the `name@realm` format. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessUsersTokenGETInner[] #> function Get-PVEAccessUsersTokenByUserid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Userid}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessUsersTokenByUserid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/access/users/{userid}/token' if (!$Userid) { throw "Error! The required parameter `Userid` missing when calling getAccessUsersTokenByUserid." } $LocalVarUri = $LocalVarUri.replace('{userid}', [System.Web.HTTPUtility]::UrlEncode($Userid)) $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessUsersTokenGETInner[]" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Get specific API token information. .DESCRIPTION No description available. .PARAMETER Tokenid User-specific token identifier. .PARAMETER Userid Full User ID, in the `name@realm` format. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessUsersToken #> function Get-PVEAccessUsersTokenByUseridAndTokenid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Tokenid}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Userid}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-PVEAccessUsersTokenByUseridAndTokenid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/access/users/{userid}/token/{tokenid}' if (!$Tokenid) { throw "Error! The required parameter `Tokenid` missing when calling getAccessUsersTokenByUseridAndTokenid." } $LocalVarUri = $LocalVarUri.replace('{tokenid}', [System.Web.HTTPUtility]::UrlEncode($Tokenid)) if (!$Userid) { throw "Error! The required parameter `Userid` missing when calling getAccessUsersTokenByUseridAndTokenid." } $LocalVarUri = $LocalVarUri.replace('{userid}', [System.Web.HTTPUtility]::UrlEncode($Userid)) $LocalVarResult = Invoke-PVEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessUsersToken" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Add an authentication server. .DESCRIPTION No description available. .PARAMETER POSTAccessDomainsRB Add an authentication server. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function New-PVEAccessDomains { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${POSTAccessDomainsRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: New-PVEAccessDomains' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/domains' $LocalVarBodyParameter = $POSTAccessDomainsRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Syncs users and/or groups from the configured LDAP to user.cfg. NOTE: Synced groups will have the name 'name-$realm', so make sure those groups do not exist to prevent overwriting. .DESCRIPTION No description available. .PARAMETER Realm Authentication domain ID .PARAMETER POSTAccessDomainsSyncRB Syncs users and/or groups from the configured LDAP to user.cfg. NOTE: Synced groups will have the name 'name-$realm', so make sure those groups do not exist to prevent overwriting. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function New-PVEAccessDomainsSyncByRealm { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Realm}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${POSTAccessDomainsSyncRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: New-PVEAccessDomainsSyncByRealm' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/domains/{realm}/sync' if (!$Realm) { throw "Error! The required parameter `Realm` missing when calling newAccessDomainsSyncByRealm." } $LocalVarUri = $LocalVarUri.replace('{realm}', [System.Web.HTTPUtility]::UrlEncode($Realm)) $LocalVarBodyParameter = $POSTAccessDomainsSyncRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Create new group. .DESCRIPTION No description available. .PARAMETER POSTAccessGroupsRB Create new group. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function New-PVEAccessGroups { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${POSTAccessGroupsRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: New-PVEAccessGroups' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/groups' $LocalVarBodyParameter = $POSTAccessGroupsRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Get the OpenId Authorization Url for the specified realm. .DESCRIPTION No description available. .PARAMETER POSTAccessOpenidAuthurlRB Get the OpenId Authorization Url for the specified realm. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function New-PVEAccessOpenidAuthurl { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${POSTAccessOpenidAuthurlRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: New-PVEAccessOpenidAuthurl' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/openid/auth-url' $LocalVarBodyParameter = $POSTAccessOpenidAuthurlRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Verify OpenID authorization code and create a ticket. .DESCRIPTION No description available. .PARAMETER POSTAccessOpenidLoginRB Verify OpenID authorization code and create a ticket. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function New-PVEAccessOpenidLogin { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${POSTAccessOpenidLoginRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: New-PVEAccessOpenidLogin' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/openid/login' $LocalVarBodyParameter = $POSTAccessOpenidLoginRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Create new role. .DESCRIPTION No description available. .PARAMETER POSTAccessRolesRB Create new role. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function New-PVEAccessRoles { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${POSTAccessRolesRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: New-PVEAccessRoles' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/roles' $LocalVarBodyParameter = $POSTAccessRolesRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Add a TFA entry for a user. .DESCRIPTION No description available. .PARAMETER Userid Full User ID, in the `name@realm` format. .PARAMETER POSTAccessTfaRB Add a TFA entry for a user. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessTfa #> function New-PVEAccessTfaByUserid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Userid}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${POSTAccessTfaRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: New-PVEAccessTfaByUserid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/tfa/{userid}' if (!$Userid) { throw "Error! The required parameter `Userid` missing when calling newAccessTfaByUserid." } $LocalVarUri = $LocalVarUri.replace('{userid}', [System.Web.HTTPUtility]::UrlEncode($Userid)) $LocalVarBodyParameter = $POSTAccessTfaRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessTfa" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Create or verify authentication ticket. .DESCRIPTION No description available. .PARAMETER POSTAccessTicketRB Create or verify authentication ticket. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessTicket #> function New-PVEAccessTicket { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${POSTAccessTicketRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: New-PVEAccessTicket' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/ticket' $LocalVarBodyParameter = $POSTAccessTicketRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessTicket" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Create new user. .DESCRIPTION No description available. .PARAMETER POSTAccessUsersRB Create new user. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function New-PVEAccessUsers { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${POSTAccessUsersRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: New-PVEAccessUsers' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/users' $LocalVarBodyParameter = $POSTAccessUsersRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Generate a new API token for a specific user. NOTE: returns API token value, which needs to be stored as it cannot be retrieved afterwards! .DESCRIPTION No description available. .PARAMETER Tokenid User-specific token identifier. .PARAMETER Userid Full User ID, in the `name@realm` format. .PARAMETER POSTAccessUsersTokenRB Generate a new API token for a specific user. NOTE: returns API token value, which needs to be stored as it cannot be retrieved afterwards! .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessUsersTokenPOST #> function New-PVEAccessUsersTokenByUseridAndTokenid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Tokenid}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Userid}, [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${POSTAccessUsersTokenRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: New-PVEAccessUsersTokenByUseridAndTokenid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/users/{userid}/token/{tokenid}' if (!$Tokenid) { throw "Error! The required parameter `Tokenid` missing when calling newAccessUsersTokenByUseridAndTokenid." } $LocalVarUri = $LocalVarUri.replace('{tokenid}', [System.Web.HTTPUtility]::UrlEncode($Tokenid)) if (!$Userid) { throw "Error! The required parameter `Userid` missing when calling newAccessUsersTokenByUseridAndTokenid." } $LocalVarUri = $LocalVarUri.replace('{userid}', [System.Web.HTTPUtility]::UrlEncode($Userid)) $LocalVarBodyParameter = $POSTAccessUsersTokenRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessUsersTokenPOST" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Delete an authentication server. .DESCRIPTION No description available. .PARAMETER Realm Authentication domain ID .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Remove-PVEAccessDomainsByRealm { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Realm}, [Switch] $WithHttpInfo ) Process { 'Calling method: Remove-PVEAccessDomainsByRealm' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration $LocalVarUri = '/access/domains/{realm}' if (!$Realm) { throw "Error! The required parameter `Realm` missing when calling removeAccessDomainsByRealm." } $LocalVarUri = $LocalVarUri.replace('{realm}', [System.Web.HTTPUtility]::UrlEncode($Realm)) $LocalVarResult = Invoke-PVEApiClient -Method 'DELETE' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Delete group. .DESCRIPTION No description available. .PARAMETER Groupid No description available. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Remove-PVEAccessGroupsByGroupid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Groupid}, [Switch] $WithHttpInfo ) Process { 'Calling method: Remove-PVEAccessGroupsByGroupid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration $LocalVarUri = '/access/groups/{groupid}' if (!$Groupid) { throw "Error! The required parameter `Groupid` missing when calling removeAccessGroupsByGroupid." } $LocalVarUri = $LocalVarUri.replace('{groupid}', [System.Web.HTTPUtility]::UrlEncode($Groupid)) $LocalVarResult = Invoke-PVEApiClient -Method 'DELETE' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Delete role. .DESCRIPTION No description available. .PARAMETER Roleid No description available. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Remove-PVEAccessRolesByRoleid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Roleid}, [Switch] $WithHttpInfo ) Process { 'Calling method: Remove-PVEAccessRolesByRoleid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration $LocalVarUri = '/access/roles/{roleid}' if (!$Roleid) { throw "Error! The required parameter `Roleid` missing when calling removeAccessRolesByRoleid." } $LocalVarUri = $LocalVarUri.replace('{roleid}', [System.Web.HTTPUtility]::UrlEncode($Roleid)) $LocalVarResult = Invoke-PVEApiClient -Method 'DELETE' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Delete a TFA entry by ID. .DESCRIPTION No description available. .PARAMETER Id A TFA entry id. .PARAMETER Userid Full User ID, in the `name@realm` format. .PARAMETER DELETEAccessTfaRB Delete a TFA entry by ID. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Remove-PVEAccessTfaByUseridAndId { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Id}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Userid}, [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${DELETEAccessTfaRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: Remove-PVEAccessTfaByUseridAndId' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/tfa/{userid}/{id}' if (!$Id) { throw "Error! The required parameter `Id` missing when calling removeAccessTfaByUseridAndId." } $LocalVarUri = $LocalVarUri.replace('{id}', [System.Web.HTTPUtility]::UrlEncode($Id)) if (!$Userid) { throw "Error! The required parameter `Userid` missing when calling removeAccessTfaByUseridAndId." } $LocalVarUri = $LocalVarUri.replace('{userid}', [System.Web.HTTPUtility]::UrlEncode($Userid)) $LocalVarBodyParameter = $DELETEAccessTfaRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'DELETE' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Delete user. .DESCRIPTION No description available. .PARAMETER Userid Full User ID, in the `name@realm` format. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Remove-PVEAccessUsersByUserid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Userid}, [Switch] $WithHttpInfo ) Process { 'Calling method: Remove-PVEAccessUsersByUserid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration $LocalVarUri = '/access/users/{userid}' if (!$Userid) { throw "Error! The required parameter `Userid` missing when calling removeAccessUsersByUserid." } $LocalVarUri = $LocalVarUri.replace('{userid}', [System.Web.HTTPUtility]::UrlEncode($Userid)) $LocalVarResult = Invoke-PVEApiClient -Method 'DELETE' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Remove API token for a specific user. .DESCRIPTION No description available. .PARAMETER Tokenid User-specific token identifier. .PARAMETER Userid Full User ID, in the `name@realm` format. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Remove-PVEAccessUsersTokenByUseridAndTokenid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Tokenid}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Userid}, [Switch] $WithHttpInfo ) Process { 'Calling method: Remove-PVEAccessUsersTokenByUseridAndTokenid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration $LocalVarUri = '/access/users/{userid}/token/{tokenid}' if (!$Tokenid) { throw "Error! The required parameter `Tokenid` missing when calling removeAccessUsersTokenByUseridAndTokenid." } $LocalVarUri = $LocalVarUri.replace('{tokenid}', [System.Web.HTTPUtility]::UrlEncode($Tokenid)) if (!$Userid) { throw "Error! The required parameter `Userid` missing when calling removeAccessUsersTokenByUseridAndTokenid." } $LocalVarUri = $LocalVarUri.replace('{userid}', [System.Web.HTTPUtility]::UrlEncode($Userid)) $LocalVarResult = Invoke-PVEApiClient -Method 'DELETE' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Update Access Control List (add or remove permissions). .DESCRIPTION No description available. .PARAMETER PUTAccessAclRB Update Access Control List (add or remove permissions). .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Set-PVEAccessAcl { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${PUTAccessAclRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: Set-PVEAccessAcl' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/acl' $LocalVarBodyParameter = $PUTAccessAclRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'PUT' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Update authentication server settings. .DESCRIPTION No description available. .PARAMETER Realm Authentication domain ID .PARAMETER PUTAccessDomainsRB Update authentication server settings. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Set-PVEAccessDomainsByRealm { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Realm}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${PUTAccessDomainsRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: Set-PVEAccessDomainsByRealm' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/domains/{realm}' if (!$Realm) { throw "Error! The required parameter `Realm` missing when calling setAccessDomainsByRealm." } $LocalVarUri = $LocalVarUri.replace('{realm}', [System.Web.HTTPUtility]::UrlEncode($Realm)) $LocalVarBodyParameter = $PUTAccessDomainsRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'PUT' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Update group data. .DESCRIPTION No description available. .PARAMETER Groupid No description available. .PARAMETER PUTAccessGroupsRB Update group data. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Set-PVEAccessGroupsByGroupid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Groupid}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${PUTAccessGroupsRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: Set-PVEAccessGroupsByGroupid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/groups/{groupid}' if (!$Groupid) { throw "Error! The required parameter `Groupid` missing when calling setAccessGroupsByGroupid." } $LocalVarUri = $LocalVarUri.replace('{groupid}', [System.Web.HTTPUtility]::UrlEncode($Groupid)) $LocalVarBodyParameter = $PUTAccessGroupsRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'PUT' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Change user password. .DESCRIPTION No description available. .PARAMETER PUTAccessPasswordRB Change user password. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Set-PVEAccessPassword { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${PUTAccessPasswordRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: Set-PVEAccessPassword' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/password' $LocalVarBodyParameter = $PUTAccessPasswordRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'PUT' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Update an existing role. .DESCRIPTION No description available. .PARAMETER Roleid No description available. .PARAMETER PUTAccessRolesRB Update an existing role. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Set-PVEAccessRolesByRoleid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Roleid}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${PUTAccessRolesRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: Set-PVEAccessRolesByRoleid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/roles/{roleid}' if (!$Roleid) { throw "Error! The required parameter `Roleid` missing when calling setAccessRolesByRoleid." } $LocalVarUri = $LocalVarUri.replace('{roleid}', [System.Web.HTTPUtility]::UrlEncode($Roleid)) $LocalVarBodyParameter = $PUTAccessRolesRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'PUT' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Add a TFA entry for a user. .DESCRIPTION No description available. .PARAMETER Id A TFA entry id. .PARAMETER Userid Full User ID, in the `name@realm` format. .PARAMETER PUTAccessTfaRB Add a TFA entry for a user. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Set-PVEAccessTfaByUseridAndId { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Id}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Userid}, [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${PUTAccessTfaRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: Set-PVEAccessTfaByUseridAndId' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/tfa/{userid}/{id}' if (!$Id) { throw "Error! The required parameter `Id` missing when calling setAccessTfaByUseridAndId." } $LocalVarUri = $LocalVarUri.replace('{id}', [System.Web.HTTPUtility]::UrlEncode($Id)) if (!$Userid) { throw "Error! The required parameter `Userid` missing when calling setAccessTfaByUseridAndId." } $LocalVarUri = $LocalVarUri.replace('{userid}', [System.Web.HTTPUtility]::UrlEncode($Userid)) $LocalVarBodyParameter = $PUTAccessTfaRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'PUT' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Update user configuration. .DESCRIPTION No description available. .PARAMETER Userid Full User ID, in the `name@realm` format. .PARAMETER PUTAccessUsersRB Update user configuration. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Set-PVEAccessUsersByUserid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Userid}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${PUTAccessUsersRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: Set-PVEAccessUsersByUserid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/users/{userid}' if (!$Userid) { throw "Error! The required parameter `Userid` missing when calling setAccessUsersByUserid." } $LocalVarUri = $LocalVarUri.replace('{userid}', [System.Web.HTTPUtility]::UrlEncode($Userid)) $LocalVarBodyParameter = $PUTAccessUsersRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'PUT' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Update API token for a specific user. .DESCRIPTION No description available. .PARAMETER Tokenid User-specific token identifier. .PARAMETER Userid Full User ID, in the `name@realm` format. .PARAMETER PUTAccessUsersTokenRB Update API token for a specific user. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AccessUsersTokenPUT #> function Set-PVEAccessUsersTokenByUseridAndTokenid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Tokenid}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Userid}, [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${PUTAccessUsersTokenRB}, [Switch] $WithHttpInfo ) Process { 'Calling method: Set-PVEAccessUsersTokenByUseridAndTokenid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/access/users/{userid}/token/{tokenid}' if (!$Tokenid) { throw "Error! The required parameter `Tokenid` missing when calling setAccessUsersTokenByUseridAndTokenid." } $LocalVarUri = $LocalVarUri.replace('{tokenid}', [System.Web.HTTPUtility]::UrlEncode($Tokenid)) if (!$Userid) { throw "Error! The required parameter `Userid` missing when calling setAccessUsersTokenByUseridAndTokenid." } $LocalVarUri = $LocalVarUri.replace('{userid}', [System.Web.HTTPUtility]::UrlEncode($Userid)) $LocalVarBodyParameter = $PUTAccessUsersTokenRB | ConvertTo-Json -Depth 100 $LocalVarResult = Invoke-PVEApiClient -Method 'PUT' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AccessUsersTokenPUT" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Unlock a user's TFA authentication. .DESCRIPTION No description available. .PARAMETER Userid Full User ID, in the `name@realm` format. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS Int32 #> function Set-PVEAccessUsersUnlocktfaByUserid { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Userid}, [Switch] $WithHttpInfo ) Process { 'Calling method: Set-PVEAccessUsersUnlocktfaByUserid' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-PVEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/access/users/{userid}/unlock-tfa' if (!$Userid) { throw "Error! The required parameter `Userid` missing when calling setAccessUsersUnlocktfaByUserid." } $LocalVarUri = $LocalVarUri.replace('{userid}', [System.Web.HTTPUtility]::UrlEncode($Userid)) $LocalVarResult = Invoke-PVEApiClient -Method 'PUT' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "Int32" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } |