Create iTwin role - Access Control

REST API Overview

Reference

Changelog

Access Control

Download API definition:

Create iTwin role

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

Create a new iTwin role.

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_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

Request parameters

Yes

The iTwin ID

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

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

Request body

Role (create)

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

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": "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 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"
            },
            {
                "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

RoleResponse

role

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.

Role (create)

displayName

String

The display name of your Role.

description

String

A description of your Role.

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.