From 3f109966b47ad83eaf8fcabae02db826502dae0b Mon Sep 17 00:00:00 2001 From: Peter Macdonald Date: Sat, 19 Oct 2024 16:43:40 +0200 Subject: [PATCH] Ads some additional notes to the coreservices docs to just nudge people in the right direction Signed-off-by: Peter Macdonald --- docs/backend-system/core-services/identity.md | 6 ++++++ docs/backend-system/core-services/user-info.md | 8 ++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/backend-system/core-services/identity.md b/docs/backend-system/core-services/identity.md index eb7d1f4ac7..b4baf99682 100644 --- a/docs/backend-system/core-services/identity.md +++ b/docs/backend-system/core-services/identity.md @@ -5,6 +5,12 @@ sidebar_label: Identity description: Documentation for the Identity service --- +:::note Note + +This service is deprecated, you are likely looking for the [Auth Service](./auth.md) instead. If you're wondering how to get the user's entity ref and ownership claims in your backend plugin, you should see the [User Info Service](./user-info.md) documentation. + +::: + When working with backend plugins, you might find that you will need to interact with the `auth-backend` plugin to both authenticate backstage tokens, and to deconstruct them to get the user's entity ref and/or ownership claims out of them. ## Using the service diff --git a/docs/backend-system/core-services/user-info.md b/docs/backend-system/core-services/user-info.md index 73f461d1ec..3a2480dd9f 100644 --- a/docs/backend-system/core-services/user-info.md +++ b/docs/backend-system/core-services/user-info.md @@ -9,8 +9,12 @@ This service lets you extract more information about a set of user credentials. Specifically, it can be used to extract the ownership entity refs for a user principal. -See also the [`auth`](./auth.md) and [`httpAuth`](./http-auth.md) services for -general credentials handling. +:::note Note + +Please also refer to [`auth`](./auth.md) and [`httpAuth`](./http-auth.md) services for +general credentials handling which is a prerequisite for the below examples. + +::: ## Using the Service