Table of contents
Access Control
Download API definition:
POST https://api.bentley.com/accesscontrol/itwins/{id}/roles

Create a new iTwin role.

Authentication

Requires Authorization header with valid Bearer token for scope itwins:modify.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Authorization

User must have the administration_manage_roles 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 parameters

Name
Required?
Description
id
Yes

The iTwin ID

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope itwins:modify

Accept
No

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

Request body

Role (create)

Name
Type
Required?
Description
displayName
String
Yes

The display name of your Role.

description
String
Yes

A description of your Role.

Example

json
{
    "displayName": "iTwin Administrator",
    "description": "The iTwin Administration Role"
}

Response 201 Created

iTwin role was created successfully.

json
{
    "role": {
        "id": "faa3dca1-a901-4659-9da1-d9f29ddcc288",
        "displayName": "iTwin Administrator",
        "description": "The iTwin Administration Role"
    }
}

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": "Unauthorized",
        "message": "Access denied due to invalid access_token. Make sure to provide a valid token for this API endpoint."
    }
}

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 the iTwin was not found.

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

Response 422 Unprocessable Entity

Invalid request to create new iTwin role. Make sure request had required properties and does not pass in readonly properties.

json
{
    "error": {
        "code": "InvalidiTwinsRoleRequest",
        "message": "Cannot create/update Role.",
        "details": [{
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "displayName"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "description"
            }
        ]
    }
}

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

Name
Description
retry-after

The number of requests exceeds the rate-limit for the client subscription.

Role

Name
Type
Description
id
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.

Role (create)

Name
Type
Description
displayName
String

The display name of your Role.

description
String

A description of your Role.

Error

Contains error information and an optional array of more specific errors.

Name
Type
Description
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.

details
ErrorDetails[], null

Optional array of more specific errors.

Error Details

Contains error information.

Name
Type
Description
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.

Name
Type
Description
error

Error information.