Get iModel Users - iModels

iModels

Download API definition:

GET https://api.bentley.com/imodels/{id}/users[?$top][&$skip][&$orderBy]

Retrieves a list of users who have ever been connected to the iModel specified by the iModel id.

Notes

The Prefer header can be used to specify how much result metadata is desired by the client. The Prefer request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.

This operation supports "return=representation" and "return=minimal" preferences.

The "return=representation" preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. The "return=minimal" preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if Prefer header is not specified.

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.

For more information please refer to Account Administrator documentation section on Access Control API documentation page.

Rate limits

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

Request

Request parameters

Yes

iModel id

$top

The $top query option requests the number of items in the queried collection to be included in the result. E.g. to return only first collection item provide the following query: $top=1. When $top parameter is not provided default is set to 100. $top value cannot exceed 1000.

$skip

The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. E.g. to return items from the collection starting at the third place provide the following query: $skip=2.

$orderBy

The $orderBy query option allows clients to request ascending using 'asc' or descending using 'desc' order of the returned collection by one or more item properties. Currently supported properties for Users are 'givenName' and 'surname'. When neither 'asc' or 'desc' keyword is specified the collection is sorted in ascending order. To sort the collection in descending order provide 'desc' keyword e.g.: $orderBy=givenName desc,surname desc

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Prefer

Indicates a level of details in the response. This operation supports 'return=representation' and 'return=minimal' preferences.

Response

Response 200 OK

json

{
    "users": [{
            "id": "c82f5963-a202-4452-9f11-33e0348952c6",
            "displayName": "hanson.deck@cohesivecompanies.com",
            "_links": {
                "self": {
                    "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/users/c82f5963-a202-4452-9f11-33e0348952c6"
                }
            }
        },
        {
            "id": "a1341373-c065-47b3-a6e3-e16be6bb6588",
            "displayName": "hans.down@cohesivecompanies.com",
            "_links": {
                "self": {
                    "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/users/a1341373-c065-47b3-a6e3-e16be6bb6588"
                }
            }
        }
    ],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/users?$skip=0&$top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/users?$skip=0&$top=100"
        },
        "next": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/users?$skip=100&$top=100"
        }
    }
}

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

Requested iModel is not available.

json

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

Response 422 Unprocessable Entity

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)

json

{
    "error": {
        "code": "InvalidiModelsRequest",
        "message": "Cannot get Users.",
        "details": [{
            "code": "InvalidValue",
            "message": "'-1' is not a valid '$skip' value. '$skip' must be a non-negative integer.",
            "target": "$skip"
        }]
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

User (summary)

Summarized representation of the user.

String

Id of the user.

displayName

String

Display name of the user. Corresponds to Email property.

_links

UserLinks

Contains the hyperlinks to the related data of the User.

json

{
    "type": "object",
    "title": "User (summary)",
    "description": "Summarized representation of the user.",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the user."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the user. Corresponds to Email property."
        },
        "_links": {
            "$ref": "#/components/schemas/UserLinks",
            "description": "Contains the hyperlinks to the related data of the User."
        }
    },
    "additionalProperties": false
}

User

Full representation of the user.

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.

String

E-mail address of the user.

statistics

UserStatistics

Contains usage statistics about the user.

_links

UserLinks

Contains the hyperlinks to the related data of the User.

json

{
    "type": "object",
    "description": "Full representation of the user.",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the user."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the user. Corresponds to Email property."
        },
        "givenName": {
            "type": "string",
            "description": "Given name of the user."
        },
        "surname": {
            "type": "string",
            "description": "Surname of the user."
        },
        "email": {
            "type": "string",
            "description": "E-mail address of the user."
        },
        "statistics": {
            "$ref": "#/components/schemas/UserStatistics",
            "description": "Contains usage statistics about the user."
        },
        "_links": {
            "$ref": "#/components/schemas/UserLinks",
            "description": "Contains the hyperlinks to the related data of the User."
        }
    },
    "additionalProperties": false
}

