CatalogIdentityClient

Home > @backstage/plugin-auth-backend > CatalogIdentityClient

A catalog client tailored for reading out identity data from the catalog.

Signature:

class CatalogIdentityClient 

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Constructs a new instance of the `CatalogIdentityClient` class

Methods

Method Modifiers Description

Method	Modifiers	Description
findUser(query)		Looks up a single user using a query. Throws a NotFoundError or ConflictError if 0 or multiple users are found.
resolveCatalogMembership(query)		Resolve additional entity claims from the catalog, using the passed-in entity names. Designed to be used within a `signInResolver` where additional entity claims might be provided, but group membership and transient group membership lean on imported catalog relations. Returns a superset of the entity names that can be passed directly to `issueToken` as `ent`.

findUser(query)

Looks up a single user using a query.

Throws a NotFoundError or ConflictError if 0 or multiple users are found.

resolveCatalogMembership(query)

Resolve additional entity claims from the catalog, using the passed-in entity names. Designed to be used within a signInResolver where additional entity claims might be provided, but group membership and transient group membership lean on imported catalog relations.

Returns a superset of the entity names that can be passed directly to issueToken as ent.

Constructors​

Methods​

Constructors

Methods