GroAdminServiceApi.md

GrommunioAdmin.GrommunioAdmin/Api.GroAdminServiceApi

All URIs are relative to /api/v1

Method	HTTP request	Description
Get-GroAdminUserDeviceWipeStatus	GET /service/wipe/{username}	getUserDeviceWipeStatus
Get-GroAdminUserInformation	GET /service/userinfo/{username}	getUserInformation
Get-GroAdminUserSyncPolicy	GET /service/syncPolicy/{username}	getUserSyncPolicy
Send-GroAdminPasswd	PUT /passwd	putPasswd
Set-GroAdminUserDeviceWipeStatus	POST /service/wipe/{username}	setUserDeviceWipeStatus

Get-GroAdminUserDeviceWipeStatus

ServiceWipeResponse Get-GroAdminUserDeviceWipeStatus
        [-Username]
        [-Devices] <String[]>

getUserDeviceWipeStatus

Get device wipe status for user

Example

$Username = "MyUsername" # String | E-mail address of the user
$Devices = "MyDevices" # String[] | Restrict request to these device IDs (optional)

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

Parameters

Name	Type	Description	Notes
Username	String	E-mail address of the user
Devices	String[]	Restrict request to these device IDs	[optional]

Return type

ServiceWipeResponse (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-GroAdminUserInformation

ServiceUserinfoResponse Get-GroAdminUserInformation
        [-Username]

getUserInformation

Get basic user information

Example

$Username = "MyUsername" # String | E-mail address of the user

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

Parameters

Name	Type	Description	Notes
Username	String	E-mail address of the user

Return type

ServiceUserinfoResponse (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-GroAdminUserSyncPolicy

ServiceSyncPolicyResponse Get-GroAdminUserSyncPolicy
        [-Username]

getUserSyncPolicy

Get sync policy for specific user

Example

$Username = "MyUsername" # String | E-mail address of the user

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

Parameters

Name	Type	Description	Notes
Username	String	E-mail address of the user

Return type

ServiceSyncPolicyResponse (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]

Send-GroAdminPasswd

void Send-GroAdminPasswd
        [-XCsrfToken]
        [-PutPasswdRequest]

putPasswd

Change current users password

Example

$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$PutPasswdRequest = Initialize-PutPasswdRequest -New "MyNew" -Old "MyOld" -User "MyUser" # PutPasswdRequest |  (optional)

# putPasswd
try {
    $Result = Send-GroAdminPasswd -XCsrfToken $XCsrfToken -PutPasswdRequest $PutPasswdRequest
} catch {
    Write-Host ("Exception occurred when calling Send-GroAdminPasswd: {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]
PutPasswdRequest	PutPasswdRequest		[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-GroAdminUserDeviceWipeStatus

void Set-GroAdminUserDeviceWipeStatus
        [-Username]
        [-SetUserDeviceWipeStatusRequest]
        [-XCsrfToken]
        [-Devices] <String[]>

setUserDeviceWipeStatus

Set device wipe status for user

Example

$Username = "MyUsername" # String | E-mail address of the user
$Status = Initialize-Status 
$SetUserDeviceWipeStatusRequest = Initialize-SetUserDeviceWipeStatusRequest -Password "MyPassword" -RemoteIP "MyRemoteIP" -Status $Status -Time 0 # SetUserDeviceWipeStatusRequest | 
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$Devices = "MyDevices" # String[] | Restrict request to these device IDs (optional)

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

Parameters

Name	Type	Description	Notes
Username	String	E-mail address of the user
SetUserDeviceWipeStatusRequest	SetUserDeviceWipeStatusRequest
XCsrfToken	String	CSRF Token	[optional]
Devices	String[]	Restrict request to these device IDs	[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]