diff --git a/powershell/README.md b/powershell/README.md index bf4da9f..df1eb97 100644 --- a/powershell/README.md +++ b/powershell/README.md @@ -61,6 +61,24 @@ Get-ConfideShareCenterUserImportTask -Id $taskId ``` This will return the current status of the user import process. +### 4. [**Add-ConfideShareCenterUserUpdateTask**](docs/ConfideShareSettingApi.md#add-confidesharecenteruserupdatetask) +Updates sharing users' permissions from a CSV file in a Confide project. You can find the template for the CSV file in the `templates` folder. + +```powershell +# Example: Update users permissions +$taskId = Add-ConfideShareCenterUserUpdateTask -CsvPath "C:\path\to\your\Update_User_Template.csv" +``` +This command will return a task ID that you can use to track the update status. + +### 5. [**Get-ConfideShareCenterUserUpdateTask**](docs/ConfideShareSettingApi.md#get-confidesharecenteruserupdatetask) +After submitting an update task, you can check its status using the task ID. + +```powershell +# Example: Check the status of an update task +Get-ConfideShareCenterUserUpdateTask -Id $taskId +``` +This will return the current status of the user update process. + ## Documentation for Cmdlets For more details on the available cmdlets, please refer to the [**documentation**](docs/ConfideShareSettingApi.md). diff --git a/powershell/docs/ConfideApi.md b/powershell/docs/ConfideApi.md index 1cf6e15..1e289c9 100644 --- a/powershell/docs/ConfideApi.md +++ b/powershell/docs/ConfideApi.md @@ -4,7 +4,9 @@ Method | Description ------------- | ------------- [**Connect-Confide**](ConfideConnectApi.md#connect-confide) | Connect to Confide API with client credentials or certificate. [**Disconnect-Confide**](ConfideConnectApi.md#disconnect-confide) | Disconnect from Confide API. -[**Add-ConfideShareCenterUserImportTask**](ConfideShareSettingApi.md#add-confidesharecenteruserimporttask) | Import sharing users from CSV file and create an import task. +[**Add-ConfideShareCenterUserImportTask**](ConfideShareSettingApi.md#add-confidesharecenteruserimporttask) | Import sharing users from a CSV file and create an import task. [**Get-ConfideShareCenterUserImportTask**](ConfideShareSettingApi.md#get-confidesharecenteruserimporttask) | Get the status of a Confide Share Center user import task. +[**Add-ConfideShareCenterUserUpdateTask**](ConfideShareSettingApi.md#add-confidesharecenteruserupdatetask) | Update sharing users' permissions from a CSV file and create an update task. +[**Get-ConfideShareCenterUserUpdateTask**](ConfideShareSettingApi.md#get-confidesharecenteruserupdatetask) | Get the status of a Confide Share Center user update task. [[Back to top]](#) [[Back to README]](../README.md) diff --git a/powershell/docs/ConfideShareSettingApi.md b/powershell/docs/ConfideShareSettingApi.md index 4f3df89..16b7df2 100644 --- a/powershell/docs/ConfideShareSettingApi.md +++ b/powershell/docs/ConfideShareSettingApi.md @@ -5,7 +5,8 @@ Method | Description ------------- | ------------- [**Add-ConfideShareCenterUserImportTask**](ConfideShareSettingApi.md#add-confidesharecenteruserimporttask) | Import sharing users and assign permissions from a CSV file. | [**Get-ConfideShareCenterUserImportTask**](ConfideShareSettingApi.md#get-confidesharecenteruserimporttask) | Get the status of a user import task. | - +[**Add-ConfideShareCenterUserUpdateTask**](ConfideShareSettingApi.md#add-confidesharecenteruserupdatetask) | Update sharing users permissions from a CSV file. | +[**Get-ConfideShareCenterUserUpdateTask**](ConfideShareSettingApi.md#get-confidesharecenteruserupdatetask) | Get the status of a user update task. | # **Add-ConfideShareCenterUserImportTask** @@ -58,3 +59,56 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](ConfideApi.md) [[Back to README]](../README.md) + + + +# **Add-ConfideShareCenterUserUpdateTask** +> CloudSdkDataVdrUserExecuteResult Add-ConfideShareCenterUserUpdateTask
+>         [-CsvPath]
+ +Update sharing users' permissions from a CSV file. + +### Example +```powershell +$result = Add-ConfideShareCenterUserUpdateTask -CsvPath "C:\path\to\your\Update_User_Template.csv" +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Path** | **String**| The file path of the CSV file for updating sharing user permissions. | + +### Return type + +**string** + + + +[[Back to top]](#) [[Back to API list]](ConfideApi.md) [[Back to README]](../README.md) + + +# **Get-ConfideShareCenterUserUpdateTask** +> CloudSdkDataVdrUpdateStatus Get-ConfideShareCenterUserUpdateTask
+>         [-Id]
+ +Get the status of a user update task. + +### Example +```powershell +$status = Get-ConfideShareCenterUserUpdateTask -Id "your_task_id" +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | **String**| The Id of the update task. | + + +### Return type + +[**ImportUserResponseModel**](ImportUserResponseModel.md) (PSCustomObject) + + +[[Back to top]](#) [[Back to API list]](ConfideApi.md) [[Back to README]](../README.md) \ No newline at end of file diff --git a/powershell/templates/Update_User_Template.csv b/powershell/templates/Update_User_Template.csv new file mode 100644 index 0000000..0241381 --- /dev/null +++ b/powershell/templates/Update_User_Template.csv @@ -0,0 +1,2 @@ +Email address,Manage and share objects in share center,Generate anonymous download link in share center,Generate anonymous upload link in share center,Generate anonymous download link in project,Generate anonymous upload link in project,Generate secure access link in share center,Generate secure access link in project,Skip anti-virus scan for files greater than 2 GB +user@contoso.onmicrosoft.com,Yes,No,No,No,No,No,No,No