AuthResolverCatalogUserQuery

Home > @backstage/plugin-auth-node > AuthResolverCatalogUserQuery

A query for a single user in the catalog.

If entityRef is used, the default kind is 'User'.

If annotations are used, all annotations must be present and match the provided value exactly. Only entities of kind 'User' will be considered.

If filter are used, only entities of kind 'User' will be considered unless it is explicitly specified differently in the filter.

Regardless of the query method, the query must match exactly one entity in the catalog, or an error will be thrown.

Signature:

export type AuthResolverCatalogUserQuery = {
    entityRef: string | {
        kind?: string;
        namespace?: string;
        name: string;
    };
} | {
    annotations: Record<string, string>;
} | {
    filter: EntityFilterQuery;
};

References: EntityFilterQuery