Skip to main content

UserIdentity

Home > @backstage/core-components > UserIdentity

An implementation of the IdentityApi that is constructed using various backstage user identity representations.

Signature:

class UserIdentity implements IdentityApi 

Implements: IdentityApi

Methods

Method

Modifiers

Description

create(options)

static

Creates a new IdentityApi implementation using a user identity and an auth API that will be used to request backstage tokens.

createGuest()

static

Creates a new IdentityApi that acts as a Guest User.

fromLegacy(result)

static

Creates a new IdentityApi using a legacy SignInResult object.

getBackstageIdentity()

getCredentials()

getIdToken()

getProfile()

getProfileInfo()

getUserId()

signOut()