Table of contents
Export
Download API definition:
GET https://qa-api.bentley.com/export/authorizationinformation?redirectUrl

Retrieves the calling user's Authorization Information.

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.

Request parameters

Name
Required?
Description
redirectUrl
Yes

URL to redirect back to after authorization

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
{
    "authorizationInformation": {
        "isUserAuthorized": false,
        "_links": {
            "authorizationUrl": {
                "href": "https://connect-itwinbridgeportal.bentley.com/authenticate?redirect_url=https://myUrl.com"
            }
        }
    }
}

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 authorization information.

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

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

Name
Description
retry-after

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

Authorization Information

Name
Type
Description
isUserAuthorized
Boolean

True if user is already authorized.

Authorization Information Links

Name
Type
Description
authorizationUrl

Url to authorize user with if not already authorized.

AuthorizationInformation Response

Name
Type
Description
authorizationInformation

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

Link

Name
Type
Description
href
String

Error

Contains error information.

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

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.

Name
Type
Description
error

Error information.