Skip to main content

IdentityClient.authenticate()

Home > @backstage/plugin-auth-node > IdentityClient > authenticate

Warning: This API is now obsolete.

You should start to use IdentityApi#getIdentity instead of authenticate to retrieve the user identity.

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

Signature:

authenticate(token: string | undefined): Promise<BackstageIdentityResponse>;

Parameters

ParameterTypeDescription
tokenstring | undefined

Returns:

Promise<BackstageIdentityResponse>