Table of contents
iModels
Download API definition:
GET https://api.bentley.com/imodels/{id}/users/{userId}

Retrieves the details about the user.

Authentication

Requires Authorization header with valid Bearer token for scope itwin-platform.

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

Authorization

User must have imodels_webview permission assigned at the iModel level. If iModel Role permissions at the iModel level are configured, then user must additionally have at least imodels_webview permission assigned at the iTwin level. If permissions at the iModel level are not configured, then user must have imodels_webview permission assigned at the iTwin level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given iTwin the iModel belongs to.

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.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

Request parameters

Name
In
Required?
Description
id
template
Yes

iModel id

userId
template
Yes

User id

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

Accept
Yes

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

Response 200 OK

OK

json
{
    "user": {
        "id": "ea4dfb9f-7f66-4c6f-82c5-0efad1636a1f",
        "displayName": "hanson.deck@cohesivecompanies.com",
        "givenName": "Hanson",
        "surname": "Deck",
        "email": "hanson.deck@cohesivecompanies.com",
        "statistics": {
            "pushedChangesetsCount": 16,
            "lastChangesetPushDate": "2023-03-01T09:21:38.7900000Z",
            "createdVersionsCount": 1,
            "lastAccessTime": "2023-03-01T15:01:30.0000000Z"
        },
        "_links": {
            "self": {
                "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/users/ea4dfb9f-7f66-4c6f-82c5-0efad1636a1f"
            }
        }
    }
}

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
{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 404 Not Found

Specified iModel or user was not found.

json
{
    "error": {
        "code": "iModelNotFound",
        "message": "Requested iModel is not available."
    }
}

Response 429 Too many requests

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

json
{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

Name
Description
retry-after

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

User Response

Container for user object.

TableSchema
Name
Type
Description
user

User properties.

User

Full representation of the user.

TableSchema
Name
Type
Description
id
String

Id of the user.

displayName
String

Display name of the user. Corresponds to Email property.

givenName
String

Given name of the user.

surname
String

Surname of the user.

email
String

E-mail address of the user.

statistics

Contains usage statistics about the user.

_links

Contains the hyperlinks to the related data of the User.

User Statistics

Statistics about the usage of an iModel from the user.

TableSchema
Name
Type
Description
pushedChangesetCount
Int32

Number of changesets pushed by the user.

lastChangesetPushDate
Date-time

Universal datetime value of the last time a changeset was pushed to the iModel by the user.

createdVersionsCount
Int32

Number of named versions created by the user.

lastAccesstime
Date-time

Universal datetime value of the last time the iModel was accessed by the user.

User Links

Hyperlinks to User related data.

TableSchema
Name
Type
Description
self

Self hyperlink to get the details of the Changeset.

Link

Hyperlink container.

TableSchema
Name
Type
Description
href
String

Hyperlink to the specific entity.

Error

Contains error information.

TableSchema
Name
Type
Description
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
Name
Type
Description
error

Error information.