Projects

Project Roles

Download API definition:

PATCH https://sampleHostName/projects/{id}/roles/{roleId}

Update the specified project role.

Notes

To assign permissions to a role PATCH body MUST include an array of permissions. If a user is not Organization Administrator permissions that could be assigned to the role are limited to permissions the user has on a project.

This API is being deprecated

This API is being superseded by the iTwins API and the Access Control API. Please consider transitioning your software to the iTwins API.

With any questions, please first consult the iTwins API FAQ. If your question isn't answered there, please use our Community Support Channels to contact our developers.

Authentication

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

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

Authorization

User must be an Organization Administrator for the Organization that owns a given Project or have administration_manage_roles permission assigned at the Project level.

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 parameters

Name
In
Required?
Description
id
template
Yes

The project ID

roleId
template
Yes

Project role ID

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope projects:modify

Accept
No

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

A project role instance with the fields that should be updated.

Request body

role-update

Name
Type
Required?
Description
No data.

Response 200 OK

OK

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

The user has insufficient permissions for the requested operation.

json

Response 404 Not Found

This response indicates that project or role with specified ID was not found.

json

Response 422 Unprocessable Entity

Invalid request to create new project role. Request payload might be missing some of the required properties.

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.