Skip to main content

IdentityApi.getIdentity()

Home > @backstage/plugin-auth-node > IdentityApi > getIdentity

Verifies the given backstage identity token Returns a BackstageIdentity (user) matching the token. The method throws an error if verification fails.

Signature:

getIdentity(options: IdentityApiGetIdentityRequest): Promise<BackstageIdentityResponse | undefined>;

Parameters

ParameterTypeDescription
optionsIdentityApiGetIdentityRequest

Returns:

Promise<BackstageIdentityResponse | undefined>