Get available EDFS package roles - Enterprise Data Federation Service (EDFS)

REST API Overview

Overview

Samples

Reference

Changelog

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 available EDFS package roles

GET https://api.bentley.com/edfs/packages/roles

Retrieve information about the currently available integration package roles assignable to 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

Request

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

{
    "packageRoles": [{
        "roleId": "00000000-0000-0000-0000-000000000000",
        "name": "Execute Integration Package",
        "description": "Execute Integration Package"
    }]
}

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

PackageRoleDto

roleId

String

name

String

The name of the integration package role

description

String

The description of the integration package role

PackageRoleDtoList

packageRoles

PackageRoleDto[]

List of available integration package roles

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.