Merge pull request #27264 from Parsifal-M/docs/update-coreservices-identity

[DOCS] Adds some additional notes/context to the coreServices
This commit is contained in:
Patrik Oldsberg
2024-10-19 19:20:15 +02:00
committed by GitHub
2 changed files with 12 additions and 2 deletions
@@ -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
@@ -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