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
URL to redirect back to after authorization
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Response 200 OK
OK
{ "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.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 422 Unprocessable Entity
Invalid request to get authorization information.
{ "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 user has sent too many requests in a given amount of time.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
Response headers
The number of requests exceeds the rate-limit for the client subscription.
Authorization Information
True if user is already authorized.
Authorization Information Links
AuthorizationInformation Response
An entity with user's authorization status and corresponding links.
Link
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
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.