Projects

This API is deprecated. Please upgrade to the current version of this API as soon as possible.

Project Users

Download API definition:

GET https://api.bentley.com/projects/{id}/members[?$skip][&$top]

Retrieves a list of team members and their roles assigned to a specified 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:read.

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 be a project 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 wiki page.

Response

By default, each member in the returned list of members will only have names of the roles that are assigned to the user.

A full representation of roles assigned to the member can be returned by specifying the prefer header that includes a value of return=representation.

Request

Request parameters

template

Yes

The project ID

$skip

query

The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

$top

query

The $top system query option requests the number of items in the queried collection to be included in the result. Value must be less or equal to 100.

Request headers

Authorization

Yes

OAuth access token with scope projects:read

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

Response

Response 200 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 404 Not Found

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

json

Response 422 Unprocessable Entity

Invalid request to get project team members.

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

retry-after

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

Definitions

Team Member (role names)

TableSchema

userId

String

The user Id in Identity Management System.

String

User email.

givenName

String

User given name.

surname

String

User surname.

organization

String

Organization user is member of in Identity Management System.

roles

String[]

List of role names.

Team Member (full role representation)

TableSchema

userId

String

The user Id in Identity Management System.

String

User email.

givenName

String

User given name.

surname

String

User surname.

organization

String

Organization user is member of in Identity Management System.

roles

Role[]

List of roles.

Team Members (prefer return=minimal)

TableSchema

members

team-member[]

List of team members.

_links

Links

Team Members (prefer return=representation)

TableSchema

members

team-member-representation[]

List of team members.

_links

Links

Role

TableSchema

String

The role id.

displayName

String

The display name for the role.

description

String

The description for the role.

permissions

String[]

List of permissions assigned to the role.

Links

TableSchema

Link

Hyperlink container.

TableSchema

href

String

Hyperlink container.

Error

Contains error information and an optional array of more specific errors.

TableSchema

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String

The target of the error.

details

ErrorDetails[]

Optional array of more specific errors.

Error Details

Contains error information.

TableSchema

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String

The target of the error.

Error Response

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

TableSchema

error

Error

Error information.