public/Get-VPASIdentityAllRoles.ps1
|
<#
.Synopsis RETRIEVE ALL ROLES IN IDENTITY CREATED BY: Vadim Melamed, EMAIL: vpasmodule@gmail.com .DESCRIPTION USE THIS FUNCTION TO RETRIEVE ALL ROLES IN IDENTITY .LINK https://vpasmodule.com/commands/Get-VPASIdentityAllRoles .PARAMETER token HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc). If -token is not passed, function will use last known hashtable generated by New-VPASToken .PARAMETER InputParameters HashTable of values containing the parameters required to make the API call .EXAMPLE $AllRolesArray = Get-VPASIdentityAllRoles .EXAMPLE $InputParameters = @{} $AllRolesArray = Get-VPASIdentityAllRoles -InputParameters $InputParameters .OUTPUTS If successful: { "value": [ ... { "_TableName": "roles", "Name": "NewRoleVpas", "ID": "wdsefg456_3456_6789_dfgh_dfgh7654", "OrgPath": null, "Description": "New role for documentation purposes", "IsHidden": null, "RoleType": "PrincipalList", "OrgId": null, "ReadOnly": false, "DirectoryServiceUuid": "7982479482-3298ABCD-ABCDE-4232-37869385" }, { "_TableName": "roles", "Name": "NewVmanRole", "ID": "wd34534_erty_yuio_6545_8975hkjsl", "OrgPath": null, "Description": "New test role", "IsHidden": null, "RoleType": "PrincipalList", "OrgId": null, "ReadOnly": false, "DirectoryServiceUuid": "3298ABCD-4232-465F-ABCDE-467834698213" }, ... ] } --- $false if failed #> function Get-VPASIdentityAllRoles{ [OutputType('System.Collections.Hashtable',[bool])] [CmdletBinding(DefaultParameterSetName='Set1')] Param( [Parameter(Mandatory=$true,ParameterSetName='InputParameters',ValueFromPipelineByPropertyName=$true,HelpMessage="Hashtable of parameters required to make API call, refer to get-help -examples for valid inputs")] [hashtable]$InputParameters, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true)] [hashtable]$token ) Begin{ $tokenval,$sessionval,$PVWA,$Header,$ISPSS,$IdentityURL,$EnableTextRecorder,$AuditTimeStamp,$NoSSL,$VaultVersion,$HideWarnings,$AuthenticatedAs,$SubDomain,$EnableTroubleshooting = Get-VPASSession -token $token $CommandName = $MyInvocation.MyCommand.Name $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType COMMAND } Process{ try{ if($PSCmdlet.ParameterSetName -eq "InputParameters"){ $KeyHash = @{ set1 = @{ AcceptableKeys = @() MandatoryKeys = @() } } $CheckSet = Test-VPASHashtableKeysHelper -InputHash $InputParameters -KeyHash $KeyHash if(!$CheckSet){ $log = Write-VPASTextRecorder -inputval "FAILED TO FIND TARGET PARAMETER SET" -token $token -LogType MISC Write-Verbose "FAILED TO FIND TARGET PARAMETER SET" Write-VPASOutput -str "FAILED TO FIND TARGET PARAMETER SET...VIEW EXAMPLES BELOW:" -type E $examples = Write-VPASExampleHelper -CommandName $CommandName return $false } else{ foreach($key in $InputParameters.Keys){ Set-Variable -Name $key -Value $InputParameters.$key } } } }catch{ $log = Write-VPASTextRecorder -inputval $_ -token $token -LogType ERROR $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "FAILED RETRIEVE ALL IDENTITY ROLES" Write-VPASOutput -str $_ -type E return $false } try{ if(!$IdentityURL){ $log = Write-VPASTextRecorder -inputval "LOGIN TOKEN WAS NOT GENERATED THROUGH IDENTITY" -token $token -LogType MISC $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-VPASOutput -str "LOGIN TOKEN WAS NOT GENERATED THROUGH IDENTITY, TERMINATING API CALL" -type E return $false } Write-Verbose "CONSTRUCTING PARAMETERS" $params = @{ Script = "Select * from Role" } $log = Write-VPASTextRecorder -inputval $params -token $token -LogType PARAMS $params = $params | ConvertTo-Json if($NoSSL){ Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS" $uri = "http://$IdentityURL/Redrock/query" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$IdentityURL/Redrock/query" } $log = Write-VPASTextRecorder -inputval $uri -token $token -LogType URI $log = Write-VPASTextRecorder -inputval "POST" -token $token -LogType METHOD write-verbose "MAKING API CALL" if($sessionval){ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method POST -Body $params -ContentType "application/json" -WebSession $sessionval } else{ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method POST -Body $params -ContentType "application/json" } $result = $response $counter = 0 $output = @() foreach($row in $result.Result.Results.Row){ $output += $row $counter += 1 } $outputlog = @() foreach($rec in $output){ $recTableName = $rec._TableName $recName = $rec.Name $recID = $rec.ID $recOrgPath = $rec.OrgPath $recDescription = $rec.Decsription $recIsHidden = $rec.IsHidden $recRoleType = $rec.RoleType $recOrgId = $rec.OrgId $recReadOnly = $rec.ReadOnly $recDirectoryServiceUuid = $rec.DirectoryServiceUuid $minihash = @{ _TableName = $recTableName Name = $recName ID = $recID OrgPath = $recOrgPath Description = $recDescription IsHidden = $recIsHidden RoleType = $recRoleType OrgId = $recOrgId ReadOnly = $recReadOnly DirectoryServiceUuid = $recDirectoryServiceUuid } $outputlog += $minihash } $completeOutput = @{ value = $outputlog } | ConvertTo-Json | ConvertFrom-Json $completeOutputReturn = @{ value = $output } if($counter -gt 1){ $outputlog = $output | ConvertTo-Json | ConvertFrom-Json $log = Write-VPASTextRecorder -inputval $completeOutput -token $token -LogType RETURNARRAY return $completeOutputReturn } elseif($counter -eq 0){ $log = Write-VPASTextRecorder -inputval "NO ROLES FOUND" -token $token -LogType MISC $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "NO ROLES FOUND" Write-VPASOutput -str "NO ROLES FOUND" -type E return $false } else{ $outputlog = $output | ConvertTo-Json | ConvertFrom-Json $log = Write-VPASTextRecorder -inputval $completeOutput -token $token -LogType RETURNARRAY return $completeOutputReturn } }catch{ $log = Write-VPASTextRecorder -inputval $_ -token $token -LogType ERROR $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "UNABLE TO QUERY IDENTITY" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |