Get users by id list - Users

REST API Overview

Overview

Samples

Reference

Changelog

Users

Download API definition:

Get users by id list

POST https://api.bentley.com/users/getbyidlist

This API allows you to pass a list of user ids and get back the user metadata for each one. It is implemented as a POST so that the ids can be specified in the body instead of the url. This allows you to specify up to 1000 user ids.

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

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

UsersIds

Example

json

[
    "e7aee7b1-4967-4f40-b220-0b1dc12c4542",
    "30af8cae-cd6b-4c5f-a984-5a03710db06e"
]

Response

Response 200 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": "InvalidValue",
            "message": "The request body cannot contain more than 1000 user Ids.",
            "target": "request"
        }]
    }
}

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

retry-after

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

Definitions

User

TableSchema

String

givenName

String

surname

String

organizationName

String

Users

User Search Results

TableSchema

users

userMinimal[]

A list of users.

UsersIds

User Ids to query

TableSchema

No data.

Error

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.