Table of contents
Users
Download API definition:
GET https://api.bentley.com/users/?$search

Search for users by name or email. The search string is required and must be between 3 and 200 characters. Paging is not supported and it will not return more than 1000 users.

This API will only return metadata for users that are in the same organization as the caller.

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.

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
$search
query
Yes

Find all users that have the search string anywhere in the name or email. Must be between 3 and 200 characters.

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

Accept
Yes

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

Response 200 OK

OK

json
{
    "users": [{
            "id": "e7aee7b1-4967-4f40-b220-0b1dc12c4542",
            "email": "John.Smith@example.com",
            "givenName": "John",
            "surname": "Smith",
            "organizationName": "Example Organization"
        },
        {
            "id": "30af8cae-cd6b-4c5f-a984-5a03710db06e",
            "email": "Jane.Smith@example.com",
            "givenName": "Jane",
            "surname": "Smith",
            "organizationName": "Example Organization"
        }
    ]
}

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 422 Unprocessable Entity

Invalid request to get users

json
{
    "error": {
        "code": "InvalidUsersRequest",
        "message": "Cannot query users.",
        "details": [{
                "code": "MissingRequiredParameter",
                "message": "A search value was not specified.",
                "target": "$search"
            },
            {
                "code": "InvalidValue",
                "message": "The search value must be between 3 and 200 characters.",
                "target": "$search"
            }
        ]
    }
}

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

TableSchema
Name
Type
Description
id
String
email
String
givenName
String
surname
String
organizationName
String

Users

User Search Results

TableSchema
Name
Type
Description
users

A list of users.

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.