projects/{project_id}/folders/{folder_id}/permissions:batch-update
Updates the permissions assigned to multiple users, roles, and companies for a folder. This endpoint replaces the permissions that were previously assigned to the user for this folder.
For more information about folder permissions, see the BIM 360 Help documentation or the ACC Files Help documentation.
For details about updating a user’s permissions, see the Update a User’s Folder Permissions tutorial.
Note that if the user has not been assigned any permissions for the folder, you need to use the Assign permissions endpoint.
If you are calling this endpoint on behalf of a user, the user needs to have CONTROL permissions for the folder.
Resource Information
| Method and URI | POST https://developer.api.autodesk.com/bim360/docs/v1/projects/:project_id/folders/:folder_id/permissions:batch-update |
| Authentication Context | user context optional |
| Required OAuth Scopes | data:write |
| Data Format | JSON |
Request
Headers
| Authorization* string | Must be Bearer <token>, where <token> is obtained via either a two-legged or three-legged OAuth flow. |
| Content-Type* string | Must be application/json |
| x-user-id string | In a two-legged authentication context, the app has access to all users specified by the administrator in the SaaS integrations UI. By providing this header, the API call will be limited to act on behalf of only the user specified. |
Request
URI Parameters
| project_id string: UUID | The ID of the project. This corresponds to project ID in the Data Management API. To convert a project ID in the Data Management API into a project ID in the BIM 360 API you need to remove the “b." prefix. For example, a project ID of b.a4be0c34a-4ab7 translates to a project ID of a4be0c34a-4ab7. |
| folder_id string | The ID (URN) of the folder.
For details about how to find the URN, follow the initial steps (1-3) in the Download Files tutorial. |
Request
Body Structure
A list of permission items to update in this folder.
| subjectId* string: UUID | The ID of the user, role, or company. To verify the subjectId of the user, role, or company, use GET permissions. |
| autodeskId string | The Autodesk ID of the user, role or company. |
| subjectType* enum:string | The type of subject.
Possible values: USER, COMPANY, ROLE |
| actions* array: string | Permitted actions for the user, role, or company.
The permission action group is different in BIM 360 Document Management and ACC Build Files.
See the BIM 360 Help documentation or the ACC Files Help documentation for more details about each permission level. Note that the full set of permissions assigned to the user, role, or company is a combination of |
Response
HTTP Status Code Summary
| 200 OK | Successfully updated permissions |
| 400 Bad Request | Operation failed because of bad input. For example, an incompatible subjectId and subjectType. |
| 403 Forbidden | The user does not have permission to perform this operation. |
| 404 Not Found | The project or folder does not exist |
| 422 Unprocessable Entity | The payload contains unprocessable data |
| 429 Too Many Requests | The server has received too many requests. |
| 500 Internal Server Error | Operation failed because of an internal server error |
Response
Body Structure (200)
| results array: object | The results object. |
| subjectId string: UUID | The ID of the user, role, or company. For example, this corresponds to the id, roleId, or companyId in the response for GET /users/user_id. |
| subjectType enum:string | The type of subject.
Possible values: USER, COMPANY, ROLE |
| actions array: string | Permitted actions for the user, role, or company.
The permission action group is different in BIM 360 Document Management and ACC Build Files.
See the BIM 360 Help documentation or the ACC Files Help documentation for more details about each permission level. Note that the full set of permissions assigned to the user, role, or company is a combination of |
Example
Successfully updated permissions
Request
curl -v 'https://developer.api.autodesk.com/bim360/docs/v1/projects/c0337487-5b66-422b-a284-c273b424af54/folders/urn:adsk.wipprod:fs.folder:co.9g7HeA2wRqOxLlgLJ40UGQ/permissions:batch-update' \
-X 'POST' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '[
{
"subjectId": "684c4e47-7720-4961-b0e9-ff5966d82edb",
"autodeskId": "45GPJ4KAX789",
"subjectType": "USER",
"actions": [
"PUBLISH"
]
}
]'
Response
{
"results": [
{
"subjectId": "684c4e47-7720-4961-b0e9-ff5966d82edb",
"subjectType": "USER",
"actions": [
"PUBLISH"
]
}
]
}