Skip to content

Latest commit

 

History

History
executable file
·
269 lines (184 loc) · 8.68 KB

GroAdminSystemAdminMConfApi.md

File metadata and controls

executable file
·
269 lines (184 loc) · 8.68 KB

GrommunioAdmin.GrommunioAdmin/Api.GroAdminSystemAdminMConfApi

All URIs are relative to /api/v1

Method HTTP request Description
Invoke-GroAdminDeleteAuthmgr DELETE /system/mconf/authmgr deleteAuthmgr
Invoke-GroAdminDeleteLDAPConf DELETE /system/mconf/ldap deleteLDAPConf
Get-GroAdminAuthmgr GET /system/mconf/authmgr getAuthmgr
Get-GroAdminLDAPConf GET /system/mconf/ldap getLDAPConf
Set-GroAdminAuthmgr PUT /system/mconf/authmgr setAuthmgr
Set-GroAdminLDAPConf PUT /system/mconf/ldap setLDAPConf

Invoke-GroAdminDeleteAuthmgr

void Invoke-GroAdminDeleteAuthmgr

deleteAuthmgr

Reset authmgr configuration to default

Example

# deleteAuthmgr
try {
    $Result = Invoke-GroAdminDeleteAuthmgr
} catch {
    Write-Host ("Exception occurred when calling Invoke-GroAdminDeleteAuthmgr: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-GroAdminDeleteLDAPConf

void Invoke-GroAdminDeleteLDAPConf
        [-XCsrfToken]

deleteLDAPConf

Remove LDAP configuration and disable service

Example

$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)

# deleteLDAPConf
try {
    $Result = Invoke-GroAdminDeleteLDAPConf -XCsrfToken $XCsrfToken
} catch {
    Write-Host ("Exception occurred when calling Invoke-GroAdminDeleteLDAPConf: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
XCsrfToken String CSRF Token [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-GroAdminAuthmgr

SystemMconfAuthmgrResponse Get-GroAdminAuthmgr

getAuthmgr

Get the current authmgr configuration

Example

# getAuthmgr
try {
    $Result = Get-GroAdminAuthmgr
} catch {
    Write-Host ("Exception occurred when calling Get-GroAdminAuthmgr: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

This endpoint does not need any parameter.

Return type

SystemMconfAuthmgrResponse (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-GroAdminLDAPConf

SystemMconfLdapResponse Get-GroAdminLDAPConf

getLDAPConf

Get the current LDAP configuration

Example

# getLDAPConf
try {
    $Result = Get-GroAdminLDAPConf
} catch {
    Write-Host ("Exception occurred when calling Get-GroAdminLDAPConf: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

This endpoint does not need any parameter.

Return type

SystemMconfLdapResponse (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Set-GroAdminAuthmgr

void Set-GroAdminAuthmgr
        [-XCsrfToken]
        [-SetAuthmgrRequest]

setAuthmgr

Set new authmgr configuration

Example

$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$AuthBackendSelection = Initialize-AuthBackendSelection 
$SetAuthmgrRequest = Initialize-SetAuthmgrRequest -AuthBackendSelection $AuthBackendSelection # SetAuthmgrRequest |  (optional)

# setAuthmgr
try {
    $Result = Set-GroAdminAuthmgr -XCsrfToken $XCsrfToken -SetAuthmgrRequest $SetAuthmgrRequest
} catch {
    Write-Host ("Exception occurred when calling Set-GroAdminAuthmgr: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
XCsrfToken String CSRF Token [optional]
SetAuthmgrRequest SetAuthmgrRequest [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Set-GroAdminLDAPConf

void Set-GroAdminLDAPConf
        [-XCsrfToken]
        [-Force] <System.Nullable[Boolean]>
        [-SetOrgLDAPConfRequest]

setLDAPConf

Set new LDAP configuration

Example

$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$Force = $true # Boolean | Update configuration even if validation failed (optional)
$LdapConfigConnection = Initialize-LdapConfigConnection -Server "MyServer" -BindUser "MyBindUser" -BindPass "MyBindPass" -Starttls $false
$LdapConfigUsers = Initialize-LdapConfigUsers -Username "MyUsername" -DisplayName "MyDisplayName" -Filters "MyFilters" -VarFilter "(&(objectclass=person)(mailPrimaryAddress=*))" -Templates "MyTemplates" -Attributes @{ key_example = "MyInner" } -DefaultQuota 0 -SearchAttributes "MySearchAttributes" -Aliases "MyAliases"
$SetOrgLDAPConfRequest = Initialize-SetOrgLDAPConfRequest -Disabled $false -Connection $LdapConfigConnection -BaseDn "MyBaseDn" -ObjectID "MyObjectID" -Users $LdapConfigUsers # SetOrgLDAPConfRequest |  (optional)

# setLDAPConf
try {
    $Result = Set-GroAdminLDAPConf -XCsrfToken $XCsrfToken -Force $Force -SetOrgLDAPConfRequest $SetOrgLDAPConfRequest
} catch {
    Write-Host ("Exception occurred when calling Set-GroAdminLDAPConf: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
XCsrfToken String CSRF Token [optional]
Force Boolean Update configuration even if validation failed [optional]
SetOrgLDAPConfRequest SetOrgLDAPConfRequest [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]