itwins

---

Add an iTwin to the calling user's favorites list.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

The calling user must be a member of the specified iTwin. Use the [Access Control API](https://developer.bentley.com/apis/access-control/) to manage an iTwin's members.

---


add-itwin-to-my-favorites

OAuth access token with scope `itwins:modify`

Authorization

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

Accept

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.

application/json;InvalidAuthorizationScheme

The user has insufficient permissions for the requested operation.

This response indicates that specified iTwin was not found.

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

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

retry-after

---

Retrieves a list of favorite iTwins for the calling user.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwins:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

Any user can call this endpoint. It will only return iTwins that the user is a member of. Use the [Access Control API](https://developer.bentley.com/apis/access-control/) to manage an iTwin's members.

---


get-my-favorite-itwins

Specify a particular [subClass](https://developer.bentley.com/apis/itwins/overview/#itwinclassesandsubclasses) that you wish to query on.

subClass

Specify a particular status that you wish to query on.

status

Specify a particular type that you wish to query on.

type

The [$top](https://www.odata.org/getting-started/basic-tutorial/#topskip) system query option requests the number of items in the queried collection to be included in the result.

$top

The [$skip](https://www.odata.org/getting-started/basic-tutorial/#topskip) query option requests the number of items in the queried collection that are to be skipped and not included in the result.

$skip

Indicates a level of details in the response. Valid values are 'return=representation' or 'return=minimal'. The default is 'return=minimal'.

Prefer

OAuth access token with scope `itwins:read`

---

Remove an iTwin from the calling user's favorites list.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

The calling user must be a member of the specified iTwin. Use the [Access Control API](https://developer.bentley.com/apis/access-control/) to manage an iTwin's members.

---


remove-itwin-from-my-favorites

---

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](https://developer.bentley.com/apis/overview/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] (https://developer.bentley.com/apis/iTwins/overview/#account).

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] (https://developer.bentley.com/apis/access-control/operations/add-iTwin-members/) 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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---


create-itwin

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

---

Delete the specified iTwin.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization
Only an Organization Administrator can delete iTwins owned by 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] (https://developer.bentley.com/apis/access-control/operations/add-iTwin-members/) 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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---


delete-itwin

This response indicates that iTwin with specified ID was not found.

---

Gets the metadata of the specified iTwin.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwins:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

The calling user must be a member of the specified iTwin. Use the [Access Control API](https://developer.bentley.com/apis/access-control/) to manage an iTwin's members.

---


get-itwin

This response indicates that the specified iTwin was not found.

---

Gets the Account for the specified iTwin.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwins:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

The calling user must be a member of the specified iTwin. Use the [Access Control API](https://developer.bentley.com/apis/access-control/) to manage an iTwin's members.

---


get-itwin-account

iTwinId

---

Retrieves a list of iTwins that the calling user is a member of. 

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwins:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

Any user can call this endpoint. It will only return iTwins that the user is a member of. Use the [Access Control API](https://developer.bentley.com/apis/access-control/) to manage an iTwin's members.

---


get-my-itwins

Find all iTwins with the exact number specified. Cannot be used at the same time as the $search parameter.

number

Find all iTwins with the exact displayName specified. Cannot be used at the same time as the $search parameter.

displayName

Find all iTwins that are children of the specified parentId.

parentId

Find all iTwins that are owned by the specified iTwinAccountId.

iTwinAccountId

Find all iTwins that have the search string anywhere in the number or displayName. Cannot be used at the same time as the number or displayName parameters.

$search

---

Returns the primary Account for the calling user. 

When a user creates a new iTwin, it will be created in the primary Account unless specified otherwise.

If a user is associated with an Organization, that user will be able to query for any Account iTwin owned by their Organization. If the Organization has more than one Account then the MyPrimaryAccount endpoint will return only the primary Account for that Organization. Other Accounts can be queried using the [Get My iTwins](https://developer.bentley.com/apis/itwins/operations/get-my-itwins/) endpoint with the subClass=Account parameter.

If a user is not associated with an Organization, then a single Account iTwin will be created for the user. The MyPrimaryAccount endpoint will return that Account.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwins:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-my-primary-account

---

Update the specified iTwin.

For updates, all properties are optional. The request payload should only contain the properties that you would like to update. 

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization
The user must have the `itwins_modify` permission in order to modify iTwin properties.

An Organization Administrator can modify iTwins owned by 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] (https://developer.bentley.com/apis/access-control/operations/add-iTwin-members/) 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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---


update-itwin

A iTwin instance with the fields that should be updated.  ReadOnly fields should not be included.  

This response indicates that one of the associated entities could not be found.

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

---

Adds an iTwin to the calling User's recently used iTwins list. No more than 25 iTwins are stored in the recently used list. Older ones are removed to make room for new ones.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

The calling user must be a member of the specified iTwin. Use the [Access Control API](https://developer.bentley.com/apis/access-control/) to manage an iTwin's members.

---

add-itwin-to-my-recents

---

Retrieves a list of recently used iTwins for the calling user.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwins:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

Any user can call this endpoint. It will only return iTwins that the user is a member of. Use the [Access Control API](https://developer.bentley.com/apis/access-control/) to manage an iTwin's members.

---


get-my-recently-used-itwins

---

Create a new Repository URI.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization
The user must have the `itwins_modify` permission in order to add a repository URI to the iTwin.

An Organization Administrator can modify iTwins owned by their Organization. This includes adding a repository URI.

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] (https://developer.bentley.com/apis/access-control/operations/add-iTwin-members/) 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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---


create-repository

This response indicates that the specified repository was not found.

---

Delete the specified Repository URI.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization
The user must have the `itwins_modify` permission in order to remove a repository URI from the iTwin.

An Organization Administrator can modify iTwins owned by their Organization. This includes deleting a repository URI.

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] (https://developer.bentley.com/apis/access-control/operations/add-iTwin-members/) 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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---


delete-repository

repositoryId

---

Gets the details of the specified repository.  Please note that the only class that has a subClass is `GeographicInformationSystem`.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwins:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns the specified iTwin Repository or be an iTwin team member.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---


get-repositories-by-itwin-id

Specify a particular class that you wish to query on.

class

Specify a particular subClass that you wish to query on (NOTE:  Only the 'GeographicInformationSystem' class can have a subClass).

iTwins

Authentication

Authorization

Request

Request headers

Request body

Example

Response

Response 201 Created

Response 401 Unauthorized

Response 403 Forbidden

Response 409 Conflict

Response 422 Unprocessable Entity

Response 429 Too many requests