Table of contents
Synchronization

Authorization

Download API definition:

GET https://api.bentley.com/synchronization/imodels/connections/authorizationinformation[?redirectUrl]

Retrieves the calling user's AuthorizationInformation.

Authentication

Requires Authorization header with valid Bearer token for scope synchronization:read or itwin-platform.

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

Request parameters

Name
In
Required?
Description
redirectUrl
query
No

URL to redirect back to after authorization

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with synchronization:read or itwin-platform scope

Accept
Yes

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

Response 200 OK

OK

json
{
    "authorizationInformation": {
        "isUserAuthorized": false,
        "_links": {
            "authorizationUrl": {
                "href": "https://connect-itwinbridgeportal.bentley.com/authenticate"
            }
        }
    }
}

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 a connection.

json
{
    "error": {
        "code": "InvalidAuthorizationInformationRequest",
        "message": "Cannot perform operation.",
        "details": [{
            "code": "InvalidValue",
            "message": "redirectUrl should be a valid URL.",
            "target": "redirectUrl"
        }]
    }
}

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.

AuthorizationInformation

TableSchema
Name
Type
Description
isUserAuthorized
Boolean

A boolean value representing if user is authorized and ready for synchronization.

_links

Links for detailed authorization information.

AuthorizationInformation Response

TableSchema
Name
Type
Description
authorizationInformation

An entity with user's authorization status and corresponding links.

AuthorizationInformationLinks

TableSchema
Name
Type
Description
authorizationUrl

An authorization URL to redirect the user to be authorized.

Link

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.