Skip to navigation
API ReferenceHub AdminProject Users

Batch invite users to projects

View as Markdown

Proposed - Adds multiple users to multiple projects at once. The calling user must be a hub administrator.

A maximum of 100 project invites across all users is allowed. For example, if 10 users are invited to 10 projects each, which generates a total of 100 project invites, then the request will be accepted. But if in addition 1 more user is invited to 1 more project, which generates a total of 101 project invites, the request will be rejected as the limit is 100 project invites.

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

accountIdstringRequiredformat: "uuid"

The ID of the hub that contains the projects. This corresponds to the hub ID used in the Data Management API, with the “b.” prefix removed. For example, b.c8b0c73d-3ae9 becomes c8b0c73d-3ae9.

Headers

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

Specifies the region where your request should be routed. If not set, the request is routed automatically, which may result in a slight increase in latency.

Possible values: US, EMEA. For a complete list of supported regions, see the Regions page.

User-IdstringOptionalformat: "uuidOrAutodeskId"

The ID of a user on whose behalf your request is acting.

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).

Note that this header is required for hub Admin POST, PATCH, and DELETE endpoints if you want to use a 2-legged authentication context. This header is optional for hub Admin GET endpoints.

Request

The data of users to batch invite.
userslist of objectsOptional
User data to batch invite.

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