Get users - Users | iTwin Platform

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

$search

Yes

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

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

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"
        }
    ]
}

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

String

givenName

String

surname

String

organizationName

String

json

{
    "type": "object",
    "title": "User",
    "properties": {
        "id": {
            "type": "string"
        },
        "email": {
            "type": "string"
        },
        "givenName": {
            "type": "string"
        },
        "surname": {
            "type": "string"
        },
        "organizationName": {
            "type": "string"
        }
    },
    "additionalProperties": false
}

Users

User Search Results

users

userMinimal[]

A list of users.

json

{
    "type": "object",
    "title": "Users",
    "description": "User Search Results",
    "properties": {
        "users": {
            "type": "array",
            "description": "A list of users.",
            "items": {
                "$ref": "#/components/schemas/userMinimal"
            }
        }
    },
    "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?