Get iTwin member invitations - Access Control

Access Control

Download API definition:

GET https://api.bentley.com/accesscontrol/itwins/{id}/members/invitations

Retrieves a list of iTwin member invitations. By default, users will receive the invitations they have sent. If the user is an iTwin Owner, they will receive all invitations for the iTwin.

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

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

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

Response

Response 200 OK

json

{
    "invitations": [{
            "id": "99cf5e21-735c-4598-99eb-fe3940f96353",
            "email": "invited.user@example.com",
            "invitedByEmail": "inviter.admin@org.com",
            "status": "Pending",
            "createdDate": "2023-11-10T14:22:42.231788Z",
            "expirationDate": "2023-11-17T14:22:42.231788Z",
            "roles": [{
                "id": "b5fe0619-65bc-4d1f-9528-e16b021400cc",
                "displayName": "iTwin Admin Role"
            }]
        },
        {
            "id": "310122ef-0939-4377-9ac0-61d80b5d729e",
            "email": "another.invited.user@example.com",
            "invitedByEmail": "inviter.admin@org.com",
            "status": "Pending",
            "createdDate": "2023-11-10T18:31:01.412321Z",
            "expirationDate": "2023-11-17T18:31:01.412321Z",
            "roles": [{
                "id": "b5fe0619-65bc-4d1f-9528-e16b021400cc",
                "displayName": "iTwin Admin Role"
            }]
        }
    ],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/iTwins/806b19d5-c037-48a4-aa98-e297c81453f1/members/invitations?$skip=0&$top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/iTwins/806b19d5-c037-48a4-aa98-e297c81453f1/members/invitations?$skip=0&$top=100"
        },
        "next": {
            "href": "https://api.bentley.com/iTwins/806b19d5-c037-48a4-aa98-e297c81453f1/members/invitations?$skip=100&$top=100"
        }
    }
}

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

This response indicates that iTwin with specified ID was not found.

json

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

Response 422 Unprocessable Entity

Invalid request to get iTwin member invitations.

json

{
    "error": {
        "code": "InvalidiTwinsMemberInvitationsRequest",
        "message": "Request body or query is invalid.",
        "details": [{
                "code": "InvalidValue",
                "message": "Value outside of valid range.",
                "target": "$top"
            },
            {
                "code": "InvalidRequestBody",
                "message": "Failed to parse request body or collection is empty."
            }
        ]
    }
}

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

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

User invitations (response)

invitations

MemberInvitation[]

List of user invitations.

_links

links-paging

Contains the hyperlinks to the previous and next pages of results.

json

{
    "type": "object",
    "title": "User invitations (response)",
    "properties": {
        "invitations": {
            "type": "array",
            "description": "List of user invitations.",
            "items": {
                "$ref": "#/components/schemas/MemberInvitation"
            }
        },
        "_links": {
            "description": "Contains the hyperlinks to the previous and next pages of results.",
            "$ref": "#/components/schemas/links-paging"
        }
    },
    "required": [
        "invitations",
        "_links"
    ],
    "additionalProperties": false
}

iTwin User Invitation status

The status of the invitation.

Pending

String

Accepted

String

json

{
    "type": "string",
    "enum": [
        "Pending",
        "Accepted"
    ],
    "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.

invitedByEmail

String

User that sent the invitation.

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.

roles

Role[]

List of roles.

json

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

Role

String

The role id.

displayName

String

The display name of your Role.

description

String

A description of your Role.

permissions

String[]

List of permissions assigned to the role.

json

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

links (paging)

URLs for redoing the current request, getting to the previous or next page of results, if applicable containg.

self

link

URL for redoing the current request.

link

URL for getting the next page of results.

link

URL for getting the previous page of results.

json

{
    "title": "links (paging)",
    "description": "URLs for redoing the current request, getting to the previous or next page of results, if applicable containg.",
    "type": "object",
    "properties": {
        "self": {
            "description": "URL for redoing the current request.",
            "$ref": "#/components/schemas/link"
        },
        "next": {
            "description": "URL for getting the next page of results.",
            "$ref": "#/components/schemas/link"
        },
        "prev": {
            "description": "URL for getting the previous page of results.",
            "$ref": "#/components/schemas/link"
        }
    },
    "additionalProperties": false
}

link

Hyperlink container.

href

String

Hyperlink container.

json

{
    "type": "object",
    "description": "Hyperlink container.",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink container."
        }
    },
    "additionalProperties": false
}

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?