iTwins

iTwins

Download API definition:

POST https://sampleHostName/itwins/

Create a new iTwin.

The user that creates the iTwin will automatically be given the iTwin owner role on the iTwin. This will give that user full access to the iTwin, including the ability to create new child iTwins under the iTwin they are creating. After the iTwin is created, the iTwin owner role can be removed from the user or granted to other users.

Authentication

Requires Authorization header with valid Bearer token for scope itwins:modify.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Authorization

The user must have the itwins_create permission on the parent iTwin specified in the request. If there is no parent iTwin in the request then the user must have the itwins_create permission on the Account iTwin.

An Organization Administrator can create iTwins for their Organization.

Organization Administrators are power users for all iTwins owned by their organization. They will be able to create, modify or delete any iTwin. Example: tony.stark@starkindustries.com is an Organization Administrator that works for Stark Industries. Tony will be able to create iTwins and those iTwins will belong to Stark Industries. Tony and any other Organization Administrator for Stark Industries will be able to update or delete the iTwin. Any user (an employee of Stark Industries, or an external participant) can be invited to collaborate on the iTwin.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.


Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope itwins:modify

Accept
No

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

Request body

iTwin-create

Name
Type
Required?
Description
No data.

Response 201 Created

iTwin successfully created.

json

Response 401 Unauthorized

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

json

Response 403 Forbidden

json

Response 409 Conflict

iTwin with the same name already exists.

json

Response 422 Unprocessable Entity

Invalid request to create a iTwin. Review the 'Field Values' section near the top of this page.

json

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

Response headers

Name
Description
retry-after

The number of requests exceeds the rate-limit for the client subscription.