Function
Adds or removes shared directory members in batches.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
| Action | Access Level | Resource Type (*: required) | Condition Key | Alias | Dependencies |
| workspace:storage:updateShareFolderAssignment | Write | storage * | - | - | - |
URI
POST /v1/{project_id}/persistent-storages/{storage_id}/actions/assign-share-folder
Table 1 Path Parameters | Parameter | Mandatory | Type | Description |
| project_id | Yes | String | Project ID. |
| storage_id | Yes | String | WKS storage ID. |
Request Parameters
Table 3 Request body parameters | Parameter | Mandatory | Type | Description |
| storage_claim_id | Yes | String | Workspace storage directory declaration ID. |
| add_items | No | Array of Assignment objects | List of added members. |
| del_items | No | Array of Attachment objects | List of removed members |
Table 4 Assignment | Parameter | Mandatory | Type | Description |
| policy_statement_id | Yes | String | Policy ID. |
| attach | Yes | String | Target. |
| attach_type | Yes | String | Associated object type. USER: user USER_GROUP: user group |
Table 5 Attachment | Parameter | Mandatory | Type | Description |
| attach | Yes | String | Objective. |
| attach_type | Yes | String | Associated object type. USER: user USER_GROUP: user group |
Response Parameters
Status code: 200
Response to a successful request.
Status code: 400
Table 6 Response body parameters | Parameter | Type | Description |
| error_code | String | Error code, which is returned upon failure. |
| error_msg | String | Error message. |
Status code: 401
Table 7 Response body parameters | Parameter | Type | Description |
| error_code | String | Error code, which is returned upon failure. |
| error_msg | String | Error message. |
Status code: 403
Table 8 Response body parameters | Parameter | Type | Description |
| error_code | String | Error code, which is returned upon failure. |
| error_msg | String | Error message. |
Status code: 404
Table 9 Response body parameters | Parameter | Type | Description |
| error_code | String | Error code, which is returned upon failure. |
| error_msg | String | Error message. |
Status code: 405
Table 10 Response body parameters | Parameter | Type | Description |
| error_code | String | Error code, which is returned upon failure. |
| error_msg | String | Error message. |
Status code: 500
Table 11 Response body parameters | Parameter | Type | Description |
| error_code | String | Error code, which is returned upon failure. |
| error_msg | String | Error message. |
Status code: 503
Table 12 Response body parameters | Parameter | Type | Description |
| error_code | String | Error code, which is returned upon failure. |
| error_msg | String | Error message. |
Example Requests
POST /v1/a4da8115c9d8464ead3a38309130523f/persistent-storages/544959151881584640/actions/assign-share-folder
{
"storage_claim_id" : 544959151881584640,
"add_items" : [ {
"attach" : "USER001***@local.com",
"attach_type" : "USER",
"policy_statement_id" : 1
} ],
"del_items" : [ {
"attach" : "USER001***@local.com",
"attach_type" : "USER"
} ]
} Example Responses
Status code: 200
Response to a successful request.
null
Status Codes
| Status Code | Description |
| 200 | Response to a successful request. |
| 400 | The request cannot be understood by the server due to malformed syntax. |
| 401 | Authentication failed. |
| 403 | Permissions required. |
| 404 | No resources found. |
| 405 | The request method is not allowed. |
| 500 | An internal service error occurred. For details, see the error code description. |
| 503 | Service unavailable. |
