Api/LELdapGroupApi.ps1
|
# # Login Enterprise # v8.0-preview [API Console (Swagger)](/publicApi/swagger/index.html?urls.primaryName=Login%20Enterprise%20API%20v8-preview), [Documentation (ReDoc)](/publicApi/v8-preview/docs/index.html) v7.0 [API Console (Swagger)](/publicApi/swagger/index.html?urls.primaryName=Login%20Enterprise%20API%20v7), [Documentation (ReDoc)](/publicApi/v7/docs/index.html) v6.0 [API Console (Swagger)](/publicApi/swagger/index.html?urls.primaryName=Login%20Enterprise%20API%20v6), [Documentation (ReDoc)](/publicApi/v6/docs/index.html) <br><b>API v8 (preview) – Introduced in Login Enterprise v6.0 and subject to breaking changes.</b></br> <br><b>API v7 – is the recommended version to use. It is the actively developed version starting with Login Enterprise v6.0.</b></br> <br><b>API v6 – is currently supported, but unmaintained as of v6.0.</b></br> <br><b>API v5 and v4 - These versions are removed in v6.0.</b></br> The Login Enterprise Public API provides documentation and Swagger per version within the product. For additional information please refer to the [documentation](https://support.loginvsi.com/hc/en-us/articles/360009534760) on our website. # Version: 7.0 # Generated by OpenAPI Generator: https://openapi-generator.tech # <# .SYNOPSIS Create a ldap group .DESCRIPTION No description available. .PARAMETER LdapGroupCreate Ldap 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 ObjectId #> function New-LELdapGroup { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${LdapGroupCreate}, [Switch] $WithHttpInfo ) Process { 'Calling method: New-LELdapGroup' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-LEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/v7/auth/ldap-groups' $LocalVarBodyParameter = $LdapGroupCreate | ConvertTo-Json -Depth 100 if ($Configuration["ApiKeyPrefix"] -and $Configuration["ApiKeyPrefix"]["Authorization"]) { $apiKeyPrefix = $Configuration["ApiKeyPrefix"]["Authorization"] } else { $apiKeyPrefix = "" } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["Authorization"]) { $LocalVarHeaderParameters['Authorization'] = $apiKeyPrefix + $Configuration["ApiKey"]["Authorization"] Write-Verbose ("Using API key 'Authorization' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-LEApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "ObjectId" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Delete a ldap group .DESCRIPTION No description available. .PARAMETER LdapGroupId Ldap group 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 Invoke-LEDeleteLdapGroup { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${LdapGroupId}, [Switch] $WithHttpInfo ) Process { 'Calling method: Invoke-LEDeleteLdapGroup' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-LEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/v7/auth/ldap-groups/{ldapGroupId}' if (!$LdapGroupId) { throw "Error! The required parameter `LdapGroupId` missing when calling deleteLdapGroup." } $LocalVarUri = $LocalVarUri.replace('{ldapGroupId}', [System.Web.HTTPUtility]::UrlEncode($LdapGroupId)) if ($Configuration["ApiKeyPrefix"] -and $Configuration["ApiKeyPrefix"]["Authorization"]) { $apiKeyPrefix = $Configuration["ApiKeyPrefix"]["Authorization"] } else { $apiKeyPrefix = "" } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["Authorization"]) { $LocalVarHeaderParameters['Authorization'] = $apiKeyPrefix + $Configuration["ApiKey"]["Authorization"] Write-Verbose ("Using API key 'Authorization' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-LEApiClient -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 Get paginated list of all ldap groups .DESCRIPTION No description available. .PARAMETER Filter Filter on Name or Dn .PARAMETER Count .PARAMETER Offset .PARAMETER SortKey .PARAMETER Direction .PARAMETER IncludeTotalCount .PARAMETER Include Include options .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS LdapGroupResultSet #> function Get-LEAllLdapGroups { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Filter}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [System.Nullable[Int32]] ${Count}, [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [System.Nullable[Int32]] ${Offset}, [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${SortKey}, [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${Direction}, [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [System.Nullable[Boolean]] ${IncludeTotalCount}, [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject[]] ${Include}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-LEAllLdapGroups' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-LEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/v7/auth/ldap-groups' if ($Filter) { $LocalVarQueryParameters['filter'] = $Filter } if ($Count) { $LocalVarQueryParameters['count'] = $Count } if ($Offset) { $LocalVarQueryParameters['offset'] = $Offset } if ($SortKey) { $LocalVarQueryParameters['sortKey'] = $SortKey } if ($Direction) { $LocalVarQueryParameters['direction'] = $Direction } if ($IncludeTotalCount) { $LocalVarQueryParameters['includeTotalCount'] = $IncludeTotalCount } if ($Include) { $LocalVarQueryParameters['include'] = $Include } if ($Configuration["ApiKeyPrefix"] -and $Configuration["ApiKeyPrefix"]["Authorization"]) { $apiKeyPrefix = $Configuration["ApiKeyPrefix"]["Authorization"] } else { $apiKeyPrefix = "" } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["Authorization"]) { $LocalVarHeaderParameters['Authorization'] = $apiKeyPrefix + $Configuration["ApiKey"]["Authorization"] Write-Verbose ("Using API key 'Authorization' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-LEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "LdapGroupResultSet" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Get ldap group by id .DESCRIPTION No description available. .PARAMETER LdapGroupId .PARAMETER Include Include options .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS LdapGroup #> function Get-LELdapGroupById { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${LdapGroupId}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject[]] ${Include}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-LELdapGroupById' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-LEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/v7/auth/ldap-groups/{ldapGroupId}' if (!$LdapGroupId) { throw "Error! The required parameter `LdapGroupId` missing when calling getLdapGroupById." } $LocalVarUri = $LocalVarUri.replace('{ldapGroupId}', [System.Web.HTTPUtility]::UrlEncode($LdapGroupId)) if ($Include) { $LocalVarQueryParameters['include'] = $Include } if ($Configuration["ApiKeyPrefix"] -and $Configuration["ApiKeyPrefix"]["Authorization"]) { $apiKeyPrefix = $Configuration["ApiKeyPrefix"]["Authorization"] } else { $apiKeyPrefix = "" } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["Authorization"]) { $LocalVarHeaderParameters['Authorization'] = $apiKeyPrefix + $Configuration["ApiKey"]["Authorization"] Write-Verbose ("Using API key 'Authorization' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-LEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "LdapGroup" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Update ldap group .DESCRIPTION No description available. .PARAMETER LdapGroupId Ldap group id .PARAMETER LdapGroupUpdate Ldap 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 Update-LELdapGroup { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${LdapGroupId}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${LdapGroupUpdate}, [Switch] $WithHttpInfo ) Process { 'Calling method: Update-LELdapGroup' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-LEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/v7/auth/ldap-groups/{ldapGroupId}' if (!$LdapGroupId) { throw "Error! The required parameter `LdapGroupId` missing when calling updateLdapGroup." } $LocalVarUri = $LocalVarUri.replace('{ldapGroupId}', [System.Web.HTTPUtility]::UrlEncode($LdapGroupId)) $LocalVarBodyParameter = $LdapGroupUpdate | ConvertTo-Json -Depth 100 if ($Configuration["ApiKeyPrefix"] -and $Configuration["ApiKeyPrefix"]["Authorization"]) { $apiKeyPrefix = $Configuration["ApiKeyPrefix"]["Authorization"] } else { $apiKeyPrefix = "" } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["Authorization"]) { $LocalVarHeaderParameters['Authorization'] = $apiKeyPrefix + $Configuration["ApiKey"]["Authorization"] Write-Verbose ("Using API key 'Authorization' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-LEApiClient -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"] } } } |