List trust entities

Returns a list of trust entities. Use the params to filter. For mobile devices, use the remote trust entity functions.

Related guide: Trust management

Function

React Native

getTrustEntities(
    query: TrustEntityListQuery
  ): Promise<ItemList<TrustEntityListItem>>;

iOS

func listTrustEntities(filters: ListTrustEntitiesFiltersBindings) throws  -> TrustEntitiesListBindingDto

Android

fun `listTrustEntities`(`filters`: ListTrustEntitiesFiltersBindings): TrustEntitiesListBindingDto

Parameters

React Native

export interface TrustEntityListQuery {
  sort?: SortableTrustEntityColumnEnum;
  sortDirection?: SortDirection;
  name?: string;
  exact?: ExactTrustEntityFilterColumnEnum[];
  type?: string;
  isPublisher?: boolean;
}

iOS

public struct ListTrustEntitiesFiltersBindings {
    public var page: UInt32
    public var pageSize: UInt32
    public var sort: SortableTrustEntityColumnBindings?
    public var sortDirection: SortDirection?
    public var name: String?
    public var role: TrustEntityRoleBindingEnum?
    public var trustAnchor: String?
    public var didId: String?
    public var organisationId: String?
    public var exact: [ExactTrustEntityFilterColumnBindings]?
}

Android

data class ListTrustEntitiesFiltersBindings (
    var `page`: kotlin.UInt,
    var `pageSize`: kotlin.UInt,
    var `sort`: SortableTrustEntityColumnBindings?,
    var `sortDirection`: SortDirection?,
    var `name`: kotlin.String?,
    var `role`: TrustEntityRoleBindingEnum?,
    var `trustAnchor`: kotlin.String?,
    var `didId`: kotlin.String?,
    var `organisationId`: kotlin.String?,
    var `exact`: List<ExactTrustEntityFilterColumnBindings>?
)

• 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, ROLE]

  • sortDirection - Default value = DESCENDING.

    • [ASCENDING, DESCENDING]

• name - Return only trust entities with names starting with this string. Not case-sensitive.

• role - Filter by what the entity is trusted to do.

  • [ISSUER, VERIFIER, BOTH]

• trustAnchor - Return trust entities from a particular trust anchor.

• didId - Return trust entities by a particular DID.

• organisationId - Return trust entities by a particular organisation.

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

  • [NAME]

Return value

A list of trust entities matching the filters is returned.