Class IdentityClient`Experimental`

An identity client to interact with auth-backend and authenticate Backstage tokens

This is not a stable API yet

Deprecated

Please migrate to the DefaultIdentityClient.

Index

Methods

authenticate create

Methods

authenticate

authenticate(token: string | undefined): Promise<BackstageIdentityResponse>
Experimental
Verifies the given backstage identity token Returns a BackstageIdentity (user) matching the token. The method throws an error if verification fails.
Parameters
- token: string | undefined
Returns Promise<BackstageIdentityResponse>
Deprecated
You should start to use IdentityApi#getIdentity instead of authenticate to retrieve the user identity.
- Defined in plugins/auth-node/src/identity/IdentityClient.ts:49

`Static`create

create(options: IdentityClientOptions): IdentityClient
Experimental
Parameters
- options: IdentityClientOptions
Returns IdentityClient
- Defined in plugins/auth-node/src/identity/IdentityClient.ts:33