projects/:project_id/users
Add a project admin to a specific BIM 360 project and service type. We recommend using POST projects/:project_id/users/import (v2) for adding project admins and project users.
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/v1/accounts/:account_id/projects/:project_id/users |
Method and URI (Legacy) | POST https://developer.api.autodesk.com/hq/v1/regions/eu/accounts/:account_id/projects/:project_id/users |
Authentication Context | app only |
Required OAuth Scopes | account:write |
Data Formats | JSON |
Request
Headers
HTTP Headers | Type | Required | Description |
---|---|---|---|
Authorization | string | yes | Must be Bearer <token> , where <token> is obtained via a two-legged OAuth flow. |
Content-Type | string | yes | Must be application/json |
Region | string | no | 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: UUID | 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: 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. |
Request
Body Structure
The POST body is a flat JSON object with the following attributes:
role* string | The role of the user in the account.
Must be
project_admin , meaning that the user has Project administration privileges at a service level. |
service_type* enum: string | |
company_id* string: UUID | The user’s default company ID in BIM 360 |
company_name string | The name of the user’s default company name in BIM 360 |
email string | User’s email
Max length: 255
|
name string | Default display name
Max length: 255
|
nickname string | Nick name for user
Max length: 255
|
first_name string | User’s first name
Max length: 255
|
last_name string | User’s last name
Max length: 255
|
uid string | User’s Autodesk ID
|
image_url string | URL for user’s profile image
Max length: 255
|
address_line_1 string | User’s address line 1
Max length: 255
|
address_line_2 string | User’s address line 2
Max length: 255
|
city string | City in which user is located
Max length: 255
|
state_or_province enum: string | State or province in which user is located
Max length: 255
Note that the
state_or_province value depends on the selected country value;
see the valid values in the state_or_province list in
the Parameters guide. |
postal_code string | Postal code for the user’s location
Max length: 255
|
country enum: string | |
phone string | Contact phone number for the user
Max length: 255
|
company string | Company information from the Autodesk user profile
Max length: 255
Note that this is different from company in BIM 360.
|
job_title string | User’s job title
Max length: 255
|
industry string | Industry information for user
Max length: 255
|
about_me string | Short description about the user
Max length: 255
|
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 is the user (supplemented with some additional metadata), a flat JSON object with the following attributes:
id string: UUID | User ID |
account_id string: UUID | Account ID |
project_id string: UUID | Project ID |
role string | The role of the user in the account
Must be
project_admin , meaning that the user has Project administration privileges at a service level. |
status string | Status of the user in the system
Possible values:
active : user is active and has logged into the system sucessfullyinactive : user is disabledpending : user is invited and is yet to accept the invitation |
service_type enum: string | |
company_id string: UUID | The user’s default company ID in BIM 360 |
company_name string | The name of the user’s default company name in BIM 360 |
last_sign_in datetime: ISO 8601 | Timestamp of the last sign in, YYYY-MM-DDThh:mm:ss.sssZ format |
email string | User’s email
Max length: 255
|
name string | Default display name
Max length: 255
|
nickname string | Nick name for user
Max length: 255
|
first_name string | User’s first name
Max length: 255
|
last_name string | User’s last name
Max length: 255
|
uid string | User’s Autodesk ID
|
image_url string | URL for user’s profile image
Max length: 255
|
address_line_1 string | User’s address line 1
Max length: 255
|
address_line_2 string | User’s address line 2
Max length: 255
|
city string | City in which user is located
Max length: 255
|
state_or_province enum: string | State or province in which user is located
Max length: 255
Note that the
state_or_province value depends on the selected country value;
see the valid values in the state_or_province list in
the Parameters guide. |
postal_code string | Postal code for the user’s location
Max length: 255
|
country enum: string | |
phone string | Contact phone number for the user
Max length: 255
|
company string | Company information from the Autodesk user profile
Max length: 255
Note that this is different from company in BIM 360.
|
job_title string | User’s job title
Max length: 255
|
industry string | Industry information for user
Max length: 255
|
about_me string | Short description about the user
Max length: 255
|
updated_at datetime: ISO 8601 | Timestamp of the last change to the user, YYYY-MM-DDThh:mm:ss.sssZ format |
created_at datetime: ISO 8601 | Timestamp of the when the user was created, YYYY-MM-DDThh:mm:ss.sssZ format |
Example
Successful Addition of User as a Project Admin for the Field Service (201)
Request
curl -v 'https://developer.api.autodesk.com/hq/v1/accounts/9dbb160e-b904-458b-bc5c-ed184687592d/projects/1e4bdc48-1bd7-4a4f-a91f-bd238cce5830/users' \
-X 'POST' \
-H 'Content-Type: application/json'
-H 'Authorization: Bearer hW0DvSvGgszPis1Yhot4c8kWW3NG' \
-d '{
"service_type": "field",
"company_id":"14e95a5e-02eb-49aa-a39a-447d90544873",
"email":"john.smith@mail.com",
"nickname":"Johnny",
"first_name":"John",
"last_name":"Smith",
"role": "project_admin",
"image_url": "http://static-dc.autodesk.net/etc/designs/v201412151200/autodesk/adsk-design/images/autodesk_header_logo_140x23.png",
"address_line_1": "The Fifth Avenue",
"address_line_2": "#301",
"city": "New York",
"postal_code": "10011",
"state_or_province": "New York",
"country": "United States",
"phone": "(634)329-2353",
"company": "Autodesk",
"job_title": "Software Developer",
"industry": "IT",
"about_me": "Nothing here"
}'
Response
{
"id": "79b51334-1127-4313-a0e1-4986b3e96c47",
"account_id": "9dbb160e-b904-458b-bc5c-ed184687592d",
"service_type": "field",
"status": "pending",
"role": "project_admin",
"project_id": "1e4bdc48-1bd7-4a4f-a91f-bd238cce5830",
"company_id": "14e95a5e-02eb-49aa-a39a-447d90544873",
"company_name": "Autodesk",
"email": "john.smith@mail.com",
"name": "John Smith",
"nickname": "Johnny",
"first_name": "John",
"last_name": "Smith",
"uid": "L9EBJKCGCXBB",
"image_url": "http://static-dc.autodesk.net/etc/designs/v201412151200/autodesk/adsk-design/images/autodesk_header_logo_140x23.png",
"last_sign_in": null,
"address_line_1": "The Fifth Avenue",
"address_line_2": "#301",
"city": "New York",
"postal_code": "10011",
"state_or_province": "New York",
"country": "United States",
"phone": "(634)329-2353",
"company": "Autodesk",
"job_title": "Software Developer",
"industry": "IT",
"about_me": "Nothing",
"created_at": "2016-04-07T08:45:51.063Z",
"updated_at": "2016-04-07T09:21:06.173Z"
}