projects/:project_id/users/import
Adds users (project admin and project user) to a project. You can add up to 50 users per call. We recommend using this endpoint as an alternative to POST projects/:project_id/users.
To add users to an account (account user), see POST users.
You can specify the following details about the user:
- The user’s access level for the project (
admin
oruser
). - The company the user is assigned to for the project.
- The industry roles assigned to the user for the project.
- The user’s email address.
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) | POST https://developer.api.autodesk.com/hq/v2/accounts/:account_id/projects/:project_id/users/import |
Method and URI (Legacy) | POST https://developer.api.autodesk.com/hq/v2/regions/eu/accounts/:account_id/projects/:project_id/users/import |
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. |
Request
URI Parameters
account_id string | The account ID of the project. 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. |
Request
Body Structure
The POST body is an array of JSON objects with the following attributes:
email string | The user’s email address.
Note that you need to specify either an
email ,or a
user_id . However, you cannot specify both. |
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
user_id , see GET users.Note that you need to specify either a
user_id ,or an
email . However, you cannot specify both. |
services object | The services object (project administration).
|
project_administration object | The project administration object.
|
access_level enum:string | The BIM 360 access level to assign to the user for
the Project Administration service.
Note that a user must be assigned to at least one service (Document Management or Project Administration).
Possible value:
admin - can manage and configure the project. For example, adding users and activating services.Note that if you want to also grant access to BIM 360 Document Management, you need to add the user with
admin access(
services.document_management.access_level ). |
services object | The services object (document management).
|
document_management object | The document management object.
|
access_level enum:string | The BIM 360 access level to assign to the user for BIM 360 Document Management.
Note that a user must be assigned to at least one service (Document Management or Project Administration).
Possible values:
admin - can manage and configure the project’s documents.Note that if you assign
admin access to the user, you also need to assign admin access for the Project Administration service(
services.project_adminstration.access_level ).user - can access the project’s documents.Note that if you assign
admin access for the Project Administration service, you cannot assign user access for the Document Management service. |
company_id string | The ID of the company to assign to the user.
If the user was previously added as an account admin and assigned a default company, the user will automatically inherit the company if it is not specified.
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.
Note that if you do not want to assign any industry roles to the user, you need to add an empty array.
For a list of industry roles and industry role IDs, see
|
Response
HTTP Status Code Summary
201 Created | A new resource has been successfully created. |
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 (201)
A successful response returns a JSON object with the following attributes:
success int | The number of successfully created users.
|
failure int | The number of users that were not created
successfully.
|
success_items array:object | An array of data about the successfully created users.
|
user_id string | The user’s BIM 360 ID.
|
account_id string | The account ID.
|
project_id string | The project ID.
|
services object | |
document_management object | |
access_level enum:string | |
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
|
failure_items array:object | An array of data about the users that were not created successfully.
|
account_id string | The account ID.
|
project_id string | The project ID.
|
user_id string | The user’s BIM 360 ID.
|
services object | |
project_administration object | |
access_level enum:string | The access level assigned to the user for the Project Administration service. Possible value:
admin . |
document_management object | |
access_level enum:string | The access level assigned to the user for the Document Management service. Possible values:
admin , user . |
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
|
errors array:object | A list of errors for unsuccessfully created users.
|
message | |
code |
Example
Successfully Added Users (201)
Request
curl -v 'https://developer.api.autodesk.com/hq/v2/accounts/9dbb160e-b904-458b-bc5c-ed184687592d/projects/1e4bdc48-1bd7-4a4f-a91f-bd238cce5830/users/import' \
-X 'POST' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer hW0DvSvGgszPis1Yhot4c8kWW3NG' \
-d '[
{
"email": "john.doe@autodesk.com",
"services": {
"document_management": {
"access_level": "user"
}
},
"company_id": "dc9e8af9-2978-4f6a-90b6-b294ae11c701",
"industry_roles": [
"dc9e8af9-2978-4f6a-90b6-b294ae11c701"
]
},
{
"user_id": "3a2bs9ba-ba44-12ed-132d-fab8822bac22",
"services": {
"project_administration": {
"access_level": "admin"
},
"document_management": {
"access_level": "admin"
}
},
"company_id": "dc9e8af9-2978-4f6a-90b6-b294ae11c701",
"industry_roles": [
"dc9e8af9-2978-4f6a-90b6-b294ae11c701"
]
}
]'
Response
{
"success": 1,
"failure": 1,
"success_items": [
{
"user_id": "0b1fb8cc-cb14-44bc-991b-eda0862acd14",
"account_id": "68a12a11-f1ce-4abf-af85-601e8e97b551",
"project_id": "93a26902-e709-43e8-b865-4f216ecfa3ff",
"services": {
"document_management": {
"access_level": "user"
}
},
"company_id": "dc9e8af9-2978-4f6a-90b6-b294ae11c701",
"industry_roles": [
"dc9e8af9-2978-4f6a-90b6-b294ae11c701"
],
"email": "john.doe@autodesk.com"
}
],
"failure_items": [
{
"user_id": "3a2bs9ba-ba44-12ed-132d-fab8822bac22",
"account_id": "68a12a11-f1ce-4abf-af85-601e8e97b551",
"project_id": "93a26902-e709-43e8-b865-4f216ecfa3ff",
"services": {
"project_administration": {
"access_level": "admin"
},
"document_management": {
"access_level": "admin"
}
},
"company_id": "dc9e8af9-2978-4f6a-90b6-b294ae11c701",
"industry_roles": [
"dc9e8af9-2978-4f6a-90b6-b294ae11c701"
],
"email": "jill.doe@autodesk.com",
"errors": [
{
"message": "string",
"code": "error-code-1"
}
]
}
]
}