All URIs are relative to /api/v1
Method | HTTP request | Description |
---|---|---|
Stop-GroAdminWipe | DELETE /domains/{domainID}/users/{userID}/sync/{deviceID}/wipe | cancelWipe |
Invoke-GroAdminDeleteStoreAccessUser | DELETE /domains/{domainID}/users/{userID}/storeAccess/{username} | deleteStoreAccessUser |
Invoke-GroAdminDeleteStoreProps | DELETE /domains/{domainID}/users/{userID}/storeProps | deleteStoreProps |
Invoke-GroAdminDeleteUser | DELETE /domains/{domainID}/users/{userID} | deleteUser |
Get-GroAdminDelegates | GET /domains/{domainID}/users/{userID}/delegates | getDelegates |
Get-GroAdminDomainSyncPolicy | GET /domains/{domainID}/syncPolicy | getDomainSyncPolicy |
Get-GroAdminSendas | GET /domains/{domainID}/users/{userID}/sendas | getSendas |
Get-GroAdminStoreAccessUsers | GET /domains/{domainID}/users/{userID}/storeAccess | getStoreAccessUsers |
Get-GroAdminStoreProps | GET /domains/{domainID}/users/{userID}/storeProps | getStoreProps |
Get-GroAdminSyncedDevices | GET /domains/{domainID}/users/{userID}/sync | getSyncedDevices |
Get-GroAdminUser | GET /domains/{domainID}/users/{userID} | getUser |
Get-GroAdminUsers | GET /domains/{domainID}/users | getUsers |
Invoke-GroAdminOofSizeLarge | GET /domains/{domainID}/users/{userID}/oof | oofSizeLarge |
Invoke-GroAdminPatchStoreProps | PATCH /domains/{domainID}/users/{userID}/storeProps | patchStoreProps |
Invoke-GroAdminPatchUser | PATCH /domains/{domainID}/users/{userID} | patchUser |
Submit-GroAdminDeviceWipe | POST /domains/{domainID}/users/{userID}/sync/{deviceID}/wipe | postDeviceWipe |
Submit-GroAdminStoreAccessUser | POST /domains/{domainID}/users/{userID}/storeAccess | postStoreAccessUser |
Submit-GroAdminUser | POST /domains/{domainID}/users | postUser |
Send-GroAdminDelegates | PUT /domains/{domainID}/users/{userID}/delegates | putDelegates |
Send-GroAdminDeviceResync | PUT /domains/{domainID}/users/{userID}/sync/{deviceID}/resync | putDeviceResync |
Send-GroAdminDownsync | PUT /domains/{domainID}/users/{userID}/downsync | putDownsync |
Send-GroAdminSendas | PUT /domains/{domainID}/users/{userID}/sendas | putSendas |
Send-GroAdminStoreAccessUser | PUT /domains/{domainID}/users/{userID}/storeAccess | putStoreAccessUser |
Remove-GroAdminDeviceResync | DELETE /domains/{domainID}/users/{userID}/sync/{deviceID} | removeDeviceResync |
Remove-GroAdminDeviceStates | DELETE /domains/{domainID}/users/{userID}/sync | removeDeviceStates |
Set-GroAdminOofSize | PUT /domains/{domainID}/users/{userID}/oof | setOofSize |
Set-GroAdminPassword | PUT /domains/{domainID}/users/{userID}/password | setPassword |
void Stop-GroAdminWipe
[-UserID]
[-DomainID]
[-DeviceID]
[-XCsrfToken]
cancelWipe
Cancel wipe request
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
$DeviceID = "MyDeviceID" # String | Device ID
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
# cancelWipe
try {
$Result = Stop-GroAdminWipe -UserID $UserID -DomainID $DomainID -DeviceID $DeviceID -XCsrfToken $XCsrfToken
} catch {
Write-Host ("Exception occurred when calling Stop-GroAdminWipe: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain | |
DeviceID | String | Device ID | |
XCsrfToken | String | CSRF Token | [optional] |
void (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void Invoke-GroAdminDeleteStoreAccessUser
[-UserID]
[-DomainID]
[-Username]
[-XCsrfToken]
deleteStoreAccessUser
Remove user from store access list
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
$Username = "MyUsername" # String | E-mail address of the user
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
# deleteStoreAccessUser
try {
$Result = Invoke-GroAdminDeleteStoreAccessUser -UserID $UserID -DomainID $DomainID -Username $Username -XCsrfToken $XCsrfToken
} catch {
Write-Host ("Exception occurred when calling Invoke-GroAdminDeleteStoreAccessUser: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain | |
Username | String | E-mail address of the user | |
XCsrfToken | String | CSRF Token | [optional] |
void (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void Invoke-GroAdminDeleteStoreProps
[-UserID]
[-DomainID]
[-XCsrfToken]
[-Properties]
deleteStoreProps
Delete user store props
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$Properties = "MyProperties" # String | Comma separated list of properties to return (optional)
# deleteStoreProps
try {
$Result = Invoke-GroAdminDeleteStoreProps -UserID $UserID -DomainID $DomainID -XCsrfToken $XCsrfToken -Properties $Properties
} catch {
Write-Host ("Exception occurred when calling Invoke-GroAdminDeleteStoreProps: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain | |
XCsrfToken | String | CSRF Token | [optional] |
Properties | String | Comma separated list of properties to return | [optional] |
void (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void Invoke-GroAdminDeleteUser
[-UserID]
[-DomainID]
[-XCsrfToken]
[-DeleteFiles] <System.Nullable[Boolean]>
[-DeleteChatUser] <System.Nullable[Boolean]>
deleteUser
Delete user
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$DeleteFiles = $true # Boolean | Delete user files on disk (optional) (default to $false)
$DeleteChatUser = $true # Boolean | Permanently delete chat user (optional) (default to $true)
# deleteUser
try {
$Result = Invoke-GroAdminDeleteUser -UserID $UserID -DomainID $DomainID -XCsrfToken $XCsrfToken -DeleteFiles $DeleteFiles -DeleteChatUser $DeleteChatUser
} catch {
Write-Host ("Exception occurred when calling Invoke-GroAdminDeleteUser: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain | |
XCsrfToken | String | CSRF Token | [optional] |
DeleteFiles | Boolean | Delete user files on disk | [optional] [default to $false] |
DeleteChatUser | Boolean | Permanently delete chat user | [optional] [default to $true] |
void (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DomainsUsersDelegatesResponse Get-GroAdminDelegates
[-UserID]
[-DomainID]
getDelegates
Get list of users that can send mails on the users behalf
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
# getDelegates
try {
$Result = Get-GroAdminDelegates -UserID $UserID -DomainID $DomainID
} catch {
Write-Host ("Exception occurred when calling Get-GroAdminDelegates: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain |
DomainsUsersDelegatesResponse (PSCustomObject)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DomainsSyncPolicyResponse Get-GroAdminDomainSyncPolicy
[-DomainID]
getDomainSyncPolicy
Get effective domain sync policy
$DomainID = 56 # Int32 | ID of the domain
# getDomainSyncPolicy
try {
$Result = Get-GroAdminDomainSyncPolicy -DomainID $DomainID
} catch {
Write-Host ("Exception occurred when calling Get-GroAdminDomainSyncPolicy: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
DomainID | Int32 | ID of the domain |
DomainsSyncPolicyResponse (PSCustomObject)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DomainsUsersSendasResponse Get-GroAdminSendas
[-UserID]
[-DomainID]
getSendas
Get list of users that can send mails as the user
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
# getSendas
try {
$Result = Get-GroAdminSendas -UserID $UserID -DomainID $DomainID
} catch {
Write-Host ("Exception occurred when calling Get-GroAdminSendas: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain |
DomainsUsersSendasResponse (PSCustomObject)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DomainsUsersStoreAccessResponse Get-GroAdminStoreAccessUsers
[-UserID]
[-DomainID]
getStoreAccessUsers
Get list of users that can access the users store
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
# getStoreAccessUsers
try {
$Result = Get-GroAdminStoreAccessUsers -UserID $UserID -DomainID $DomainID
} catch {
Write-Host ("Exception occurred when calling Get-GroAdminStoreAccessUsers: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain |
DomainsUsersStoreAccessResponse (PSCustomObject)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DomainsUsersStorePropsResponse Get-GroAdminStoreProps
[-UserID]
[-DomainID]
[-Properties]
getStoreProps
Get user store properties
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
$Properties = "MyProperties" # String | Comma separated list of properties to return (optional)
# getStoreProps
try {
$Result = Get-GroAdminStoreProps -UserID $UserID -DomainID $DomainID -Properties $Properties
} catch {
Write-Host ("Exception occurred when calling Get-GroAdminStoreProps: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain | |
Properties | String | Comma separated list of properties to return | [optional] |
DomainsUsersStorePropsResponse (PSCustomObject)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DomainsUsersSyncResponse Get-GroAdminSyncedDevices
[-UserID]
[-DomainID]
getSyncedDevices
Get status of synced devices
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
# getSyncedDevices
try {
$Result = Get-GroAdminSyncedDevices -UserID $UserID -DomainID $DomainID
} catch {
Write-Host ("Exception occurred when calling Get-GroAdminSyncedDevices: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain |
DomainsUsersSyncResponse (PSCustomObject)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
User Get-GroAdminUser
[-UserID]
[-DomainID]
[-Level] <System.Nullable[Int32]>
getUser
Get information about a specific user
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
$Level = 56 # Int32 | Set detail level of return value. Usually ranges from 0 to 2. (optional)
# getUser
try {
$Result = Get-GroAdminUser -UserID $UserID -DomainID $DomainID -Level $Level
} catch {
Write-Host ("Exception occurred when calling Get-GroAdminUser: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain | |
Level | Int32 | Set detail level of return value. Usually ranges from 0 to 2. | [optional] |
User (PSCustomObject)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DomainsUsersResponse Get-GroAdminUsers
[-DomainID]
[-Level] <System.Nullable[Int32]>
[-Limit] <System.Nullable[Int32]>
[-Offset] <System.Nullable[Int32]>
[-Match]
[-MatchFields]
[-Sort]
[-ID] <System.Nullable[Int32][]>
[-Username]
[-Properties]
getUsers
Get lists of users
$DomainID = 56 # Int32 | ID of the domain
$Level = 56 # Int32 | Set detail level of return value. Usually ranges from 0 to 2. (optional)
$Limit = 56 # Int32 | Maximum number of results to return (optional) (default to 50)
$Offset = 56 # Int32 | Index of the first element to return (optional) (default to 0)
$Match = "MyMatch" # String | Match by substring (optional)
$MatchFields = "MyMatchFields" # String | Comma separated list of attributes to restrict matching to. (optional)
$Sort = "MySort" # String | Sort by attribute. Can be given multiple times. (optional)
$ID = 0 # Int32[] | Filter one or more IDs (optional)
$Username = "MyUsername" # String | Filter by username (optional)
$Properties = "MyProperties" # String | Comma separated list of properties to return (optional)
# getUsers
try {
$Result = Get-GroAdminUsers -DomainID $DomainID -Level $Level -Limit $Limit -Offset $Offset -Match $Match -MatchFields $MatchFields -Sort $Sort -ID $ID -Username $Username -Properties $Properties
} catch {
Write-Host ("Exception occurred when calling Get-GroAdminUsers: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
DomainID | Int32 | ID of the domain | |
Level | Int32 | Set detail level of return value. Usually ranges from 0 to 2. | [optional] |
Limit | Int32 | Maximum number of results to return | [optional] [default to 50] |
Offset | Int32 | Index of the first element to return | [optional] [default to 0] |
Match | String | Match by substring | [optional] |
MatchFields | String | Comma separated list of attributes to restrict matching to. | [optional] |
Sort | String | Sort by attribute. Can be given multiple times. | [optional] |
ID | Int32[] | Filter one or more IDs | [optional] |
Username | String | Filter by username | [optional] |
Properties | String | Comma separated list of properties to return | [optional] |
DomainsUsersResponse (PSCustomObject)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserOofState Invoke-GroAdminOofSizeLarge
[-DomainID]
[-UserID]
oofSizeLarge
Get user's out of office state
$DomainID = 56 # Int32 | ID of the domain
$UserID = 56 # Int32 | ID of the user
# oofSizeLarge
try {
$Result = Invoke-GroAdminOofSizeLarge -DomainID $DomainID -UserID $UserID
} catch {
Write-Host ("Exception occurred when calling Invoke-GroAdminOofSizeLarge: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
DomainID | Int32 | ID of the domain | |
UserID | Int32 | ID of the user |
UserOofState (PSCustomObject)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DomainsUsersStorePropsResponse1 Invoke-GroAdminPatchStoreProps
[-UserID]
[-DomainID]
[-XCsrfToken]
[-RequestBody] <System.Collections.Hashtable>
patchStoreProps
Update store properties
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$RequestBody = $PatchStorePropsRequestValue = Initialize-PatchStorePropsRequestValue
$RequestBody = @{ key_example = $PatchStorePropsRequestValue } # System.Collections.Hashtable | (optional)
# patchStoreProps
try {
$Result = Invoke-GroAdminPatchStoreProps -UserID $UserID -DomainID $DomainID -XCsrfToken $XCsrfToken -RequestBody $RequestBody
} catch {
Write-Host ("Exception occurred when calling Invoke-GroAdminPatchStoreProps: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain | |
XCsrfToken | String | CSRF Token | [optional] |
RequestBody | System.Collections.Hashtable | [optional] |
DomainsUsersStorePropsResponse1 (PSCustomObject)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
User Invoke-GroAdminPatchUser
[-UserID]
[-DomainID]
[-XCsrfToken]
[-PatchUserRequest]
patchUser
Update user
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$UserStatus = Initialize-UserStatus
$SrcAuth = Initialize-SrcAuth
$Protocol = Initialize-Protocol
$FetchmailEntry = Initialize-FetchmailEntry -ID 0 -Mailbox "MyMailbox" -Active $false -SrcServer "MySrcServer" -SrcUser "MySrcUser" -SrcPassword "MySrcPassword" -Date "MyDate" -SrcAuth $SrcAuth -SrcFolder "MySrcFolder" -Fetchall $false -Keep $false -Protocol $Protocol -UseSSL $false -SslCertCheck $false -SslCertPath "MySslCertPath" -SslFingerprint "MySslFingerprint" -ExtraOptions "MyExtraOptions"
$Allowbluetooth = Initialize-Allowbluetooth
$Allowbrowser = Initialize-Allowbrowser
$Allowcam = Initialize-Allowcam
$Allowconsumeremail = Initialize-Allowconsumeremail
$Allowdesktopsync = Initialize-Allowdesktopsync
$Allowhtmlemail = Initialize-Allowhtmlemail
$Allowinternetsharing = Initialize-Allowinternetsharing
$Allowirda = Initialize-Allowirda
$Allowpopimapemail = Initialize-Allowpopimapemail
$Allowremotedesk = Initialize-Allowremotedesk
$Allowsimpledevpw = Initialize-Allowsimpledevpw
$Allowsmimeencalgneg = Initialize-Allowsmimeencalgneg
$Allowsmimesoftcerts = Initialize-Allowsmimesoftcerts
$Allowstoragecard = Initialize-Allowstoragecard
$Allowtextmessaging = Initialize-Allowtextmessaging
$Allowunsignedapps = Initialize-Allowunsignedapps
$Allowunsigninstallpacks = Initialize-Allowunsigninstallpacks
$Allowwifi = Initialize-Allowwifi
$Alphanumpwreq = Initialize-Alphanumpwreq
$Attenabled = Initialize-Attenabled
$Devencenabled = Initialize-Devencenabled
$Devpwenabled = Initialize-Devpwenabled
$SyncPolicyMaxattsize = Initialize-SyncPolicyMaxattsize
$Maxcalagefilter = Initialize-Maxcalagefilter
$Maxemailagefilter = Initialize-Maxemailagefilter
$Pwrecoveryenabled = Initialize-Pwrecoveryenabled
$Reqdevenc = Initialize-Reqdevenc
$Reqencsmimealgorithm = Initialize-Reqencsmimealgorithm
$Reqencsmimemessages = Initialize-Reqencsmimemessages
$Reqmansyncroam = Initialize-Reqmansyncroam
$Reqsignedsmimealgorithm = Initialize-Reqsignedsmimealgorithm
$Reqsignedsmimemessages = Initialize-Reqsignedsmimemessages
$DomainCommonSyncPolicy = Initialize-DomainCommonSyncPolicy -Allowbluetooth $Allowbluetooth -Allowbrowser $Allowbrowser -Allowcam $Allowcam -Allowconsumeremail $Allowconsumeremail -Allowdesktopsync $Allowdesktopsync -Allowhtmlemail $Allowhtmlemail -Allowinternetsharing $Allowinternetsharing -Allowirda $Allowirda -Allowpopimapemail $Allowpopimapemail -Allowremotedesk $Allowremotedesk -Allowsimpledevpw $Allowsimpledevpw -Allowsmimeencalgneg $Allowsmimeencalgneg -Allowsmimesoftcerts $Allowsmimesoftcerts -Allowstoragecard $Allowstoragecard -Allowtextmessaging $Allowtextmessaging -Allowunsignedapps $Allowunsignedapps -Allowunsigninstallpacks $Allowunsigninstallpacks -Allowwifi $Allowwifi -Alphanumpwreq $Alphanumpwreq -Approvedapplist "MyApprovedapplist" -Attenabled $Attenabled -Devencenabled $Devencenabled -Devpwenabled $Devpwenabled -Devpwexpiration 0 -Devpwhistory 0 -Maxattsize $SyncPolicyMaxattsize -Maxcalagefilter $Maxcalagefilter -Maxdevpwfailedattempts 0 -Maxemailagefilter $Maxemailagefilter -Maxemailbodytruncsize 0 -Maxemailhtmlbodytruncsize 0 -Maxinacttimedevlock 0 -Mindevcomplexchars 0 -Mindevpwlenngth 0 -Pwrecoveryenabled $Pwrecoveryenabled -Reqdevenc $Reqdevenc -Reqencsmimealgorithm $Reqencsmimealgorithm -Reqencsmimemessages $Reqencsmimemessages -Reqmansyncroam $Reqmansyncroam -Reqsignedsmimealgorithm $Reqsignedsmimealgorithm -Reqsignedsmimemessages $Reqsignedsmimemessages -Unapprovedinromapplist "MyUnapprovedinromapplist"
$ForwardType = Initialize-ForwardType
$UserForward = Initialize-UserForward -ForwardType $ForwardType -Destination "MyDestination"
$PatchUserRequest = Initialize-PatchUserRequest -Username "MyUsername" -Properties -Aliases "MyAliases" -Status $UserStatus -Pop3Imap $false -Smtp $false -ChangePassword $false -PublicAddress $false -PrivChat $false -PrivVideo $false -PrivFiles $false -PrivArchive $false -LdapID "MyLdapID" -Fetchmail $FetchmailEntry -SyncPolicy $DomainCommonSyncPolicy -Chat $false -ChatAdmin $false -Lang "MyLang" -Forward $UserForward -Homeserver 0 # PatchUserRequest | (optional)
# patchUser
try {
$Result = Invoke-GroAdminPatchUser -UserID $UserID -DomainID $DomainID -XCsrfToken $XCsrfToken -PatchUserRequest $PatchUserRequest
} catch {
Write-Host ("Exception occurred when calling Invoke-GroAdminPatchUser: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain | |
XCsrfToken | String | CSRF Token | [optional] |
PatchUserRequest | PatchUserRequest | [optional] |
User (PSCustomObject)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void Submit-GroAdminDeviceWipe
[-UserID]
[-DomainID]
[-DeviceID]
[-XCsrfToken]
[-PostDeviceWipeRequest]
postDeviceWipe
Request a device wipe
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
$DeviceID = "MyDeviceID" # String | Device ID
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$PostDeviceWipeRequest = Initialize-PostDeviceWipeRequest -Password "MyPassword" # PostDeviceWipeRequest | (optional)
# postDeviceWipe
try {
$Result = Submit-GroAdminDeviceWipe -UserID $UserID -DomainID $DomainID -DeviceID $DeviceID -XCsrfToken $XCsrfToken -PostDeviceWipeRequest $PostDeviceWipeRequest
} catch {
Write-Host ("Exception occurred when calling Submit-GroAdminDeviceWipe: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain | |
DeviceID | String | Device ID | |
XCsrfToken | String | CSRF Token | [optional] |
PostDeviceWipeRequest | PostDeviceWipeRequest | [optional] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void Submit-GroAdminStoreAccessUser
[-UserID]
[-DomainID]
[-XCsrfToken]
[-PostStoreAccessUserRequest]
postStoreAccessUser
Grant store access to another user
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$PostStoreAccessUserRequest = Initialize-PostStoreAccessUserRequest -Username "MyUsername" # PostStoreAccessUserRequest | (optional)
# postStoreAccessUser
try {
$Result = Submit-GroAdminStoreAccessUser -UserID $UserID -DomainID $DomainID -XCsrfToken $XCsrfToken -PostStoreAccessUserRequest $PostStoreAccessUserRequest
} catch {
Write-Host ("Exception occurred when calling Submit-GroAdminStoreAccessUser: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain | |
XCsrfToken | String | CSRF Token | [optional] |
PostStoreAccessUserRequest | PostStoreAccessUserRequest | [optional] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
User Submit-GroAdminUser
[-DomainID]
[-XCsrfToken]
[-PostUserRequest]
postUser
Create new user
$DomainID = 56 # Int32 | ID of the domain
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$UserStatus = Initialize-UserStatus
$SrcAuth = Initialize-SrcAuth
$Protocol = Initialize-Protocol
$FetchmailEntry = Initialize-FetchmailEntry -ID 0 -Mailbox "MyMailbox" -Active $false -SrcServer "MySrcServer" -SrcUser "MySrcUser" -SrcPassword "MySrcPassword" -Date "MyDate" -SrcAuth $SrcAuth -SrcFolder "MySrcFolder" -Fetchall $false -Keep $false -Protocol $Protocol -UseSSL $false -SslCertCheck $false -SslCertPath "MySslCertPath" -SslFingerprint "MySslFingerprint" -ExtraOptions "MyExtraOptions"
$Allowbluetooth = Initialize-Allowbluetooth
$Allowbrowser = Initialize-Allowbrowser
$Allowcam = Initialize-Allowcam
$Allowconsumeremail = Initialize-Allowconsumeremail
$Allowdesktopsync = Initialize-Allowdesktopsync
$Allowhtmlemail = Initialize-Allowhtmlemail
$Allowinternetsharing = Initialize-Allowinternetsharing
$Allowirda = Initialize-Allowirda
$Allowpopimapemail = Initialize-Allowpopimapemail
$Allowremotedesk = Initialize-Allowremotedesk
$Allowsimpledevpw = Initialize-Allowsimpledevpw
$Allowsmimeencalgneg = Initialize-Allowsmimeencalgneg
$Allowsmimesoftcerts = Initialize-Allowsmimesoftcerts
$Allowstoragecard = Initialize-Allowstoragecard
$Allowtextmessaging = Initialize-Allowtextmessaging
$Allowunsignedapps = Initialize-Allowunsignedapps
$Allowunsigninstallpacks = Initialize-Allowunsigninstallpacks
$Allowwifi = Initialize-Allowwifi
$Alphanumpwreq = Initialize-Alphanumpwreq
$Attenabled = Initialize-Attenabled
$Devencenabled = Initialize-Devencenabled
$Devpwenabled = Initialize-Devpwenabled
$SyncPolicyMaxattsize = Initialize-SyncPolicyMaxattsize
$Maxcalagefilter = Initialize-Maxcalagefilter
$Maxemailagefilter = Initialize-Maxemailagefilter
$Pwrecoveryenabled = Initialize-Pwrecoveryenabled
$Reqdevenc = Initialize-Reqdevenc
$Reqencsmimealgorithm = Initialize-Reqencsmimealgorithm
$Reqencsmimemessages = Initialize-Reqencsmimemessages
$Reqmansyncroam = Initialize-Reqmansyncroam
$Reqsignedsmimealgorithm = Initialize-Reqsignedsmimealgorithm
$Reqsignedsmimemessages = Initialize-Reqsignedsmimemessages
$DomainCommonSyncPolicy = Initialize-DomainCommonSyncPolicy -Allowbluetooth $Allowbluetooth -Allowbrowser $Allowbrowser -Allowcam $Allowcam -Allowconsumeremail $Allowconsumeremail -Allowdesktopsync $Allowdesktopsync -Allowhtmlemail $Allowhtmlemail -Allowinternetsharing $Allowinternetsharing -Allowirda $Allowirda -Allowpopimapemail $Allowpopimapemail -Allowremotedesk $Allowremotedesk -Allowsimpledevpw $Allowsimpledevpw -Allowsmimeencalgneg $Allowsmimeencalgneg -Allowsmimesoftcerts $Allowsmimesoftcerts -Allowstoragecard $Allowstoragecard -Allowtextmessaging $Allowtextmessaging -Allowunsignedapps $Allowunsignedapps -Allowunsigninstallpacks $Allowunsigninstallpacks -Allowwifi $Allowwifi -Alphanumpwreq $Alphanumpwreq -Approvedapplist "MyApprovedapplist" -Attenabled $Attenabled -Devencenabled $Devencenabled -Devpwenabled $Devpwenabled -Devpwexpiration 0 -Devpwhistory 0 -Maxattsize $SyncPolicyMaxattsize -Maxcalagefilter $Maxcalagefilter -Maxdevpwfailedattempts 0 -Maxemailagefilter $Maxemailagefilter -Maxemailbodytruncsize 0 -Maxemailhtmlbodytruncsize 0 -Maxinacttimedevlock 0 -Mindevcomplexchars 0 -Mindevpwlenngth 0 -Pwrecoveryenabled $Pwrecoveryenabled -Reqdevenc $Reqdevenc -Reqencsmimealgorithm $Reqencsmimealgorithm -Reqencsmimemessages $Reqencsmimemessages -Reqmansyncroam $Reqmansyncroam -Reqsignedsmimealgorithm $Reqsignedsmimealgorithm -Reqsignedsmimemessages $Reqsignedsmimemessages -Unapprovedinromapplist "MyUnapprovedinromapplist"
$ForwardType = Initialize-ForwardType
$UserForward = Initialize-UserForward -ForwardType $ForwardType -Destination "MyDestination"
$PostUserRequest = Initialize-PostUserRequest -Username "MyUsername" -Password "MyPassword" -DomainID 0 -Properties -Aliases "MyAliases" -Status $UserStatus -Pop3Imap $false -Smtp $false -ChangePassword $false -PublicAddress $false -PrivChat $false -PrivVideo $false -PrivFiles $false -PrivArchive $false -Fetchmail $FetchmailEntry -SyncPolicy $DomainCommonSyncPolicy -Chat $false -ChatAdmin $false -Lang "MyLang" -Forward $UserForward -Homeserver 0 # PostUserRequest | (optional)
# postUser
try {
$Result = Submit-GroAdminUser -DomainID $DomainID -XCsrfToken $XCsrfToken -PostUserRequest $PostUserRequest
} catch {
Write-Host ("Exception occurred when calling Submit-GroAdminUser: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
DomainID | Int32 | ID of the domain | |
XCsrfToken | String | CSRF Token | [optional] |
PostUserRequest | PostUserRequest | [optional] |
User (PSCustomObject)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void Send-GroAdminDelegates
[-UserID]
[-DomainID]
[-XCsrfToken]
[-RequestBody] <String[]>
putDelegates
Set list of users that can send mails on the users behalf
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$RequestBody = "MyRequestBody" # String[] | (optional)
# putDelegates
try {
$Result = Send-GroAdminDelegates -UserID $UserID -DomainID $DomainID -XCsrfToken $XCsrfToken -RequestBody $RequestBody
} catch {
Write-Host ("Exception occurred when calling Send-GroAdminDelegates: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain | |
XCsrfToken | String | CSRF Token | [optional] |
RequestBody | String[] | [optional] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void Send-GroAdminDeviceResync
[-UserID]
[-DomainID]
[-DeviceID]
[-XCsrfToken]
putDeviceResync
Request a device resync
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
$DeviceID = "MyDeviceID" # String | Device ID
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
# putDeviceResync
try {
$Result = Send-GroAdminDeviceResync -UserID $UserID -DomainID $DomainID -DeviceID $DeviceID -XCsrfToken $XCsrfToken
} catch {
Write-Host ("Exception occurred when calling Send-GroAdminDeviceResync: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain | |
DeviceID | String | Device ID | |
XCsrfToken | String | CSRF Token | [optional] |
void (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
User Send-GroAdminDownsync
[-DomainID]
[-UserID]
[-XCsrfToken]
[-ID]
[-Lang]
putDownsync
Update user from LDAP
$DomainID = 56 # Int32 | ID of the domain
$UserID = 56 # Int32 | ID of the user
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$ID = "MyID" # String | Optional LDAP object ID (optional)
$Lang = "MyLang" # String | Default language for imported users (optional)
# putDownsync
try {
$Result = Send-GroAdminDownsync -DomainID $DomainID -UserID $UserID -XCsrfToken $XCsrfToken -ID $ID -Lang $Lang
} catch {
Write-Host ("Exception occurred when calling Send-GroAdminDownsync: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
DomainID | Int32 | ID of the domain | |
UserID | Int32 | ID of the user | |
XCsrfToken | String | CSRF Token | [optional] |
ID | String | Optional LDAP object ID | [optional] |
Lang | String | Default language for imported users | [optional] |
User (PSCustomObject)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void Send-GroAdminSendas
[-UserID]
[-DomainID]
[-XCsrfToken]
[-RequestBody] <String[]>
putSendas
Set list of users that can send mails as the user
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$RequestBody = "MyRequestBody" # String[] | (optional)
# putSendas
try {
$Result = Send-GroAdminSendas -UserID $UserID -DomainID $DomainID -XCsrfToken $XCsrfToken -RequestBody $RequestBody
} catch {
Write-Host ("Exception occurred when calling Send-GroAdminSendas: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain | |
XCsrfToken | String | CSRF Token | [optional] |
RequestBody | String[] | [optional] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void Send-GroAdminStoreAccessUser
[-UserID]
[-DomainID]
[-XCsrfToken]
[-PutStoreAccessUserRequest]
putStoreAccessUser
Overwrite the list of users with store access
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$PutStoreAccessUserRequest = Initialize-PutStoreAccessUserRequest -Usernames "MyUsernames" # PutStoreAccessUserRequest | (optional)
# putStoreAccessUser
try {
$Result = Send-GroAdminStoreAccessUser -UserID $UserID -DomainID $DomainID -XCsrfToken $XCsrfToken -PutStoreAccessUserRequest $PutStoreAccessUserRequest
} catch {
Write-Host ("Exception occurred when calling Send-GroAdminStoreAccessUser: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain | |
XCsrfToken | String | CSRF Token | [optional] |
PutStoreAccessUserRequest | PutStoreAccessUserRequest | [optional] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void Remove-GroAdminDeviceResync
[-UserID]
[-DomainID]
[-DeviceID]
[-XCsrfToken]
removeDeviceResync
Remove device (issue a resync)
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
$DeviceID = "MyDeviceID" # String | Device ID
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
# removeDeviceResync
try {
$Result = Remove-GroAdminDeviceResync -UserID $UserID -DomainID $DomainID -DeviceID $DeviceID -XCsrfToken $XCsrfToken
} catch {
Write-Host ("Exception occurred when calling Remove-GroAdminDeviceResync: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain | |
DeviceID | String | Device ID | |
XCsrfToken | String | CSRF Token | [optional] |
void (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void Remove-GroAdminDeviceStates
[-UserID]
[-DomainID]
[-XCsrfToken]
removeDeviceStates
Remove device states
$UserID = 56 # Int32 | ID of the user
$DomainID = 56 # Int32 | ID of the domain
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
# removeDeviceStates
try {
$Result = Remove-GroAdminDeviceStates -UserID $UserID -DomainID $DomainID -XCsrfToken $XCsrfToken
} catch {
Write-Host ("Exception occurred when calling Remove-GroAdminDeviceStates: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
UserID | Int32 | ID of the user | |
DomainID | Int32 | ID of the domain | |
XCsrfToken | String | CSRF Token | [optional] |
void (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void Set-GroAdminOofSize
[-DomainID]
[-UserID]
[-XCsrfToken]
[-SetOofSizeRequest]
setOofSize
Set user's out of office state
$DomainID = 56 # Int32 | ID of the domain
$UserID = 56 # Int32 | ID of the user
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$State1 = Initialize-State1
$ExternalAudience = Initialize-ExternalAudience
$SetOofSizeRequest = Initialize-SetOofSizeRequest -State $State1 -ExternalAudience $ExternalAudience -StartTime "MyStartTime" -EndTime "MyEndTime" -InternalSubject "MyInternalSubject" -InternalReply "MyInternalReply" -ExternalSubject "MyExternalSubject" -ExternalReply "MyExternalReply" # SetOofSizeRequest | (optional)
# setOofSize
try {
$Result = Set-GroAdminOofSize -DomainID $DomainID -UserID $UserID -XCsrfToken $XCsrfToken -SetOofSizeRequest $SetOofSizeRequest
} catch {
Write-Host ("Exception occurred when calling Set-GroAdminOofSize: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
DomainID | Int32 | ID of the domain | |
UserID | Int32 | ID of the user | |
XCsrfToken | String | CSRF Token | [optional] |
SetOofSizeRequest | SetOofSizeRequest | [optional] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void Set-GroAdminPassword
[-DomainID]
[-UserID]
[-XCsrfToken]
[-SetPasswordRequest]
setPassword
Set user password
$DomainID = 56 # Int32 | ID of the domain
$UserID = 56 # Int32 | ID of the user
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$SetPasswordRequest = Initialize-SetPasswordRequest -New "MyNew" # SetPasswordRequest | (optional)
# setPassword
try {
$Result = Set-GroAdminPassword -DomainID $DomainID -UserID $UserID -XCsrfToken $XCsrfToken -SetPasswordRequest $SetPasswordRequest
} catch {
Write-Host ("Exception occurred when calling Set-GroAdminPassword: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
DomainID | Int32 | ID of the domain | |
UserID | Int32 | ID of the user | |
XCsrfToken | String | CSRF Token | [optional] |
SetPasswordRequest | SetPasswordRequest | [optional] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]