Public/cmdb/user/saml.ps1
|
# # Copyright 2022, Alexis La Goutte <alexis dot lagoutte at gmail dot com> # # SPDX-License-Identifier: Apache-2.0 # function Get-FGTUserSAML { <# .SYNOPSIS Get list of all "SAML users" .DESCRIPTION Get list of all "SAML users" (name, type, status... ) .EXAMPLE Get-FGTUserSAML Display all SAML users .EXAMPLE Get-FGTUserSAML -id 23 Get SAML user with id 23 .EXAMPLE Get-FGTUserSAML -name FGT -filter_type contains Get SAML user contains with *FGT* .EXAMPLE Get-FGTUserSAML -meta Display all SAML users with metadata (q_...) like usage (q_ref) .EXAMPLE Get-FGTUserSAML -skip Display all SAML users (but only relevant attributes) .EXAMPLE Get-FGTUserSAML -vdom vdomX Display all SAML users on vdomX #> [CmdletBinding(DefaultParameterSetName = "default")] Param( [Parameter (Mandatory = $false, Position = 1, ParameterSetName = "name")] [string]$name, [Parameter (Mandatory = $false, ParameterSetName = "id")] [string]$id, [Parameter (Mandatory = $false)] [Parameter (ParameterSetName = "filter")] [string]$filter_attribute, [Parameter (Mandatory = $false)] [Parameter (ParameterSetName = "name")] [Parameter (ParameterSetName = "id")] [Parameter (ParameterSetName = "filter")] [ValidateSet('equal', 'contains')] [string]$filter_type = "equal", [Parameter (Mandatory = $false)] [Parameter (ParameterSetName = "filter")] [psobject]$filter_value, [Parameter(Mandatory = $false)] [switch]$meta, [Parameter(Mandatory = $false)] [switch]$skip, [Parameter(Mandatory = $false)] [String[]]$vdom, [Parameter(Mandatory = $false)] [psobject]$connection = $DefaultFGTConnection ) Begin { } Process { $invokeParams = @{ } if ( $PsBoundParameters.ContainsKey('meta') ) { $invokeParams.add( 'meta', $meta ) } if ( $PsBoundParameters.ContainsKey('skip') ) { $invokeParams.add( 'skip', $skip ) } if ( $PsBoundParameters.ContainsKey('vdom') ) { $invokeParams.add( 'vdom', $vdom ) } #Filtering switch ( $PSCmdlet.ParameterSetName ) { "name" { $filter_value = $name $filter_attribute = "name" } "id" { $filter_value = $id $filter_attribute = "id" } default { } } #if filter value and filter_attribute, add filter (by default filter_type is equal) if ( $filter_value -and $filter_attribute ) { $invokeParams.add( 'filter_value', $filter_value ) $invokeParams.add( 'filter_attribute', $filter_attribute ) $invokeParams.add( 'filter_type', $filter_type ) } #before 6.2.x, it is not User SAML if ($connection.version -lt "6.2.0") { Throw "You can't get User SAML with FortiOS < 6.2.0" } $reponse = Invoke-FGTRestMethod -uri 'api/v2/cmdb/user/saml' -method 'GET' -connection $connection @invokeParams $reponse.results } End { } } |