Project Users
PATCH
projects/:project_id/users/:user_id
Updates a user’s profile for a project, including:
- The company the user is assigned to for the project.
- The industry roles assigned to the user for the project.
Note that this endpoint is version 2 (v2) - you need to use ../v2/.. in the URI.
Note that this endpoint is ONLY compatible with BIM 360 projects. It is not compatible with Autodesk Construction Cloud (ACC) projects. For more information about compatibility between between BIM 360 and ACC, see the Compatibility section.
Resource Information
| Method and URI (US) | PATCH https://developer.api.autodesk.com/hq/v2/accounts/:account_id/projects/:project_id/users/:user_id |
| Method and URI (Legacy) | PATCH https://developer.api.autodesk.com/hq/v2/regions/eu/accounts/:account_id/projects/:project_id/users/:user_id |
| Authentication Context | user context required |
| Required OAuth Scopes | account:write |
| Data Formats | JSON |
Request
Headers
| Authorization* string | Must be
Bearer <token>, where <token> is obtained via either a two-legged or three-legged OAuth flow.Note that it will not accept a two-legged token, unless you add the
x-user-id header. |
| 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.
The user’s BIM 360 ID. A user is assigned a BIM 360 ID (
id) for all BIM 360 accounts and projects. To verify the ID, call GET users.Note that the user must either be an account admin of the account or a project admin of the project.
|
| Content-Type* string | Must be application/json. |
| Region string | Specifies the region where the service is located. | Possible values:
US, EMEA. For the full list of supported regions, see the Regions page. |
* Required
Request
URI Parameters
| account_id string | The account ID of the user. This corresponds to hub ID in the Data Management API. To convert a hub ID into an account ID you need to remove the “b." prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9. |
| project_id string | 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. |
| user_id string | The user’s BIM 360 ID. A user is assigned a BIM 360 ID (id) for all BIM 360 accounts and projects. To verify the ID, call GET users. |
Request
Body Structure
The PATCH body is a JSON object with the following attributes:
| company_id string | The ID of the company to assign to the user.
To delete the company, use an empty value.
For a list of companies for the account, see
|
| industry_roles array:string | The IDs of industry roles to assign to the user for the project.
To remove a user’s industry roles, use an empty array.
For a list of industry roles and industry role IDs, see
|
Response
HTTP Status Code Summary
| 200 OK | The request has succeeded. |
| 400 Bad Request | The request could not be understood by the server due to malformed syntax. |
| 403 Forbidden | Unauthorized |
| 404 Not Found | The resource cannot be found. |
| 409 Conflict | The request could not be completed due to a conflict with the current state of the resource. |
| 422 Unprocessable Entity | The request was unable to be followed due to restrictions. |
| 500 Internal Server Error | An unexpected error occurred on the server. |
Response
Body Structure (200)
A successful response returns a JSON object with the following attributes:
| user_id string | The user’s BIM 360 ID.
|
| account_id string | The account ID.
|
| project_id string | The project ID.
|
| company_id string | The ID of the company assigned to the user.
For a list of companies for the account, see
|
| industry_roles array:string | The IDs of the industry roles assigned to the user for the project. For a list of industry roles for the project, see
|
Example
User’s Profile Successfully Updated (200)
Request
curl -v 'https://developer.api.autodesk.com/hq/v2/accounts/9dbb160e-b904-458b-bc5c-ed184687592d/users/a75e8769-621e-40b6-a524-0cffdd2f784e' \
-X 'PATCH' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer XZvCJNhdxESsBRIH28MfLf2hKL5O' \
-d '{
"company_id": "dc9e8af9-2978-4f6a-90b6-b294ae11c701",
"industry_roles": [
"dc9e8af9-2978-4f6a-90b6-b294ae11c701"
]
}'
Show More
Response
{
"user_id": "0b1fb8cc-cb14-44bc-991b-eda0862acd14",
"account_id": "68a12a11-f1ce-4abf-af85-601e8e97b551",
"project_id": "93a26902-e709-43e8-b865-4f216ecfa3ff",
"company_id": "dc9e8af9-2978-4f6a-90b6-b294ae11c701",
"industry_roles": [
"dc9e8af9-2978-4f6a-90b6-b294ae11c701"
],
"email": "john.doe@autodesk.com"
}
Show More