All URIs are relative to /api/v1
Method | HTTP request | Description |
---|---|---|
Invoke-GroAdminDeleteFolder | DELETE /domains/{domainID}/folders/{folderID} | deleteFolder |
Invoke-GroAdminDeleteMember | DELETE /domains/{domainID}/folders/{folderID}/owners/{memberID} | deleteMember |
Get-GroAdminFolder | GET /domains/{domainID}/folders/{folderID} | getFolder |
Get-GroAdminFolderTree | GET /domains/{domainID}/folders/tree | getFolderTree |
Get-GroAdminFolders | GET /domains/{domainID}/folders | getFolders |
Get-GroAdminOwners | GET /domains/{domainID}/folders/{folderID}/owners | getOwners |
Invoke-GroAdminPatchFolder | PATCH /domains/{domainID}/folders/{folderID} | patchFolder |
Submit-GroAdminFolders | POST /domains/{domainID}/folders | postFolders |
Submit-GroAdminOwner | POST /domains/{domainID}/folders/{folderID}/owners | postOwner |
Set-GroAdminMember | PUT /domains/{domainID}/folders/{folderID}/owners/{memberID} | setMember |
DomainsFoldersResponse1 Invoke-GroAdminDeleteFolder
[-DomainID]
[-FolderID]
[-XCsrfToken]
[-Clear] <System.Nullable[Boolean]>
[-Timeout] <System.Nullable[Double]>
deleteFolder
Delete public folder
$DomainID = 56 # Int32 | ID of the domain
$FolderID = 56 # Int32 | ID of the folder
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$Clear = $true # Boolean | Clear folder before deleting it (optional) (default to $false)
$Timeout = 1.2 # Double | Time in seconds to wait for completion (optional) (default to 1)
# deleteFolder
try {
$Result = Invoke-GroAdminDeleteFolder -DomainID $DomainID -FolderID $FolderID -XCsrfToken $XCsrfToken -Clear $Clear -Timeout $Timeout
} catch {
Write-Host ("Exception occurred when calling Invoke-GroAdminDeleteFolder: {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 | |
FolderID | Int32 | ID of the folder | |
XCsrfToken | String | CSRF Token | [optional] |
Clear | Boolean | Clear folder before deleting it | [optional] [default to $false] |
Timeout | Double | Time in seconds to wait for completion | [optional] [default to 1] |
DomainsFoldersResponse1 (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 Invoke-GroAdminDeleteMember
[-DomainID]
[-FolderID]
[-MemberID]
[-XCsrfToken]
deleteMember
Remove a user from the owner list
$DomainID = 56 # Int32 | ID of the domain
$FolderID = 56 # Int32 | ID of the folder
$MemberID = 56 # Int32 | Member ID of the owner list
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
# deleteMember
try {
$Result = Invoke-GroAdminDeleteMember -DomainID $DomainID -FolderID $FolderID -MemberID $MemberID -XCsrfToken $XCsrfToken
} catch {
Write-Host ("Exception occurred when calling Invoke-GroAdminDeleteMember: {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 | |
FolderID | Int32 | ID of the folder | |
MemberID | Int32 | Member ID of the owner list | |
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]
PublicFolder Get-GroAdminFolder
[-DomainID]
[-FolderID]
getFolder
Get public folder
$DomainID = 56 # Int32 | ID of the domain
$FolderID = 56 # Int32 | ID of the folder
# getFolder
try {
$Result = Get-GroAdminFolder -DomainID $DomainID -FolderID $FolderID
} catch {
Write-Host ("Exception occurred when calling Get-GroAdminFolder: {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 | |
FolderID | Int32 | ID of the folder |
PublicFolder (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]
PublicFolderRef Get-GroAdminFolderTree
[-DomainID]
[-FolderID] <System.Nullable[Int32]>
getFolderTree
Get hierarchical view of folders
$DomainID = 56 # Int32 | ID of the domain
$FolderID = 56 # Int32 | ID of the root folder (optional)
# getFolderTree
try {
$Result = Get-GroAdminFolderTree -DomainID $DomainID -FolderID $FolderID
} catch {
Write-Host ("Exception occurred when calling Get-GroAdminFolderTree: {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 | |
FolderID | Int32 | ID of the root folder | [optional] |
PublicFolderRef (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]
DomainsFoldersResponse Get-GroAdminFolders
[-DomainID]
[-Offset] <System.Nullable[Int32]>
[-Limit] <System.Nullable[Int32]>
[-Match]
[-ParentID] <System.Nullable[Int32]>
getFolders
Get list of public folders
$DomainID = 56 # Int32 | ID of the domain
$Offset = 56 # Int32 | Index of the first element to return (optional) (default to 0)
$Limit = 56 # Int32 | Maximum number of results to return (optional) (default to 50)
$Match = "MyMatch" # String | Match by substring (optional)
$ParentID = 56 # Int32 | ID of the parent folder (optional)
# getFolders
try {
$Result = Get-GroAdminFolders -DomainID $DomainID -Offset $Offset -Limit $Limit -Match $Match -ParentID $ParentID
} catch {
Write-Host ("Exception occurred when calling Get-GroAdminFolders: {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 | |
Offset | Int32 | Index of the first element to return | [optional] [default to 0] |
Limit | Int32 | Maximum number of results to return | [optional] [default to 50] |
Match | String | Match by substring | [optional] |
ParentID | Int32 | ID of the parent folder | [optional] |
DomainsFoldersResponse (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]
DomainsFoldersOwnersResponse Get-GroAdminOwners
[-DomainID]
[-FolderID]
getOwners
Get list of folder owners
$DomainID = 56 # Int32 | ID of the domain
$FolderID = 56 # Int32 | ID of the folder
# getOwners
try {
$Result = Get-GroAdminOwners -DomainID $DomainID -FolderID $FolderID
} catch {
Write-Host ("Exception occurred when calling Get-GroAdminOwners: {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 | |
FolderID | Int32 | ID of the folder |
DomainsFoldersOwnersResponse (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 Invoke-GroAdminPatchFolder
[-DomainID]
[-FolderID]
[-XCsrfToken]
[-PatchFolderRequest]
patchFolder
Update public folder
$DomainID = 56 # Int32 | ID of the domain
$FolderID = 56 # Int32 | ID of the folder
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$Container = Initialize-Container
$PatchFolderRequest = Initialize-PatchFolderRequest -Displayname "MyDisplayname" -Container $Container -Comment "MyComment" # PatchFolderRequest | (optional)
# patchFolder
try {
$Result = Invoke-GroAdminPatchFolder -DomainID $DomainID -FolderID $FolderID -XCsrfToken $XCsrfToken -PatchFolderRequest $PatchFolderRequest
} catch {
Write-Host ("Exception occurred when calling Invoke-GroAdminPatchFolder: {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 | |
FolderID | Int32 | ID of the folder | |
XCsrfToken | String | CSRF Token | [optional] |
PatchFolderRequest | PatchFolderRequest | [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]
PublicFolder Submit-GroAdminFolders
[-DomainID]
[-XCsrfToken]
[-PostFoldersRequest]
postFolders
Create a new public folder
$DomainID = 56 # Int32 | ID of the domain
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
$Container = Initialize-Container
$PostFoldersRequest = Initialize-PostFoldersRequest -Displayname "MyDisplayname" -Container $Container -Comment "MyComment" -ParentID "MyParentID" # PostFoldersRequest | (optional)
# postFolders
try {
$Result = Submit-GroAdminFolders -DomainID $DomainID -XCsrfToken $XCsrfToken -PostFoldersRequest $PostFoldersRequest
} catch {
Write-Host ("Exception occurred when calling Submit-GroAdminFolders: {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] |
PostFoldersRequest | PostFoldersRequest | [optional] |
PublicFolder (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-GroAdminOwner
[-DomainID]
[-FolderID]
[-PostOwnerRequest]
[-XCsrfToken]
postOwner
Add a user to the owner list
$DomainID = 56 # Int32 | ID of the domain
$FolderID = 56 # Int32 | ID of the folder
$PostOwnerRequest = Initialize-PostOwnerRequest -Username "MyUsername" -Permissions 0 # PostOwnerRequest |
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
# postOwner
try {
$Result = Submit-GroAdminOwner -DomainID $DomainID -FolderID $FolderID -PostOwnerRequest $PostOwnerRequest -XCsrfToken $XCsrfToken
} catch {
Write-Host ("Exception occurred when calling Submit-GroAdminOwner: {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 | |
FolderID | Int32 | ID of the folder | |
PostOwnerRequest | PostOwnerRequest | ||
XCsrfToken | String | CSRF Token | [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-GroAdminMember
[-DomainID]
[-FolderID]
[-MemberID]
[-SetMemberRequest]
[-XCsrfToken]
setMember
Set folder member permissions
$DomainID = 56 # Int32 | ID of the domain
$FolderID = 56 # Int32 | ID of the folder
$MemberID = 56 # Int32 | Member ID of the owner list
$SetMemberRequest = Initialize-SetMemberRequest -Permissions 0 # SetMemberRequest |
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
# setMember
try {
$Result = Set-GroAdminMember -DomainID $DomainID -FolderID $FolderID -MemberID $MemberID -SetMemberRequest $SetMemberRequest -XCsrfToken $XCsrfToken
} catch {
Write-Host ("Exception occurred when calling Set-GroAdminMember: {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 | |
FolderID | Int32 | ID of the folder | |
MemberID | Int32 | Member ID of the owner list | |
SetMemberRequest | SetMemberRequest | ||
XCsrfToken | String | CSRF Token | [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]