Remove all package role assignments for specified iTwin roles - Enterprise Data Federation Service (EDFS)

Enterprise Data Federation Service (EDFS)

Download API definition:

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

Remove all package role assignments for specified iTwin roles

put https://dev-api.bentley.com/edfs/itwins/{iTwinId}/packages/{uniqueName}/roles/remove-itwin-roles

Remove all existing integration package role assignments for specified iTwin roles for the integration package.

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 be an Organization Administrator for the Organization that owns a given Project or have administration_manage_roles permission assigned at the Project level.

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.

User must also have the following permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin:

edfs_ilsmng to Manage Access to specific Integration Packages

Each integration package role has its own permission(s) assigned and the user who wants to manage them must have these permissions assigned as well.

Package roles and associated permissions

Execute Integration Package
- edfs_objipexec to Execute Integration Package(s)

Request

Request parameters

iTwinId

Yes

The iTwin project ID

uniqueName

Yes

The unique name of integration package

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

ITwinRoleList

iTwinRoleIds

String[]

List of iTwin role IDs

Example

json

{
    "iTwinRoleIds": ["00000000-0000-0000-0000-000000000000"]
}

Response

Response 200 OK

json

{
    "assignments": [{
        "iTwinRoleName": "EDFS_integration",
        "iTwinRoleId": "00000000-0000-0000-0000-000000000000",
        "packageRoles": [{
            "packageRoleName": "Execute Integration Package",
            "packageRoleId": "00000000-0000-0000-0000-000000000000"
        }]
    }]
}

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 iTwin or integration package was not found.

json

{
    "error": {
        "code": "AssignmentListNotFound",
        "message": "Requested AssignmentList is not available."
    }
}

Response 422 Unprocessable Entity

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)

json

{
    "error": {
        "code": "InvalidITwinRoleListRequest",
        "message": "Cannot update ITwinRoleList.",
        "details": [{
            "code": "InvalidValue",
            "message": "Provided iTwin Role ID value is not valid.",
            "target": "ITwinRoleIds"
        }, {
            "code": "InvalidValue",
            "message": "Provided iTwin ID value is not valid.",
            "target": "iTwinId"
        }, {
            "code": "InvalidValue",
            "message": "Provided Unique Name value contains invalid characters.",
            "target": "uniqueName"
        }]
    }
}

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

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
}

PackageRole

packageRoleId

String

The ID of the integration package role

packageRoleName

String

The name of the integration package role

json

{
    "type": "object",
    "properties": {
        "packageRoleId": {
            "type": "string",
            "description": "The ID of the integration package role"
        },
        "packageRoleName": {
            "type": "string",
            "description": "The name of the integration package role"
        }
    },
    "additionalProperties": false
}

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message",
        "details"
    ],
    "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."
        },
        "details": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Error"
            },
            "description": "Optional array of more specific errors."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information and an array of more specific errors.",
    "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
}

ITwinRoleList

iTwinRoleIds

String[]

List of iTwin role IDs

json

{
    "type": "object",
    "properties": {
        "iTwinRoleIds": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "List of iTwin role IDs"
        }
    },
    "additionalProperties": false
}

Detailed Error Response

error

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed Error Response",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/DetailedError",
            "description": "Error Detailed 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
}

PackageRoleAssignmentDto

iTwinRoleId

String

The ID of the iTwin role

packageRoles

PackageRole[]

List of integration package roles assigned to the iTwin role

iTwinRoleName

String

The name of the iTwin role

json

{
    "type": "object",
    "properties": {
        "iTwinRoleId": {
            "type": "string",
            "description": "The ID of the iTwin role"
        },
        "packageRoles": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/PackageRole"
            },
            "description": "List of integration package roles assigned to the iTwin role"
        },
        "iTwinRoleName": {
            "type": "string",
            "description": "The name of the iTwin role"
        }
    },
    "additionalProperties": false
}

PackageRoleAssignmentDtoList

assignments

PackageRoleAssignmentDto[]

List of iTwin roles and their corresponding integration package roles

json

{
    "type": "object",
    "properties": {
        "assignments": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/PackageRoleAssignmentDto"
            },
            "description": "List of iTwin roles and their corresponding integration package roles"
        }
    },
    "additionalProperties": false
}

Was this page helpful?