To achieve the consistency in our User Management API and the data it returns on January 21 of 2021 we introduce the following changes
DEPRECATED endpoints that will be removed on January 21, 2021
GET api/v1/account/users. Deprecation period is over. See the issue #30.
Use GET api/v1/users endpoint instead.
PATCH /api/v1/account/users/{email} Deprecation period is over. See the issue #30.
Use PATCH api/v1/users/{userId} endpoint instead.
GET /api/v1/users/{userId}/properties/{propertyId}/roles.
Use GET api/v1/users/{userId} endpoint instead.
PUT /api/v1/users/{userId}/properties/{propertyId}/roles
Use PATCH api/v1/users/{userId} endpoint instead.
DELETE /api/v1/users/{userId}/properties/{propertyId}
Use PATCH api/v1/users/{userId} endpoint instead.
We will also remove the ability to load users by email, you can now only use subjectId as identifier for a user.
NEW
New property propertyRoles in UserModel that GET api/v1/users/{userId} endpoint returns. This is a temporary property which implementation supposes to replace the implementation of properties after the next deprecation period is over (~ on April 21, 2021). It contains the breakdown of roles for each property that user has access to:
To achieve the consistency in our User Management API and the data it returns on January 21 of 2021 we introduce the following changes
DEPRECATED endpoints that will be removed on January 21, 2021
GET api/v1/account/users
. Deprecation period is over. See the issue #30. UseGET api/v1/users
endpoint instead.PATCH /api/v1/account/users/{email}
Deprecation period is over. See the issue #30. UsePATCH api/v1/users/{userId}
endpoint instead.GET /api/v1/users/{userId}/properties/{propertyId}/roles
. UseGET api/v1/users/{userId}
endpoint instead.PUT /api/v1/users/{userId}/properties/{propertyId}/roles
UsePATCH api/v1/users/{userId}
endpoint instead.DELETE /api/v1/users/{userId}/properties/{propertyId}
UsePATCH api/v1/users/{userId}
endpoint instead.We will also remove the ability to load users by email, you can now only use
subjectId
as identifier for a user.NEW
propertyRoles
inUserModel
thatGET api/v1/users/{userId}
endpoint returns. This is a temporary property which implementation supposes to replace the implementation ofproperties
after the next deprecation period is over (~ on April 21, 2021). It contains the breakdown of roles for each property that user has access to: