Skip to main content

List trust anchors

Returns a list of trust anchors.

Function

getTrustAnchors(
query: TrustAnchorListQuery
): Promise<ItemList<TrustAnchorListItem>>;

Parameters

export interface TrustAnchorListQuery
extends Omit<ListQuery, "organisationId"> {
sort?: SortableTrustAnchorColumnEnum;
sortDirection?: SortDirection;
name?: string;
exact?: ExactTrustAnchorFilterColumnEnum[];
type?: string;
isPublisher?: boolean;
}
  • page - Returns a specific page of the results. The first page is 0.

  • pageSize - Specify how many items appear on each page.

  • sorting - If no sorting values are provided, CREATED_DATE + DESCENDING are used. If a value is passed for sort, the default direction becomes ASCENDING.

    • sort - Sort by certain values in the response body.

      • [NAME, CREATED_DATE, TYPE]
    • sortDirection - Default value = DESCENDING.

      • [ASCENDING, DESCENDING]
  • name - Return only trust anchors with names starting with this string. Not case-sensitive.

  • isPublisher - Filter by trust anchors published and trust anchors subscribed to.

  • type - Filter by the type of trust management. Values from the configuration.

  • exact - Set which filters apply in an exact way.

    • [NAME, TYPE]

Return value

A list of trust anchors matching the filters is returned.