Update iTwin user member - Access Control

Access Control

Download API definition:

Update iTwin user member

patch https://dev-api.bentley.com/accesscontrol/itwins/{id}/members/users/{memberId}

Update an iTwin user member's 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

memberId

Yes

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

User Member (update)

roleIds

String[]

Yes

List of role ids.

Example

json

{
    "roleIds": ["e968b640-02c4-41ef-b4f0-935918a82af3", "63e3533c-eb6d-48ee-a2b3-3a6c724340f2"]
}

Response

Response 200 OK

json

{
    "member": {
        "id": "69e0284a-1331-4462-9c83-9cdbe2bdaa7f",
        "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, user member, or roles with specified ID were not found.

json

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

Response 422 Unprocessable Entity

Invalid request to update user member roles. 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": "roleIds"
        }, {
            "code": "InvalidProperty",
            "message": "Collection size exceeds maximum size.",
            "target": "roleIds"
        }, {
            "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
}

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
}

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

String

The user Id in Identity Management System.

String

User email.

roles

Role[]

List of roles.

surname

String

User surname.

givenName

String

User given name.

organization

String

Organization user is member of in Identity Management System.

json

{
    "type": "object",
    "title": "iTwin User Member",
    "properties": {
        "id": {
            "type": "string",
            "description": "The user Id in Identity Management System."
        },
        "email": {
            "type": "string",
            "description": "User email."
        },
        "roles": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Role"
            },
            "description": "List of roles."
        },
        "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
}

User Member (update)

member

UserMemberRepresentation

json

{
    "type": "object",
    "title": "User Member (update)",
    "required": [
        "member"
    ],
    "properties": {
        "member": {
            "$ref": "#/components/schemas/UserMemberRepresentation"
        }
    },
    "additionalProperties": false
}

User Member (update)

roleIds

String[]

List of role ids.

json

{
    "type": "object",
    "title": "User Member (update)",
    "required": [
        "roleIds"
    ],
    "properties": {
        "roleIds": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "List of role ids."
        }
    },
    "additionalProperties": false
}

Was this page helpful?