Skip to main content

List identifiers

Returns a list of identifiers. Use the optional parameters to filer and sort.

Function​

getIdentifiers(
    query: IdentifierListQuery
  ): Promise<ItemList<IdentifierListItem>>;

Parameters​

export interface IdentifierListQuery extends ListQuery {
  sort?: SortableIdentifierColumnEnum;
  sortDirection?: SortDirection;
  name?: string;
  type?: IdentifierTypeEnum;
  status?: IdentifierStatusEnum;
  exact?: ExactIdentifierFilterColumnEnum[];
  keyAlgorithms?: string[];
  keyRoles?: KeyRoleEnum[];
  keyStorages?: string[];
}

Fields​

  • page - Returns a specific page of the results. The first page is 0.

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

  • organisationId - Value from create organization.

  • 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.

      • [CREATED_DATE, SCHEMA_NAME, ISSUER_DID, STATE]

    • sortDirection - Default value = DESCENDING.

      • [ASCENDING, DESCENDING]

  • name - Return proof requests whose name starts with this string. Not case-sensitive.

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

    • [NAME]

  • keyAlgorithms - Filter by key algorithms. Reference the algorithms from your configuration.

  • keyRoles - The keys used as verification methods for the DID being created. See the Keys object in the API guide for more information.

    • authentication - Used to identify and authenticate the DID subject.

    • assertion - Used to express claims, such as in issuing a credential.

    • keyAgreement - Used to establish confidential communications with the DID subject.

    • capabilityInvocation - Used to invoke a capability the DID subject has, such as access to update the DID document.

    • capabilityDelegation - Used to delegate a capability to another party.

  • keyStorages - Filter by key storage. Reference the algorithms from your configuration.

Return value​

export interface ItemList<Item> {
  totalItems: number;
  totalPages: number;
  values: Item[];
}
export interface IdentifierListItem {
  id: string;
  createdDate: string;
  lastModified: string;
  name: string;
  type: IdentifierTypeEnum;
  isRemote: boolean;
  status: IdentifierStatusEnum;
}

Fields​

  • type - The type of identifier.

  • isRemote - Whether the identifier is local to the system or comes from interaction with an external actor.

  • status - Whether the identifier is active or deactivated.