Get iTwin group IMS group users - Access Control

Access Control

This operation is a Technical Preview and is available for testing purposes only. Do not use in production.

GET https://dev-api.bentley.com/accesscontrol/itwins/{id}/groups/{groupId}/ims-groups/{imsGroupId}/users[?$top][&$skip]

Retrieves a list of users that belong to the specified IMS group assigned to the specified iTwin group. Paging links are only included when top or skip query parameters are used.

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

User must have the administration_manage_groups permission assigned at the iTwin level, or be an Organization Administrator for the Organization that owns the given iTwin, or an owner of the iTwin.

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.

groupId

Yes

The group ID.

imsGroupId

Yes

The IMS group ID.

$top

The $top system query option requests the number of items in the queried collection to be included in the result.

$skip

The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

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

{
    "users": [{
        "id": "69e0284a-1331-4462-9c83-9cdbe2bdaa7f",
        "email": "Thomas.Wilson@example.com",
        "givenName": "Thomas",
        "surname": "Wilson",
        "organization": "Organization Corp."
    }, {
        "id": "25407933-cad2-41a2-acf4-5a074c83046b",
        "email": "Maria.Miller@example.com",
        "givenName": "Maria",
        "surname": "Miller",
        "organization": "Organization Corp."
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/accesscontrol/itwins/8e27f9d7-a4ad-4e29-a6e9-99ce871ae7dd/groups/149d0860-39e9-4ae9-9b05-0b5dcedd2d4b/ims-groups/4f1c2dc7-1dc9-4a3a-9c0f-7a5e7d3e7a12/users?$skip=0&$top=50"
        },
        "prev": {
            "href": "https://api.bentley.com/accesscontrol/itwins/8e27f9d7-a4ad-4e29-a6e9-99ce871ae7dd/groups/149d0860-39e9-4ae9-9b05-0b5dcedd2d4b/ims-groups/4f1c2dc7-1dc9-4a3a-9c0f-7a5e7d3e7a12/users?$skip=0&$top=50"
        },
        "next": {
            "href": "https://api.bentley.com/accesscontrol/itwins/8e27f9d7-a4ad-4e29-a6e9-99ce871ae7dd/groups/149d0860-39e9-4ae9-9b05-0b5dcedd2d4b/ims-groups/4f1c2dc7-1dc9-4a3a-9c0f-7a5e7d3e7a12/users?$skip=50&$top=50"
        }
    }
}

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 that iTwin, group, or IMS group 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 group IMS group users.

json

{
    "error": {
        "code": "InvalidGroupImsGroupUsersPagedRequest",
        "message": "Request 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 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

link

Hyperlink container.

href

String

Hyperlink container.

json

{
    "type": "object",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink container."
        }
    },
    "description": "Hyperlink container.",
    "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
}

GroupUser

String

The user Id in Identity Management System.

String

User email.

surname

String

User surname.

givenName

String

User given name.

organization

String

Organization user is member of in Identity Management System.

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The user Id in Identity Management System."
        },
        "email": {
            "type": "string",
            "description": "User email."
        },
        "surname": {
            "type": "string",
            "description": "User surname."
        },
        "givenName": {
            "type": "string",
            "description": "User given name."
        },
        "organization": {
            "type": "string",
            "description": "Organization user is member of in Identity Management System."
        }
    },
    "additionalProperties": false
}

links (paging)

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

link

self

link

json

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

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message",
        "details"
    ],
    "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."
        },
        "details": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Error"
            },
            "description": "Optional array of more specific errors."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information and an array of more specific errors.",
    "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
}

Detailed Error Response

error

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed Error Response",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/DetailedError",
            "description": "Error Detailed 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 Group Members 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 Group Members Invitation status"
}

iTwin Group Members Invitation

String

The user Id in Identity Management System.

String

User that was invited.

iTwin Group Members Invitation status

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

json

{
    "type": "object",
    "title": "iTwin Group Members Invitation",
    "nullable": true,
    "properties": {
        "id": {
            "type": "string",
            "description": "The user Id in Identity Management System."
        },
        "email": {
            "type": "string",
            "description": "User that was invited."
        },
        "status": {
            "enum": [
                "Pending",
                "Accepted"
            ],
            "type": "string",
            "description": "The status of the invitation.",
            "title": "iTwin Group Members Invitation status",
            "$ref": "#/components/schemas/GroupMemberInvitation-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."
        }
    },
    "additionalProperties": false
}

iTwin group users

users

GroupUser[]

List of users assigned to the group.

_links

links-paging

invitations

GroupMemberInvitation[]

List of pending invitations for the group.

json

{
    "type": "object",
    "title": "iTwin group users",
    "required": [
        "users",
        "_links"
    ],
    "properties": {
        "users": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/GroupUser"
            },
            "description": "List of users assigned to the group."
        },
        "_links": {
            "$ref": "#/components/schemas/links-paging"
        },
        "invitations": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/GroupMemberInvitation"
            },
            "description": "List of pending invitations for the group."
        }
    },
    "additionalProperties": false
}

Was this page helpful?