Create iTwin job - Access Control

Access Control

Download API definition:

POST https://api.bentley.com/accesscontrol/itwins/{id}/jobs

Create a new iTwin job. iTwin jobs allow you to preform actions on an iTwin in bulk.

Currently there are three types of supported actions:

assignRoles
unassignRoles
removeMembers

Note: If the user being assigned roles in the assignRoles action is not a member of the iTwin, they will be added to the iTwin with the provided roles.

assignRoles and unassignRoles actions have a limit of 100 roles per group of actions. removeMembers has a limit of 100 emails.

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 {permission} 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

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

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

Request body

Job (create)

actions

iTwinJobActions

Job actions

Example

json

{
    "actions": {
        "assignRoles": [{
            "email": "John.Johnson@example.com",
            "roleIds": [
                "f612790a-4988-4fec-ae98-f4a430e8c258"
            ]
        }],
        "unassignRoles": [{
            "email": "Maria.Miller@example.com",
            "roleIds": [
                "7bfeacc1-dd6a-46de-8e6f-1abe83eff627"
            ]
        }],
        "removeMembers": [{
            "email": "Jobby.McJobface@example.com"
        }]
    }
}

Response

Response 201 Created

iTwin job was successfully created.

json

{
    "id": "fb936e1f-5a60-4fe0-8237-e7afbf47512b",
    "itwinId": "6c9aba19-76f5-4a21-a4df-a8512df2201e",
    "status": "Active"
}

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 409 Conflict

Invalid request to create a new iTwin job. Duplicate job already in progress.

json

{
    "error": {
        "code": "DuplicateJobInProgress",
        "message": "Job already in progress."
    }
}

Response 422 Unprocessable Entity

Invalid request to create new iTwin job. Make sure request had required properties, and there are no duplicate role ids or members in the remove member actions.

json

{
    "error": {
        "code": "InvalidiTwinJobRequest",
        "message": "Request body or query is invalid.",
        "details": [{
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "actions"
            },
            {
                "code": "InvalidRequestBody",
                "message": "Failed to parse request body or collection is empty."
            },
            {
                "code": "MissingRequiredParameter",
                "message": "Required parameter is missing.",
                "target": "Actions.assignRoles[0].email"
            },
            {
                "code": "MissingRequiredParameter",
                "message": "Required parameter is missing.",
                "target": "Actions.assignRoles[0].memberId"
            },
            {
                "code": "MissingRequiredParameter",
                "message": "Required parameter is missing.",
                "target": "Actions.assignRoles[0].roleIds"
            },
            {
                "code": "InvalidParameter",
                "message": "Required parameter is missing.",
                "target": "Actions.assignRoles[0].roleIds[0]"
            },
            {
                "code": "MissingRequiredParameter",
                "message": "Required parameter is missing.",
                "target": "Actions.unassignRoles[0].email"
            },
            {
                "code": "MissingRequiredParameter",
                "message": "Required parameter is missing.",
                "target": "Actions.unassignRoles[0].memberId"
            },
            {
                "code": "MissingRequiredParameter",
                "message": "Required parameter is missing.",
                "target": "Actions.unassignRoles[0].roleIds"
            },
            {
                "code": "InvalidParameter",
                "message": "Required parameter is missing.",
                "target": "Actions.unassignRoles[0].roleIds[0]"
            },
            {
                "code": "MissingRequiredParameter",
                "message": "Required parameter is missing.",
                "target": "Actions.removeMembers[0].email"
            },
            {
                "code": "MissingRequiredParameter",
                "message": "Required parameter is missing.",
                "target": "Actions.removeMembers[0].memberId"
            },
            {
                "code": "MutuallyExclusivePropertiesProvided",
                "message": "Duplicate property found.",
                "target": "Actions.assignRoles[0].roleIds[1]"
            },
            {
                "code": "MutuallyExclusivePropertiesProvided",
                "message": "Duplicate property found.",
                "target": "Actions.unassignRoles[0].roleIds[1]"
            },
            {
                "code": "MutuallyExclusivePropertiesProvided",
                "message": "Duplicate property found.",
                "target": "Actions.removeMembers[1].email"
            },
            {
                "code": "MutuallyExclusivePropertiesProvided",
                "message": "Duplicate property found.",
                "target": "Actions.removeMembers[1].memberId"
            }
        ]
    }
}

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

iTwinJobActions

assignRoles

iTwinJobAction[]

List of Assign Role Actions

unassignRoles

iTwinJobAction[]

List of Unassign Role Actions

removeMembers

iTwinJobAction[]

List of Remove Member Actions

json

{
    "type": "object",
    "properties": {
        "assignRoles": {
            "type": "array",
            "description": "List of Assign Role Actions",
            "items": {
                "$ref": "#/components/schemas/iTwinJobAction"
            }
        },
        "unassignRoles": {
            "type": "array",
            "description": "List of Unassign Role Actions",
            "items": {
                "$ref": "#/components/schemas/iTwinJobAction"
            }
        },
        "removeMembers": {
            "type": "array",
            "description": "List of Remove Member Actions",
            "items": {
                "$ref": "#/components/schemas/iTwinJobAction"
            }
        }
    },
    "additionalProperties": false
}

iTwinJobAction

String

The email of the member.

memberId

String

(optional) The id of the member.

roleIds

String[]

List of role ids (omit for Remove Member actions).

json

{
    "type": "object",
    "properties": {
        "email": {
            "type": "string",
            "description": "The email of the member."
        },
        "memberId": {
            "type": "string",
            "description": "(optional) The id of the member."
        },
        "roleIds": {
            "type": "array",
            "description": "List of role ids (omit for Remove Member actions).",
            "items": {
                "type": "string"
            }
        }
    },
    "additionalProperties": false
}

Job (create)

actions

iTwinJobActions

Job actions

json

{
    "type": "object",
    "title": "Job (create)",
    "properties": {
        "actions": {
            "description": "Job actions",
            "$ref": "#/components/schemas/iTwinJobActions"
        }
    },
    "additionalProperties": false
}

Job

String

The job id.

itwinId

String

The id of the iTwin

status

iTwinJobStatus

json

{
    "type": "object",
    "title": "Job",
    "properties": {
        "id": {
            "type": "string",
            "description": "The job id."
        },
        "itwinId": {
            "type": "string",
            "description": "The id of the iTwin"
        },
        "status": {
            "$ref": "#/components/schemas/iTwinJobStatus"
        }
    },
    "additionalProperties": false
}

iTwinJobStatus

The status of the job.

Active

String

Completed

String

PartialCompleted

String

Failed

String

json

{
    "type": "string",
    "enum": [
        "Active",
        "Completed",
        "PartialCompleted",
        "Failed"
    ],
    "description": "The status of the job."
}

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.

json

{
    "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.

error

Error

Error information.

json

{
    "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?