Get iTwin group members - Access Control

Access Control

Download API definition:

Get iTwin group members

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

Retrieves a list of iTwin group members and their roles assignments.

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 iTwin. Organization Administrator can also retrieve iTwin members 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

$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

{
    "members": [{
        "id": "99cf5e21-735c-4598-99eb-fe3940f96353",
        "groupName": "Sample Group",
        "groupDescription": "This is a sample group",
        "roles": [{
            "id": "5abbfcef-0eab-472a-b5f5-5c5a43df34b1",
            "displayName": "Read Access",
            "description": "Read Access"
        }, {
            "id": "6abbfcea-0eab-472a-b5f5-5c5a43df34b4",
            "displayName": "Write Access",
            "description": "Write Access"
        }]
    }, {
        "id": "25407933-cad2-41a2-acf4-5a074c83046b",
        "groupName": "Another Sample Group",
        "groupDescription": "This is another sample group",
        "roles": [{
            "id": "5abbfcef-0eab-472a-b5f5-5c5a43df34b1",
            "displayName": "Read Access",
            "description": "Read Access"
        }]
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/iTwins/806b19d5-c037-48a4-aa98-e297c81453f1/member/groups?$skip=0&$top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/iTwins/806b19d5-c037-48a4-aa98-e297c81453f1/member/groups?$skip=0&$top=100"
        },
        "next": {
            "href": "https://api.bentley.com/iTwins/806b19d5-c037-48a4-aa98-e297c81453f1/member/groups?$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 members.

json

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

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
}

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
}

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
}

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 Group Member

String

The group id.

roles

Role[]

List of roles.

groupName

String

Group name.

groupDescription

String

Group description.

json

{
    "type": "object",
    "title": "iTwin Group Member",
    "properties": {
        "id": {
            "type": "string",
            "description": "The group id."
        },
        "roles": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Role"
            },
            "description": "List of roles."
        },
        "groupName": {
            "type": "string",
            "description": "Group name."
        },
        "groupDescription": {
            "type": "string",
            "description": "Group description."
        }
    },
    "additionalProperties": false
}

iTwin Group Members

_links

links-paging

members

GroupMemberRepresentation[]

List of group members.

json

{
    "type": "object",
    "title": "iTwin Group Members",
    "required": [
        "members",
        "_links"
    ],
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/links-paging"
        },
        "members": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/GroupMemberRepresentation"
            },
            "description": "List of group members."
        }
    },
    "additionalProperties": false
}

Was this page helpful?