Users (prefer return=minimal)

List of users in minimal representation.

users

UserSummary[]

List of users who have ever been connected to the iModel.

_links

PagingLinks

Contains the hyperlinks to the previous and next pages of results.

json

{
    "type": "object",
    "title": "Users (prefer return=minimal)",
    "description": "List of users in minimal representation.",
    "properties": {
        "users": {
            "type": "array",
            "description": "List of users who have ever been connected to the iModel.",
            "items": {
                "$ref": "#/components/schemas/UserSummary"
            }
        },
        "_links": {
            "$ref": "#/components/schemas/PagingLinks",
            "description": "Contains the hyperlinks to the previous and next pages of results."
        }
    },
    "additionalProperties": false
}

Users (prefer return=representation)

List of users in full representation.

users

User[]

List of users who have ever been connected to the iModel.

_links

PagingLinks

Contains the hyperlinks to the previous and next pages of results.

json

{
    "type": "object",
    "title": "Users (prefer return=representation)",
    "description": "List of users in full representation.",
    "properties": {
        "users": {
            "type": "array",
            "description": "List of users who have ever been connected to the iModel.",
            "items": {
                "$ref": "#/components/schemas/User"
            }
        },
        "_links": {
            "$ref": "#/components/schemas/PagingLinks",
            "description": "Contains the hyperlinks to the previous and next pages of results."
        }
    },
    "additionalProperties": false
}

User Statistics

Statistics about the usage of an iModel from the user.

pushedChangesetsCount

Int32

Number of changesets pushed by the user.

lastChangesetPushDate

Date-time, null

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, null

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

briefcasesCount

Int32

Number of briefcases owned by the user.

json

{
    "type": "object",
    "title": "User Statistics",
    "description": "Statistics about the usage of an iModel from the user.",
    "properties": {
        "pushedChangesetsCount": {
            "type": "integer",
            "format": "int32",
            "description": "Number of changesets pushed by the user."
        },
        "lastChangesetPushDate": {
            "type": "string",
            "format": "date-time",
            "description": "Universal datetime value of the last time a changeset was pushed to the iModel by the user.",
            "nullable": true
        },
        "createdVersionsCount": {
            "type": "integer",
            "format": "int32",
            "description": "Number of named versions created by the user."
        },
        "lastAccessTime": {
            "type": "string",
            "format": "date-time",
            "description": "**DEPRECATED** Universal datetime value of the last time the iModel was accessed by the user.",
            "nullable": true
        },
        "briefcasesCount": {
            "type": "integer",
            "format": "int32",
            "description": "Number of briefcases owned by the user."
        }
    },
    "additionalProperties": false
}

User Links

Hyperlinks to User related data.

self

Link

Self hyperlink to get the details of the Changeset.

json

{
    "type": "object",
    "title": "User Links",
    "description": "Hyperlinks to User related data.",
    "properties": {
        "self": {
            "$ref": "#/components/schemas/Link",
            "description": "Self hyperlink to get the details of the Changeset."
        }
    },
    "additionalProperties": false
}

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

{
    "type": "object",
    "nullable": true,
    "description": "Hyperlink container.",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "additionalProperties": false
}

Paging Links

URLs for redoing the current request, getting to the previous or next page of results, if applicable.

self

Link

URL for redoing the current request.

Link

URL for getting the previous page of results.

Link

URL for getting the next page of results.

json

{
    "type": "object",
    "title": "Paging Links",
    "description": "URLs for redoing the current request, getting to the previous or next page of results, if applicable.",
    "properties": {
        "self": {
            "description": "URL for redoing the current request.",
            "$ref": "#/components/schemas/Link"
        },
        "prev": {
            "description": "URL for getting the previous page of results.",
            "$ref": "#/components/schemas/Link"
        },
        "next": {
            "description": "URL for getting the next page of results.",
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

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.

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "description": "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.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?