Get iTwin groups - Access Control

Access Control

Download API definition:

get https://dev-api.bentley.com/accesscontrol/itwins/{id}/groups[?$top][&$skip]

Retrieves a list of all groups that are defined for a specified iTwin. The members and imsGroups properties are both capped at 50 each. The default cap can be overridden if paging params are provided. 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 be an Organization Administrator for the Organization that owns the given 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

$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

{
    "groups": [{
        "id": "149d0860-39e9-4ae9-9b05-0b5dcedd2d4b",
        "name": "Sample Group",
        "description": "This is a group for a sample",
        "members": [{
            "userId": "69e0284a-1331-4462-9c83-9cdbe2bdaa7f",
            "email": "Thomas.Wilson@example.com",
            "givenName": "Thomas",
            "surname": "Wilson",
            "organization": "Organization Corp."
        }],
        "imsGroups": ["Sample IMS Group"]
    }, {
        "id": "149d0860-39e9-4ae9-9b05-0b5dcedd2d4b",
        "name": "Another Sample Group",
        "description": "This is a group for another sample",
        "members": [{
            "userId": "25407933-cad2-41a2-acf4-5a074c83046b",
            "email": "Maria.Miller@example.com",
            "givenName": "Maria",
            "surname": "Miller",
            "organization": "Organization Corp."
        }],
        "imsGroups": ["Another Sample IMS Group"]
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/accesscontrol/itwins/8e27f9d7-a4ad-4e29-a6e9-99ce871ae7dd/groups?$top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/accesscontrol/itwins/8e27f9d7-a4ad-4e29-a6e9-99ce871ae7dd/groups?$top=100&$skip=0"
        },
        "next": {
            "href": "https://api.bentley.com/accesscontrol/itwins/8e27f9d7-a4ad-4e29-a6e9-99ce871ae7dd/groups?$top=100&$skip=200"
        }
    }
}

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

json

{
    "error": {
        "code": "InvalidiTwinsGroupPagedRequest",
        "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 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
}

Group

String

The Group id.

name

String

The name of your Group.

members

GroupUser[]

List of members assigned to the Group. Max size of 50.

imsGroups

String[]

List of IMS Groups assigned to the Group. Max size of 50.

description

String

A description of your Group.

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The Group id."
        },
        "name": {
            "type": "string",
            "description": "The  name of your Group."
        },
        "members": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/GroupUser"
            },
            "description": "List of members assigned to the Group. Max size of 50."
        },
        "imsGroups": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "List of IMS Groups assigned to the Group. Max size of 50."
        },
        "description": {
            "type": "string",
            "description": "A description of your Group."
        }
    },
    "additionalProperties": false
}

GroupUser

String

User email.

userId

String

The user Id in Identity Management System.

surname

String

User surname.

givenName

String

User given name.

organization

String

Organization user is member of in Identity Management System.

json

{
    "type": "object",
    "properties": {
        "email": {
            "type": "string",
            "description": "User email."
        },
        "userId": {
            "type": "string",
            "description": "The user Id in Identity Management System."
        },
        "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
}

GroupsResponse

_links

links-paging

groups

Group[]

List of groups.

json

{
    "type": "object",
    "required": [
        "groups"
    ],
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/links-paging"
        },
        "groups": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Group"
            },
            "description": "List of groups."
        }
    },
    "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
}

Was this page helpful?