Add iTwin group users - Access Control

Access Control

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

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

Add or invite users to the specified iTwin group. Users which are external (i.e. not in the same organization as the iTwin) are not automatically added to the group. Instead, they're invited. Users which are not external, are immediately added to the group.

A maximum of 50 users can be added in a single request.

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 and administration_invite_member permissions 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.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

Add iTwin group users (request)

users

String[]

Yes

List of user emails to add to the group. Max size of 50. Users which are external to the organization that owns the iTwin are invited instead of added.

Example

json

{
    "users": ["John.Johnson@example.com", "Simon.Simonson@anotherexample.com"]
}

Response

Response 201 Created

iTwin group users were successfully added.

json

{
    "users": [{
        "id": "99cf5e21-735c-4598-99eb-fe3940f96353",
        "email": "John.Johnson@example.com",
        "givenName": "John",
        "surname": "Johnson",
        "organization": "Organization Corp."
    }]
}

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 user with specified ID was not found.

json

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

Response 409 Conflict

Invalid request to add iTwin group users. User already exists in the iTwin group.

json

{
    "error": {
        "code": "UserExists",
        "message": "Requested user already exists in iTwin group.",
        "target": "users[0]"
    }
}

Response 422 Unprocessable Entity

Invalid request to add iTwin group users. Make sure request has required properties and does not exceed maximum size.

json

{
    "error": {
        "code": "InvalidGroupUsersRequest",
        "message": "Request body is invalid.",
        "details": [{
            "code": "InvalidProperty",
            "message": "Collection size exceeds maximum size.",
            "target": "users"
        }, {
            "code": "InvalidValue",
            "message": "Value outside of valid range.",
            "target": "users[0]"
        }, {
            "code": "DuplicateValue",
            "message": "Value is repeated in the request.",
            "target": "users[1]"
        }, {
            "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

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
}

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
}

iTwin group users (response)

users

GroupUser[]

List of users that were added to the group.

json

{
    "type": "object",
    "title": "iTwin group users (response)",
    "required": [
        "users"
    ],
    "properties": {
        "users": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/GroupUser"
            },
            "description": "List of users that were added to the group."
        }
    },
    "additionalProperties": false
}

Add iTwin group users (request)

users

String[]

List of user emails to add to the group. Max size of 50. Users which are external to the organization that owns the iTwin are invited instead of added.

json

{
    "type": "object",
    "title": "Add iTwin group users (request)",
    "required": [
        "users"
    ],
    "properties": {
        "users": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "List of user emails to add to the group. Max size of 50. Users which are external to the organization that owns the iTwin are invited instead of added."
        }
    },
    "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?