Access Control

Download API definition:

get https://dev-api.bentley.com/accesscontrol/itwins/{id}/members/invitations/{invitationId}

Get iTwin Member Invitation

Retrieves detailed information for a specific iTwin member invitation by invitation ID.

Invitations have an expiration of 7 days after their creation. Once that expiration passes, the invitation will not be returned.

Authorization

The calling user must be a member of the iTwin and be the invited user or invitee of the user. Organization Administrator can also retrieve iTwin member invitations for any iTwin in their Organization.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

Request

Request parameters

Yes

The iTwin ID.

invitationId

Yes

The invitation ID.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

json

{
    "invitation": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "invited.user@example.com",
        "invitedByEmail": "inviter.admin@org.com",
        "inviterGivenName": "Taylor",
        "inviterSurname": "Admin",
        "projectDisplayName": "Access Control Sample Project",
        "inviterOrganization": "Organization Corp.",
        "status": "Pending",
        "createdDate": "2023-11-10T14:22:42.2317880+00:00",
        "expirationDate": "2023-11-17T14:22:42.2317880+00:00",
        "roles": [{
            "id": "00000000-0000-0000-0000-000000000000",
            "displayName": "iTwin Admin Role"
        }]
    }
}

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

The user has insufficient permissions for the requested operation.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 404 Not Found

This response indicates iTwin or invitation 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

Role

String

The role id.

type

String

The type of role. Either Custom or Default.

description

String

A description of your Role.

displayName

String

The display name of your Role.

permissions

String[]

List of permissions assigned to the role.

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The role id."
        },
        "type": {
            "type": "string",
            "description": "The type of role. Either Custom or Default."
        },
        "description": {
            "type": "string",
            "description": "A description of your Role."
        },
        "displayName": {
            "type": "string",
            "description": "The display name of your Role."
        },
        "permissions": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "List of permissions assigned to the role."
        }
    },
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information.",
    "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",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error",
            "description": "Error information."
        }
    },
    "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.",
    "additionalProperties": false
}

iTwin User Invitation status

The status of the invitation.

Pending

String

Accepted

String

json

{
    "enum": [
        "Pending",
        "Accepted"
    ],
    "type": "string",
    "description": "The status of the invitation.",
    "title": "iTwin User Invitation status"
}

iTwin User Invitation

String

The user Id in Identity Management System.

String

User that was invited.

roles

Role[]

List of roles.

iTwin User Invitation status

MemberInvitation-status

The status of the invitation.

createdDate

Date-time

Datetime when the invitation was created.

expirationDate

Date-time

DateTime when the invitation will expire.

invitedByEmail

String

User that sent the invitation.

inviterSurname

String

Surname of the user that sent the invitation.

inviterGivenName

String

Given name of the user that sent the invitation.

projectDisplayName

String

Display name of the project associated with the invitation.

inviterOrganization

String

Organization user that sent the invitation is member of in Identity Management System.

json

{
    "type": "object",
    "title": "iTwin User Invitation",
    "nullable": true,
    "properties": {
        "id": {
            "type": "string",
            "description": "The user Id in Identity Management System."
        },
        "email": {
            "type": "string",
            "description": "User that was invited."
        },
        "roles": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Role"
            },
            "description": "List of roles."
        },
        "status": {
            "enum": [
                "Pending",
                "Accepted"
            ],
            "type": "string",
            "description": "The status of the invitation.",
            "title": "iTwin User Invitation status",
            "$ref": "#/components/schemas/MemberInvitation-status"
        },
        "createdDate": {
            "type": "string",
            "format": "date-time",
            "example": "0000-00-00T00:00:00.000000",
            "description": "Datetime when the invitation was created."
        },
        "expirationDate": {
            "type": "string",
            "format": "date-time",
            "example": "0000-00-00T00:00:00.000000",
            "description": "DateTime when the invitation will expire."
        },
        "invitedByEmail": {
            "type": "string",
            "description": "User that sent the invitation."
        },
        "inviterSurname": {
            "type": "string",
            "description": "Surname of the user that sent the invitation."
        },
        "inviterGivenName": {
            "type": "string",
            "description": "Given name of the user that sent the invitation."
        },
        "projectDisplayName": {
            "type": "string",
            "description": "Display name of the project associated with the invitation."
        },
        "inviterOrganization": {
            "type": "string",
            "description": "Organization user that sent the invitation is member of in Identity Management System."
        }
    },
    "additionalProperties": false
}

Single member invitation (response)

invitation

MemberInvitation

json

{
    "type": "object",
    "title": "Single member invitation (response)",
    "required": [
        "invitation"
    ],
    "properties": {
        "invitation": {
            "$ref": "#/components/schemas/MemberInvitation"
        }
    },
    "additionalProperties": false
}

Was this page helpful?