Get package role to iTwin project role assignments - 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.

Get package role to iTwin project role assignments

GET https://api.bentley.com/edfs/itwins/{iTwinId}/packages/{uniqueName}/roles

Retrieve information about the current integration package role to iTwin role assignments for this 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

Request

Request parameters

iTwinId

Yes

The iTwin project ID

uniqueName

Yes

The unique name of integration package

Request headers

Content-Type

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

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 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": "InvalidAssignmentListRequest",
        "message": "Cannot retrieve AssignmentList.",
        "details": [{
                "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 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

PackageRole

packageRoleName

String

The name of the integration package role

packageRoleId

String

The ID of the integration package role

json

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

PackageRoleAssignmentDto

iTwinRoleName

String

The name of the iTwin role

iTwinRoleId

String

The ID of the iTwin role

packageRoles

PackageRole[]

List of integration package roles assigned to the iTwin role

json

{
    "type": "object",
    "properties": {
        "iTwinRoleName": {
            "type": "string",
            "description": "The name of the iTwin role"
        },
        "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"
        }
    },
    "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
}

DetailedError

Contains error information and an array of more specific errors.

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

Error[]

Optional array of more specific errors.

json

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

Detailed 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

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed 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 Detailed information.",
            "$ref": "#/components/schemas/DetailedError"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

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

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?