Get iTwin account - iTwins

iTwins

Download API definition:

Get iTwin account

GET https://api.bentley.com/itwins/{iTwinId}/account

Gets the Account for the specified iTwin.

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.

Authorization

The calling user must be a member of the specified iTwin. Use the Access Control API to manage an iTwin's members.

Request parameters

iTwinId

Yes

The iTwin Id

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

{
    "iTwin": {
        "id": "76c1102e-4f33-4dfa-ad93-bcd9ab717977",
        "class": "Account",
        "subClass": "Account",
        "type": null,
        "number": "Acme Corp.",
        "displayName": "Acme Corp."
    }
}

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 404 Not Found

This response indicates that the specified iTwin was not found.

json

{
    "error": {
        "code": "iTwinNotFound",
        "message": "Requested iTwin is not available."
    }
}

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

iTwin-summary-response

iTwin

iTwin-summary

json

{
    "type": "object",
    "properties": {
        "iTwin": {
            "$ref": "#/components/schemas/iTwin-summary"
        }
    },
    "required": [
        "iTwin"
    ],
    "additionalProperties": false
}

iTwin (summary)

Minimal representation of a iTwin that contains only id, class, subClass, type, number and displayName.

String

The iTwin Id.

class

iTwinClass

The Class of your iTwin.

subClass

iTwinSubClass

The subClass your iTwin.

type

String, null

An open ended property to better define your iTwin's Type.

number

String

A unique number or code for the iTwin. This is the value that uniquely identifies the iTwin within your organization.

displayName

String

A display name for the iTwin.

status

iTwinStatus

Must be one of Active, Inactive or Trial. The default value is Active. By default, Inactive iTwins are not returned from the Get my iTwins API unless requested using the includeInactive parameter.

json

{
    "type": "object",
    "title": "iTwin (summary)",
    "description": "Minimal representation of a iTwin that contains only id, class, subClass, type, number and displayName.",
    "properties": {
        "id": {
            "type": "string",
            "description": "The iTwin Id."
        },
        "class": {
            "$ref": "#/components/schemas/iTwinClass",
            "description": "The [Class](https://developer.bentley.com/apis/itwins/overview/#itwinclassesandsubclasses) of your iTwin."
        },
        "subClass": {
            "$ref": "#/components/schemas/iTwinSubClass",
            "description": "The [subClass](https://developer.bentley.com/apis/itwins/overview/#itwinclassesandsubclasses) your iTwin."
        },
        "type": {
            "type": "string",
            "nullable": true,
            "description": "An open ended property to better define your iTwin's Type.",
            "maxLength": 100
        },
        "number": {
            "type": "string",
            "description": "A unique number or code for the iTwin. This is the value that uniquely identifies the iTwin within your organization.",
            "maxLength": 255
        },
        "displayName": {
            "type": "string",
            "description": "A display name for the iTwin.",
            "maxLength": 255
        },
        "status": {
            "$ref": "#/components/schemas/iTwinStatus",
            "description": "Must be one of Active, Inactive or Trial. The default value is Active. By default, Inactive iTwins are not returned from the [Get my iTwins API](https://developer.bentley.com/apis/itwins/operations/get-my-itwins/) unless requested using the includeInactive parameter."
        }
    },
    "additionalProperties": false
}

iTwin Status

One of 'Active', 'Inactive', 'Trial'

Active

String

Inactive

String

Trial

String

json

{
    "type": "string",
    "title": "iTwin Status",
    "description": "One of 'Active', 'Inactive', 'Trial'",
    "enum": [
        "Active",
        "Inactive",
        "Trial"
    ]
}

iTwin Class

The Class of your iTwin.

Account

String

Thing

String

Endeavor

String

json

{
    "type": "string",
    "title": "iTwin Class",
    "description": "The [Class](https://developer.bentley.com/apis/itwins/overview/#itwinclassesandsubclasses) of your iTwin.",
    "enum": [
        "Account",
        "Thing",
        "Endeavor"
    ]
}

iTwin SubClass

The subClass your iTwin.

Account

String

Portfolio

String

Asset

String

Program

String

Project

String

WorkPackage

String

json

{
    "type": "string",
    "title": "iTwin SubClass",
    "description": "The [subClass](https://developer.bentley.com/apis/itwins/overview/#itwinclassesandsubclasses) your iTwin.",
    "enum": [
        "Account",
        "Portfolio",
        "Asset",
        "Program",
        "Project",
        "WorkPackage"
    ]
}

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?