Class DefaultIdentityClient`Experimental`

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

This is not a stable API yet

Implements

IdentityApi

Index

Methods

authenticate getIdentity 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 getIdentity instead of authenticate to retrieve the user identity.
- Defined in plugins/auth-node/src/identity/DefaultIdentityClient.ts:102

getIdentity

getIdentity(
options: IdentityApiGetIdentityRequest,
): Promise<BackstageIdentityResponse | undefined>
Experimental
Verifies the given backstage identity token Returns a BackstageIdentity (user) matching the token. The method throws an error if verification fails.
Parameters
- options: IdentityApiGetIdentityRequest
Returns Promise<BackstageIdentityResponse | undefined>
Implementation of IdentityApi.getIdentity
- Defined in plugins/auth-node/src/identity/DefaultIdentityClient.ts:78

`Static`create

create(options: IdentityClientOptions): DefaultIdentityClient
Experimental
Create a new DefaultIdentityClient instance.
Parameters
- options: IdentityClientOptions
Returns DefaultIdentityClient
- Defined in plugins/auth-node/src/identity/DefaultIdentityClient.ts:66