Interface IdentityApi`Experimental`

An identity client api to authenticate Backstage tokens

This is not a stable API yet

interface IdentityApi {
    getIdentity(
        options: IdentityApiGetIdentityRequest,
    ): Promise<BackstageIdentityResponse | undefined>;
}

Implemented by

DefaultIdentityClient

Index

Methods

Methods

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>
- Defined in plugins/auth-node/src/identity/IdentityApi.ts:42