users.psm1
|
# Helpers function Resolve-SafeguardUserObject { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$true,Position=0)] [object]$User ) $ErrorActionPreference = "Stop" if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if (-not ($User -as [int])) { try { $local:Users = (Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core GET Users ` -Parameters @{ filter = "UserName ieq '$User'" } -RetryVersion 2 -RetryUrl "Users") } catch { Write-Verbose $_ Write-Verbose "Caught exception with ieq filter, trying with q parameter" $local:Users = (Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core GET Users ` -Parameters @{ q = $User } -RetryVersion 2 -RetryUrl "Users") } if (-not $local:Users) { throw "Unable to find user matching '$User'" } if ($local:Users.Count -ne 1) { throw "Found $($local:Users.Count) users matching '$User'" } $local:Users[0] } else { Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core GET "Users/$User" } } function Resolve-SafeguardUserId { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$true,Position=0)] [object]$User ) $ErrorActionPreference = "Stop" if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if (-not ($User -as [int])) { try { $local:Users = (Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core GET Users ` -Parameters @{ filter = "UserName ieq '$User'" } -RetryVersion 2 -RetryUrl "Users") } catch { Write-Verbose $_ Write-Verbose "Caught exception with ieq filter, trying with q parameter" $local:Users = (Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core GET Users ` -Parameters @{ q = $User } -RetryVersion 2 -RetryUrl "Users") } if (-not $local:Users) { throw "Unable to find user matching '$User'" } if ($local:Users.Count -ne 1) { throw "Found $($local:Users.Count) users matching '$User'" } $local:Users[0].Id } else { $User } } <# .SYNOPSIS Get identity providers configured in Safeguard via the Web API. .DESCRIPTION Get the identity providers that have been configured in Safeguard. Based on these identity providers you can add users that can log into Safeguard. All users can request access to passwords or sessions based on policy. Depending on permissions (admin roles) some users can manage different aspects of Safeguard. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER ProviderToGet An integer containing an ID or a string containing the name of the identity provider to return. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Get-SafeguardIdentityProvider -AccessToken $token -Appliance 10.5.32.54 -Insecure .EXAMPLE Get-SafeguardIdentityProvider #> function Get-SafeguardIdentityProvider { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false,Position=0)] [object]$ProviderToGet ) $ErrorActionPreference = "Stop" if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if ($PSBoundParameters.ContainsKey("ProviderToGet")) { if ($ProviderToGet -as [int]) { Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core GET "IdentityProviders/$ProviderToGet" -RetryVersion 2 -RetryUrl "IdentityProviders/$ProviderToGet" } else { try { Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core GET IdentityProviders ` -Parameters @{ filter = "Name ieq '$ProviderToGet'" } -RetryVersion 2 -RetryUrl "IdentityProviders" } catch { Write-Verbose $_ Write-Verbose "Caught exception with ieq filter, trying with q parameter" Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core GET IdentityProviders ` -Parameters @{ q = $ProviderToGet } -RetryVersion 2 -RetryUrl "IdentityProviders" } } } else { Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core GET IdentityProviders -RetryVersion 2 -RetryUrl "IdentityProviders" } } <# .SYNOPSIS Create new Starling 2FA secondary authentication provider in Safeguard via the Web API. (DEPRECATED: Use Starling Join) .DESCRIPTION Create a new identity provider in Safeguard to enable adding Starling 2FA as a secondary authentication method for users. After this is configured you can add Starling 2FA to existing users. Those users must have an email address and mobile phone number. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER ProviderName A string containing the name to give this new identity provider. .PARAMETER ApiKey A string containing the API Key obtained from Starling 2FA console. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE New-SafeguardStarling2faAuthentication "Company 2FA" $ApiKey #> function New-SafeguardStarling2faAuthentication { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$true,Position=0)] [string]$ProviderName, [Parameter(Mandatory=$true,Position=1)] [string]$ApiKey ) $ErrorActionPreference = "Stop" if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } $local:ProviderObject = (Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure ` Core POST IdentityProviders -Body @{ Name = $ProviderName; TypeReferenceName = "StarlingTwoFactor" }) Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure ` Core PUT "IdentityProviders/$($local:ProviderObject.Id)/ApiKey" -Body $ApiKey Get-SafeguardIdentityProvider -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $local:ProviderObject.Id } <# .SYNOPSIS Get users in Safeguard via the Web API. .DESCRIPTION Get the users that have been added to Safeguard. Users can log into Safeguard. All users can request access to passwords or sessions based on policy. Depending on permissions (admin roles) some users can manage different aspects of Safeguard. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER UserToGet An integer containing an ID or a string containing the name of the user to return. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Get-SafeguardUser -AccessToken $token -Appliance 10.5.32.54 -Insecure .EXAMPLE Get-SafeguardUser petrsnd .EXAMPLE Get-SafeguardUser 123 #> function Get-SafeguardUser { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false,Position=0)] [object]$UserToGet ) $ErrorActionPreference = "Stop" if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if ($PSBoundParameters.ContainsKey("UserToGet")) { $local:UserId = (Resolve-SafeguardUserId -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $UserToGet) Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core GET "Users/$local:UserId" -RetryVersion 2 -RetryUrl "Users/$local:UserId" } else { Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core GET Users -RetryVersion 2 -RetryUrl "Users" } } <# .SYNOPSIS Search for a user in Safeguard via the Web API. .DESCRIPTION Search for a user in Safeguard for any string fields containing the SearchString. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER SearchString A string to search for in the user. .PARAMETER QueryFilter A string to pass to the -filter query parameter in the Safeguard Web API. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Find-SafeguardUser -AccessToken $token -Appliance 10.5.32.54 -Insecure .EXAMPLE Find-SafeguardUser "Peterson" .EXAMPLE Find-SafeguardUser -QueryFilter "SecondaryAuthenticationProviderId eq null" | ft Id,PrimaryAuthenticationProviderName,UserName,EmailAddress #> function Find-SafeguardUser { [CmdletBinding(DefaultParameterSetName="Search")] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$true,Position=0,ParameterSetName="Search")] [string]$SearchString, [Parameter(Mandatory=$true,Position=0,ParameterSetName="Query")] [string]$QueryFilter ) $ErrorActionPreference = "Stop" if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if ($PSCmdlet.ParameterSetName -eq "Search") { Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core GET Users ` -Parameters @{ q = $SearchString } } else { Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core GET Users ` -Parameters @{ filter = $QueryFilter } } } <# .SYNOPSIS Create a new user in Safeguard via the Web API. .DESCRIPTION Create a new user in Safeguard. Users can log into Safeguard. All users can request access to passwords or sessions based on policy. Depending on permissions (admin roles) some users can manage different aspects of Safeguard. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER Provider An integer containing an ID or a string containing the name of the identity provider. .PARAMETER NewUserName A string containing the name to give to the new user. Names must be unique per identity provider. .PARAMETER FirstName A string containing the first name of the user. Combined with last name to form a user's DisplayName. .PARAMETER LastName A string containing the last name of the user. Combined with first name to form a user's DisplayName. .PARAMETER Description A string containing a description for the user. .PARAMETER DomainName A string containing the DNS name of the domain this user is in. .PARAMETER EmailAddress A string containing a email address for the user. .PARAMETER WorkPhone A string containing a work phone number for the user. .PARAMETER MobilePhone A string containing a mobile phone number for the user. .PARAMETER AdminRoles An array of strings containing the permissions (admin roles) to assign to the user. You may also specify 'All' to grant all permissions. Other permissions are: 'GlobalAdmin', 'DirectoryAdmin', 'Auditor', 'AssetAdmin', 'ApplianceAdmin', 'PolicyAdmin', 'UserAdmin', 'HelpdeskAdmin', 'OperationsAdmin'. 'DirectoryAdmin' has been deprecated. 'All' does not grant 'DirectoryAdmin' permission. Add 'DirectoryAdmin' permission individually for older Safeguard appliance. .PARAMETER Password SecureString containing the password. .PARAMETER NoPassword Do not promprt for a password for new local user .PARAMETER Thumbprint String containing a SHA-1 thumbprint of certificate to use for authentication. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE New-SafeguardUser -AccessToken $token -Appliance 10.5.32.54 -Insecure .EXAMPLE New-SafeguardUser local petrsnd -AdminRoles 'AssetAdmin','ApplianceAdmin' #> function New-SafeguardUser { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false,Position=0)] [object]$Provider, [Parameter(Mandatory=$true,Position=1)] [string]$NewUserName, [Parameter(Mandatory=$false)] [string]$FirstName = $null, [Parameter(Mandatory=$false)] [string]$LastName = $null, [Parameter(Mandatory=$false)] [string]$Description = $null, [Parameter(Mandatory=$false)] [string]$DomainName = $null, [Parameter(Mandatory=$false)] [string]$EmailAddress = $null, [Parameter(Mandatory=$false)] [string]$WorkPhone = $null, [Parameter(Mandatory=$false)] [string]$MobilePhone = $null, [Parameter(Mandatory=$false)] [ValidateSet('GlobalAdmin','DirectoryAdmin','Auditor','AssetAdmin','ApplianceAdmin','PolicyAdmin','UserAdmin','HelpdeskAdmin','OperationsAdmin','All',IgnoreCase=$true)] [string[]]$AdminRoles = $null, [Parameter(Mandatory=$false)] [SecureString]$Password, [Parameter(Mandatory=$false)] [switch]$NoPassword = $false, [Parameter(Mandatory=$false)] [string]$Thumbprint ) $ErrorActionPreference = "Stop" if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } $local:AllProviders = (Get-SafeguardIdentityProvider -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure) $local:LocalProviderId = ($AllProviders | Where-Object { $_.Name -eq "Local" }).Id $local:CertificateProviderId = ($AllProviders | Where-Object { $_.Name -eq "Certificate" }).Id if (-not $PSBoundParameters.ContainsKey("Provider")) { Write-Host "Identity providers:" Write-Host "[" $local:AllProviders | ForEach-Object { Write-Host (" {0,3} - {1}" -f $_.Id,$_.Name) } Write-Host "]" $Provider = (Read-Host "Select an identity provider") } if (-not ($Provider -as [int])) { $local:ProviderResolved = (Get-SafeguardIdentityProvider -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $Provider)[0].Id if (-not $local:ProviderResolved) { throw "Unable to find identity provider that matches '$Provider'" } $Provider = $local:ProviderResolved } if ($Provider -eq $local:CertificateProviderId -and -not ($PSBoundParameters.ContainsKey("Thumbprint"))) { $Thumbprint = (Read-Host "Thumbprint") } if ($AdminRoles -contains "All") { Import-Module -Name "$PSScriptRoot\sg-utilities.psm1" -Scope Local if (Test-SafeguardMinVersionInternal -Appliance $Appliance -Insecure:$Insecure -MinVersion "2.7") { $AdminRoles = @('GlobalAdmin','Auditor','AssetAdmin','ApplianceAdmin','PolicyAdmin','UserAdmin','HelpdeskAdmin','OperationsAdmin') } else { $AdminRoles = @('GlobalAdmin','DirectoryAdmin','Auditor','AssetAdmin','ApplianceAdmin','PolicyAdmin','UserAdmin','HelpdeskAdmin','OperationsAdmin') } } if ($Provider -eq $local:LocalProviderId -and $PSBoundParameters.ContainsKey("Password")) { # Check the password complexity before creating the user so you don't end up with a user without a password try { $local:PasswordPlainText = [Runtime.InteropServices.Marshal]::PtrToStringAuto([Runtime.InteropServices.Marshal]::SecureStringToBSTR($Password)) Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core POST "Users/ValidatePassword" -Body ` $local:PasswordPlainText -RetryVersion 2 -RetryUrl "Users/ValidatePassword" $local:PasswordPlainText = "" } catch { Write-Warning "Password for the new user failed to meet requirements" throw $_.Exception } } if ($Provider -eq $local:LocalProviderId -or $Provider -eq $local:CertificateProviderId) { $local:Body = @{ PrimaryAuthenticationProviderId = $Provider; UserName = $NewUserName; AdminRoles = $AdminRoles } if ($PSBoundParameters.ContainsKey("FirstName")) { $local:Body.FirstName = $FirstName } if ($PSBoundParameters.ContainsKey("LastName")) { $local:Body.LastName = $LastName } if ($PSBoundParameters.ContainsKey("Description")) { $local:Body.Description = $Description } if ($PSBoundParameters.ContainsKey("EmailAddress")) { $local:Body.EmailAddress = $EmailAddress } if ($PSBoundParameters.ContainsKey("WorkPhone")) { $local:Body.WorkPhone = $WorkPhone } if ($PSBoundParameters.ContainsKey("MobilePhone")) { $local:Body.MobilePhone = $MobilePhone } if ($Provider -eq $local:CertificateProviderId) { $local:Body.PrimaryAuthenticationIdentity = $Thumbprint } $local:NewUser = (Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core POST Users -Body $local:Body -RetryVersion 2 -RetryUrl "Users") if ($Provider -eq $local:LocalProviderId) { Write-Host "Setting password for new user..." if ($PSBoundParameters.ContainsKey("Password")) { Set-SafeguardUserPassword -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $local:NewUser.Id $Password } else { if (-not $NoPassword) { Set-SafeguardUserPassword -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $local:NewUser.Id } } } $local:NewUser } else { if (-not $PSBoundParameters.ContainsKey("DomainName")) { $DomainName = (Read-Host "DomainName") } # For directory accounts, lots of attributes are mapped from the directory Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core POST Users -Body @{ PrimaryAuthenticationProviderId = $Provider; UserName = $NewUserName; AdminRoles = $AdminRoles; DirectoryProperties = @{ DomainName = $DomainName } } -RetryVersion 2 -RetryUrl "Users" } } <# .SYNOPSIS Delete a user from Safeguard via the Web API. .DESCRIPTION Delete a user from Safeguard. The user will no longer be able tolog into Safeguard. All audit history for that user will be retained. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER UserToDelete An integer containing an ID or a string containing the name of the user to delete. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Remove-SafeguardUser -AccessToken $token -Appliance 10.5.32.54 -Insecure .EXAMPLE Remove-SafeguardUser petrsnd .EXAMPLE Remove-SafeguardUser 123 #> function Remove-SafeguardUser { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false,Position=0)] [object]$UserToDelete ) $ErrorActionPreference = "Stop" if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if (-not $PSBoundParameters.ContainsKey("UserToDelete")) { $UserToDelete = (Read-Host "UserToDelete") } $local:UserId = (Resolve-SafeguardUserId -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $UserToDelete) Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core DELETE "Users/$($local:UserId)" } <# .SYNOPSIS Set the password for a user in Safeguard via the Web API. .DESCRIPTION Set the password for a user in Safeguard. This operation only works for users from the local identity provider. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER UserToEdit An integer containing an ID or a string containing the name of the user. .PARAMETER Password SecureString containing the password. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Set-SafeguardUserPassword -AccessToken $token -Appliance 10.5.32.54 -Insecure .EXAMPLE Set-SafeguardUserPassword petrsnd .EXAMPLE Set-SafeguardUserPassword 123 $newpassword #> function Set-SafeguardUserPassword { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false,Position=0)] [object]$UserToEdit, [Parameter(Mandatory=$false,Position=1)] [SecureString]$Password ) $ErrorActionPreference = "Stop" if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if (-not $PSBoundParameters.ContainsKey("UserToEdit")) { $UserToEdit = (Read-Host "UserToEdit") } $local:UserId = (Resolve-SafeguardUserId -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $UserToEdit) if (-not $PSBoundParameters.ContainsKey("Password") -or $null -eq $Password) { $Password = (Read-Host "Password" -AsSecureString) } $local:PasswordPlainText = [Runtime.InteropServices.Marshal]::PtrToStringAuto([Runtime.InteropServices.Marshal]::SecureStringToBSTR($Password)) Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core PUT "Users/$($local:UserId)/Password" ` -Body $local:PasswordPlainText -RetryVersion 2 -RetryUrl "Users/$($local:UserId)/Password" } <# .SYNOPSIS Edit an existing user in Safeguard via the Web API. .DESCRIPTION Edit an existing user in Safeguard. Users can log into Safeguard. All users can request access to passwords or sessions based on policy. Depending on permissions (admin roles) some users can manage different aspects of Safeguard. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER UserToEdit An integer containing an ID or a string containing the name of the user. .PARAMETER FirstName A string containing the first name of the user. Combined with last name to form a user's DisplayName. .PARAMETER LastName A string containing the last name of the user. Combined with first name to form a user's DisplayName. .PARAMETER Description A string containing a description for the user. .PARAMETER EmailAddress A string containing a email address for the user. .PARAMETER WorkPhone A string containing a work phone number for the user. .PARAMETER MobilePhone A string containing a mobile phone number for the user. .PARAMETER AdminRoles An array of strings containing the permissions (admin roles) to assign to the user. You may also specify 'All' to grant all permissions. Other permissions are: 'GlobalAdmin', 'DirectoryAdmin','Auditor', 'AssetAdmin', 'ApplianceAdmin', 'PolicyAdmin', 'UserAdmin', 'HelpdeskAdmin', 'OperationsAdmin'. 'DirectoryAdmin' has been deprecated. 'All' does not grant 'DirectoryAdmin' permission. Add 'DirectoryAdmin' permission individually for older Safeguard appliance. .PARAMETER UserObject An object containing the existing user with desired properties set. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Edit-SafeguardUser -AccessToken $token -Appliance 10.5.32.54 -Insecure .EXAMPLE Edit-SafeguardUser petrsnd -AdminRoles 'AssetAdmin','ApplianceAdmin' -FirstName 'Dan' .EXAMPLE Edit-SafeguardUser -UserObject $obj #> function Edit-SafeguardUser { [CmdletBinding(DefaultParameterSetName="Attributes")] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(ParameterSetName="Attributes",Mandatory=$true,Position=0)] [object]$UserToEdit, [Parameter(ParameterSetName="Attributes",Mandatory=$false)] [string]$FirstName = $null, [Parameter(ParameterSetName="Attributes",Mandatory=$false)] [string]$LastName = $null, [Parameter(ParameterSetName="Attributes",Mandatory=$false)] [string]$Description = $null, [Parameter(ParameterSetName="Attributes",Mandatory=$false)] [string]$EmailAddress = $null, [Parameter(ParameterSetName="Attributes",Mandatory=$false)] [string]$WorkPhone = $null, [Parameter(ParameterSetName="Attributes",Mandatory=$false)] [string]$MobilePhone = $null, [Parameter(ParameterSetName="Attributes",Mandatory=$false)] [ValidateSet('GlobalAdmin','DirectoryAdmin','Auditor','AssetAdmin','ApplianceAdmin','PolicyAdmin','UserAdmin','HelpdeskAdmin','OperationsAdmin','All',IgnoreCase=$true)] [string[]]$AdminRoles = $null, [Parameter(ParameterSetName="Object",Mandatory=$false)] [object]$UserObject ) $ErrorActionPreference = "Stop" if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if ($PsCmdlet.ParameterSetName -eq "Object" -and -not $UserObject) { throw "UserObject must not be null" } if ($PsCmdlet.ParameterSetName -eq "Attributes") { if (-not $PSBoundParameters.ContainsKey("UserToEdit")) { $UserToEdit = (Read-Host "UserToEdit") } $local:UserId = (Resolve-SafeguardUserId -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $UserToEdit) } if (-not ($PsCmdlet.ParameterSetName -eq "Object")) { $UserObject = (Get-SafeguardUser -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $local:UserId) if ($PSBoundParameters.ContainsKey("FirstName")) { $UserObject.FirstName = $FirstName } if ($PSBoundParameters.ContainsKey("LastName")) { $UserObject.LastName = $LastName } if ($PSBoundParameters.ContainsKey("Description")) { $UserObject.Description = $Description } if ($PSBoundParameters.ContainsKey("EmailAddress")) { $UserObject.EmailAddress = $EmailAddress } if ($PSBoundParameters.ContainsKey("WorkPhone")) { $UserObject.WorkPhone = $WorkPhone } if ($PSBoundParameters.ContainsKey("MobilePhone")) { $UserObject.MobilePhone = $MobilePhone } if ($PSBoundParameters.ContainsKey("AdminRoles")) { if ($AdminRoles -contains "All") { $AdminRoles = @('GlobalAdmin','Auditor','AssetAdmin','ApplianceAdmin','PolicyAdmin','UserAdmin','HelpdeskAdmin','OperationsAdmin') } $UserObject.AdminRoles = $AdminRoles } } Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core PUT "Users/$($UserObject.Id)" -Body $UserObject -RetryVersion 2 -RetryUrl "Users/$($UserObject.Id)" } <# .SYNOPSIS Enable a user in Safeguard via the Web API. .DESCRIPTION Enable a user in Safeguard. This operation only works for users from the local and certificate identity providers. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER UserToEdit An integer containing an ID or a string containing the name of the user. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Enable-SafeguardUser -AccessToken $token -Appliance 10.5.32.54 -Insecure .EXAMPLE Enable-SafeguardUser petrsnd .EXAMPLE Enable-SafeguardUser 123 #> function Enable-SafeguardUser { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false,Position=0)] [object]$UserToEdit ) $ErrorActionPreference = "Stop" if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if (-not $PSBoundParameters.ContainsKey("UserToEdit")) { $UserToEdit = (Read-Host "UserToEdit") } $local:UserId = (Resolve-SafeguardUserId -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $UserToEdit) $local:UserObject = (Get-SafeguardUser -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $local:UserId) $local:UserObject.Disabled = $false Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core PUT "Users/$($UserObject.Id)" -Body $local:UserObject } <# .SYNOPSIS Disable a user in Safeguard via the Web API. .DESCRIPTION Disable a user in Safeguard. This operation only works for users from the local and certificate identity providers. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER UserToEdit An integer containing an ID or a string containing the name of the user. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Disable-SafeguardUser -AccessToken $token -Appliance 10.5.32.54 -Insecure .EXAMPLE Disable-SafeguardUser petrsnd .EXAMPLE Disable-SafeguardUser 123 #> function Disable-SafeguardUser { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false,Position=0)] [object]$UserToEdit ) $ErrorActionPreference = "Stop" if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if (-not $PSBoundParameters.ContainsKey("UserToEdit")) { $UserToEdit = (Read-Host "UserToEdit") } $local:UserId = (Resolve-SafeguardUserId -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $UserToEdit) $local:UserObject = (Get-SafeguardUser -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $local:UserId) $local:UserObject.Disabled = $true Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core PUT "Users/$($UserObject.Id)" -Body $local:UserObject } <# .SYNOPSIS Rename a user in Safeguard via the Web API. .DESCRIPTION Rename a user in Safeguard. This operation only works for users from the local and certificate identity providers. .PARAMETER Appliance IP address or hostname of a Safeguard appliance. .PARAMETER AccessToken A string containing the bearer token to be used with Safeguard Web API. .PARAMETER Insecure Ignore verification of Safeguard appliance SSL certificate. .PARAMETER UserToEdit An integer containing an ID or a string containing the name of the user. .PARAMETER NewUserName A string containing the new name for the user. .INPUTS None. .OUTPUTS JSON response from Safeguard Web API. .EXAMPLE Rename-SafeguardUser -AccessToken $token -Appliance 10.5.32.54 -Insecure .EXAMPLE Rename-SafeguardUser petrsnd dpeterso .EXAMPLE Rename-SafeguardUser 123 "bob jackson" #> function Rename-SafeguardUser { [CmdletBinding()] Param( [Parameter(Mandatory=$false)] [string]$Appliance, [Parameter(Mandatory=$false)] [object]$AccessToken, [Parameter(Mandatory=$false)] [switch]$Insecure, [Parameter(Mandatory=$false,Position=0)] [object]$UserToEdit, [Parameter(Mandatory=$false,Position=1)] [string]$NewUserName ) $ErrorActionPreference = "Stop" if (-not $PSBoundParameters.ContainsKey("Verbose")) { $VerbosePreference = $PSCmdlet.GetVariableValue("VerbosePreference") } if (-not $PSBoundParameters.ContainsKey("UserToEdit")) { $UserToEdit = (Read-Host "UserToEdit") } $local:UserId = (Resolve-SafeguardUserId -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $UserToEdit) if (-not $PSBoundParameters.ContainsKey("NewUserName") -or -not $NewUserName) { $NewUserName = (Read-Host "NewUserName") } $local:UserObject = (Get-SafeguardUser -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure $local:UserId) $local:UserObject.UserName = $NewUserName Invoke-SafeguardMethod -AccessToken $AccessToken -Appliance $Appliance -Insecure:$Insecure Core PUT "Users/$($local:UserObject.Id)" -Body $local:UserObject } |