Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions powershell/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
4 changes: 3 additions & 1 deletion powershell/docs/ConfideApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
56 changes: 55 additions & 1 deletion powershell/docs/ConfideShareSettingApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

<a id="Add-ConfideShareCenterUserImportTask"></a>
# **Add-ConfideShareCenterUserImportTask**
Expand Down Expand Up @@ -58,3 +59,56 @@ Name | Type | Description | Notes


[[Back to top]](#) [[Back to API list]](ConfideApi.md) [[Back to README]](../README.md)


<a id="Add-ConfideShareCenterUserUpdateTask"></a>
# **Add-ConfideShareCenterUserUpdateTask**
> CloudSdkDataVdrUserExecuteResult Add-ConfideShareCenterUserUpdateTask<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-CsvPath] <String><br>

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)

<a id="Get-ConfideShareCenterUserUpdateTask"></a>
# **Get-ConfideShareCenterUserUpdateTask**
> CloudSdkDataVdrUpdateStatus Get-ConfideShareCenterUserUpdateTask<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Id] <String><br>

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)
2 changes: 2 additions & 0 deletions powershell/templates/Update_User_Template.csv
Original file line number Diff line number Diff line change
@@ -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