Skip to navigation
API ReferenceHub AdminProject Users

Import project users

View as Markdown

Adds multiple users to a project at once. Can add up to 200 users per request.

Note that the Authorization header token can be obtained either via a three-legged OAuth flow, or via a two-legged Oauth flow with user impersonation, for which the User-Id header is required.

Note: This operation is not backward compatible with BIM 360 projects. It only works with Autodesk Construction Cloud projects.

Authentication

AuthorizationBearer

OAuth 2.0 (2-legged) — application context required.

Client Credentials Flow

Token URL: https://developer.api.autodesk.com/authentication/v2/token

Scopes:

  • account:read — read account and project data
  • account:write — modify account and project data
  • data:read — read data the application can access
OR
AuthorizationBearer

OAuth 2.0 (2-legged with impersonation) — application context with user impersonation required. Send a User-Id header identifying the member to act on behalf of; the token authorizes the application, while the operation is evaluated against that member’s project permissions.

Client Credentials Flow

Token URL: https://developer.api.autodesk.com/authentication/v2/token

Scopes:

  • account:read — read account and project data
  • account:write — modify account and project data
OR
AuthorizationBearer

OAuth 2.0 (3-legged) — user context required. Also accepts a Secure Service Account (SSA) token, which is headless like a two-legged flow but classified as three-legged because it preserves user context.

Authorization Code Flow

Authorization URL: https://developer.api.autodesk.com/authentication/v2/authorize

Token URL: https://developer.api.autodesk.com/authentication/v2/token

Refresh URL: https://developer.api.autodesk.com/authentication/v2/token

Scopes:

  • data:read — read your data
  • account:read — read account and project data
  • account:write — modify account and project data

Path parameters

projectIdstringRequiredformat: "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 Forma 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.

Headers

Accept-LanguagestringOptionalDefaults to en
This header is not currently supported in the Hub Admin API.
RegionstringOptional

The region that the data is stored in. For a full list of supported regions, please check here.

User-IdstringOptionalformat: "uuidOrAutodeskId"

Note that this header is not relevant for Hub Admin GET endpoints.

The ID of a user on whose behalf your API request is acting. Required if you’re using a 2-legged authentication context, which must be 2-legged OAuth2 security with user impersonation.

Your app has access to all users specified by the administrator in the SaaS integrations UI. Provide this header value to identify the user to be affected by the request.

You can use either the user’s Forma ID (id), or their Autodesk ID (autodeskId).

Request

The users to add to the project and their associated data.
userslist of objectsOptional
User data to import.
suppressAutodeskEmailsbooleanOptionalDefaults to false
Suppresses all emails from Autodesk to the invited users. Defaults to false.
suppressAdministrativeEmailsbooleanOptionalDefaults to false

Controls whether project invitation emails are sent to the invited users.

true: prevents project invitation emails from being sent to users.

false: (default) send project invitation emails to the invited users.

Response headers

RateLimit-Remaininginteger

The number of requests remaining in the current rate-limit window.

RateLimit-Valueinteger
The maximum number of requests that the server is willing to accept during the current full minute
Request-IdstringOptional
A unique ID for the request which can be provided when reporting issues to assist in facilitating improved research.
Response-TimestringOptional
The time taken to generate the response.

Response

The request has been received but not yet acted upon.
jobIdstringOptionalformat: "uuid"

We don’t currently support this field, but expect to in a future release.

If the response returns jobId with a valid UUID value, the user import operation was successful.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
410
Gone Error
412
Precondition Failed Error
415
Unsupported Media Type Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error