Newforma Konekt Web API 2024-12-02

Added:

The IsLimited property has been added to the ProjectUserPermissions object. This property indicates whether a user has restricted, read-only access to a project due to their email domain being whitelisted at the hub level.
Users with IsLimited = true are not direct members of the project but have limited access as part of a whitelisted group.

Affected Endpoints:

The following endpoints are impacted by this change, as the response now includes the IsLimited property:

V2 Endpoints:

• Get project users: GET /v2/hubs/{hubId}/projects/{projectId}/users
• Get project user: GET /v2/hubs/{hubId}/projects/{projectId}/users/{userId}
• Create project user: POST /v2/hubs/{hubId}/projects/{projectId}/users
• Update project user: PUT /v2/hubs/{hubId}/projects/{projectId}/users/{userId}

V3 Endpoints:

• Get project users: GET /v3/hubs/{hubId}/projects/{projectId}/users
• Get project user: GET /v3/hubs/{hubId}/projects/{projectId}/users/{userId}
• Create project user: POST /v3/hubs/{hubId}/projects/{projectId}/users
• Update project user: PUT /v3/hubs/{hubId}/projects/{projectId}/users/{userId}

API Response Example:

[
    {
        "User": {
            "Id": 2,
            "UserName": "b8c0255a-e435-479b-8b92-0dd77c18f9b1",
            "Email": "[email protected]",
            "FirstName": "John",
            "LastName": " Doe",
            "AvatarUrl": "https://www.exampleUrl.com"
        },
        "DefaultFilterTemplateId": null,
        "Role": "Admin",
        "Teams": [],
        "IsReviewer": false,
        "IsLimited": false // Newly added property
    }
]

Impact on Project Users:

When a project has limited access ProjectAccess.Limited, whitelisted users not already in the project will appear in the project users list with the role Reader and the IsLimited property set to true.