Swagger API changes - 20.11-LTS
This page summarizes the API changes needs to be considered during the Codebeamer upgrade to 20.11.
User data
Permissions
User data access has been revised and from 20.11 they can only be accessed with the proper permissions.
These permissions can configured on user group level:
{Codebeamer url}/sysadmin/userGroups.spr?groupId={groupId}
For Example in case the API user doesn't have Account - View Email Address permissions the email property won't be populated in the User and UserReference models.
Extended UserReference model
Following the feedback of our customers we have extended the UserReference to contain the email address of the referenced account. This only happens if the Account - View Email Address permission is granted for the API user (see the details in the previous section).
{
"id": 123,
"name": "user_name",
"type": "UserReference",
"email": "user@example.com"
},
"id": 123,
"name": "user_name",
"type": "UserReference",
"email": "user@example.com"
},
Accounts - Admin permission checks
As a result of the proper user data permission checks we have removed the restrictions on every user related endpoint.
Since 20.11 the following endpoints won't need Accounts - Admin user group permission to be called:
• /v3/users
• /v3/users/{userId}