Add iTwin group members - Access Control

REST API Overview

Reference

Access Control

Download API definition:

POST https://dev-api.bentley.com/accesscontrol/itwins/{id}/members/groups

Add new iTwin group members

The total number of roles assigned in this request must not exceed 50. This can be achieved with many different configurations. For example, 1 role can be assigned to 50 groups, or 5 roles can be assigned to 10 groups, both resulting in 50 role 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

User must have the administration_invite_member permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a 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

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

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

Request body

Group Members (add)

members

GroupMemberAdd[]

List of group members.

Example

json

{
    "members": [{
        "groupId": "6abbfcea-0eab-472a-b5f5-5c5a43df34b4",
        "roleIds": ["5abbfcef-0eab-472a-b5f5-5c5a43df34b1", "83ee0d80-dea3-495a-b6c0-7bb102ebbcc3"]
    }]
}

Response

Response 201 Created

iTwin group members was successfully added.

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"
            }]
        }
    ]
}

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 roles with specified ID were not found.

json

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

Response 409 Conflict

Invalid request to add new iTwin member. Member already exists in iTwin.

json

{
    "error": {
        "code": "TeamMemberExists",
        "message": "Requested team member already exists in iTwin.",
        "target": "members[0].groupId"
    }
}

Response 422 Unprocessable Entity

Invalid request to add new iTwin member. Request payload might be missing some of the required properties.

json

{
    "error": {
        "code": "InvalidiTwinsMemberRequest",
        "message": "Request body or query is invalid.",
        "details": [{
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "members[0].groupId"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "members[0].roleIds"
            },
            {
                "code": "InvalidProperty",
                "message": "Collection size exceeds maximum size.",
                "target": "members"
            },
            {
                "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

iTwin Group Member

String

The group id.

groupName

String

Group name.

groupDescription

String

Group description.

roles

Role[]

List of roles.

iTwin Group Members

members

GroupMemberRepresentation[]

List of group members.

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.

Group Members (add)

members

GroupMemberAdd[]

List of group members.

Group Member (add)

groupId

String

Id of the group.

roleIds

String[]

List of role ids.

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.

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.