Skip to navigation
API ReferenceHub AdminProject Roles

Sync project roles

View as Markdown
Retrieves the project roles to be synced with the mobile client

Authentication

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.

Request

Optional. A sync is initiated by calling the sync endpoint without a token. Pass in the sync token from a previous call to sync to get more data.
syncTokenstringOptionalformat: "string"
Opaque, base64 encoded token that has all relevant information to sync the project roles.

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 project roles to be synced (added/removed) from the device

currentobjectOptional
deletedobjectOptional
moreDatabooleanOptional
Indicating whether or not there is currently more data that would be retrieved by a subsequent request using the "nextSyncToken".
nextSyncTokenstringOptional
The URI encoded sync token to be used for the next request to this endpoint.
overwritebooleanOptional
When true, indicates that the client should delete all local data models of the given collection type on a project. When true, the values returned are the same values as a fresh sync with no sync token.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
410
Gone Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error