Updates a group.
Note: any string parameter being passed in the payload will be rejected if it contains any of the following characters: <, >, &, ", ', .
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.
Request parameters
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Request body
GroupUpdate
Group Name
Is Group Shared
Example
{ "displayName": "Desktop", "shared": true }
Response 200 OK
Updated group.
{ "group": { "id": "ACZbDmWhULVChRcDRkoPdLaNv7DGPQORQpkxmyDyE1ERZS7bsqUkWEmr9ZGmC5TopQ", "displayName": "Test Name", "shared": false, "_links": { "iTwin": { "href": "https://api.bentley.com/path1/path2/id" }, "imodel": { "href": "https://api.bentley.com/path1/path2/id" }, "creator": { "href": "https://api.bentley.com/path1/path2/id" }, "savedViews": { "href": "https://api.bentley.com/path1/path2/id" } } } }
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.
{ "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.
{ "error": { "code": "InsufficientPermissions", "message": "The user has insufficient permissions for the requested operation." } }
Response 404 Not Found
Requested group is not available.
{ "error": { "code": "GroupNotFound", "message": "Requested group is not available." } }
Response 422 Unprocessable Entity
Cannot update group.
{ "error": { "code": "InvalidSavedviewsRequest", "message": "Cannot update group.", "details": [{ "code": "InvalidRequestBody", "message": "displayName must be a string.", "target": "displayName" }] } }
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.
{ "error": { "code": "RateLimitExceeded", "message": "The client sent more requests than allowed by this API for the current tier of the client." } }
Response headers
Number of seconds to wait until client is allowed to make more requests.
Link
Http reference
{ "additionalProperties": false, "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string", "description": "Http reference", "example": "https://api.bentley.com/path1/path2/id" } } }
GroupLinks
{ "additionalProperties": false, "required": [ "iTwin", "creator", "savedViews" ], "type": "object", "properties": { "iTwin": { "$ref": "#/components/schemas/Link" }, "project": { "$ref": "#/components/schemas/Link" }, "imodel": { "$ref": "#/components/schemas/Link" }, "creator": { "$ref": "#/components/schemas/Link" }, "savedViews": { "$ref": "#/components/schemas/Link" } } }
Group
Unique identifier
Whether the group is read-only and only editable by admin users
User visible name
Flag for whether or not element is shared
{ "additionalProperties": false, "required": [ "id", "displayName", "shared", "_links" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier", "example": "ACZbDmWhULVChRcDRkoPdLaNv7DGPQORQpkxmyDyE1ERZS7bsqUkWEmr9ZGmC5TopQ" }, "readOnly": { "type": "boolean", "description": "Whether the group is read-only and only editable by admin users", "example": false }, "displayName": { "type": "string", "description": "User visible name", "example": "Test Name" }, "shared": { "type": "boolean", "description": "Flag for whether or not element is shared", "example": false }, "_links": { "$ref": "#/components/schemas/GroupLinks" } } }
GroupResponse
{ "additionalProperties": false, "required": [ "group" ], "type": "object", "properties": { "group": { "$ref": "#/components/schemas/Group" } } }
GroupUpdate
Group Name
Is Group Shared
{ "additionalProperties": false, "type": "object", "properties": { "displayName": { "type": "string", "description": "Group Name", "nullable": true, "example": "Desktop" }, "shared": { "type": "boolean", "description": "Is Group Shared", "nullable": true, "example": true } } }
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
{ "type": "object", "description": "Contains error information.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error.", "nullable": true } }, "required": [ "code", "message" ], "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.
{ "type": "object", "title": "Error Response", "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.", "properties": { "error": { "description": "Error information.", "$ref": "#/components/schemas/Error" } }, "required": [ "error" ], "additionalProperties": false }
Was this page helpful?