core-plugin-api: remove deprecated id field from BackstageIdentityResponse

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2022-01-04 23:31:50 +01:00
parent 234a36405b
commit d879072b0c
3 changed files with 7 additions and 8 deletions
+7
View File
@@ -0,0 +1,7 @@
---
'@backstage/core-plugin-api': minor
---
Removed the deprecated `id` field of `BackstageIdentityResponse`.
Existing usage can be replaced by parsing the `name` of the `identity.userEntityRef` with `parseEntityRef` from `@backstage/catalog-model`, although note that it is recommended to consume the entire `userEntityRef` in order to support namespaces.
-1
View File
@@ -216,7 +216,6 @@ export type BackstageIdentityApi = {
// @public
export type BackstageIdentityResponse = {
id: string;
token: string;
identity: BackstageUserIdentity;
};
@@ -221,13 +221,6 @@ export type BackstageUserIdentity = {
* @public
*/
export type BackstageIdentityResponse = {
/**
* The backstage user ID.
*
* @deprecated The identity is now provided via the `identity` field instead.
*/
id: string;
/**
* The token used to authenticate the user within Backstage.
*/