• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Querying Key Aliases (ArkTS)
2
3<!--Kit: Universal Keystore Kit-->
4<!--Subsystem: Security-->
5<!--Owner: @wutiantian-gitee-->
6<!--Designer: @HighLowWorld-->
7<!--Tester: @wxy1234564846-->
8<!--Adviser: @zengyawen-->
9
10This topic walks you through on how to query key aliases.
11
12>**NOTE**
13> <!--RP1-->The mini-system devices<!--RP1End--> do not support query of key aliases.
14
15## How to Develop
16
171. Initialize the key property set to query the tags of key aliases. The tags support only [HUKS_TAG_AUTH_STORAGE_LEVEL](../../reference/apis-universal-keystore-kit/capi-native-huks-type-h.md#oh_huks_authstoragelevel).
18
192. Use [listAliases](../../reference/apis-universal-keystore-kit/js-apis-huks.md#hukslistaliases12) to query the key aliases.
20
21```ts
22/*
23 * The following example uses promise-based APIs to query key aliases.
24 */
25import { huks } from '@kit.UniversalKeystoreKit';
26
27async function testListAliases() {
28  /* 1. Initialize the key property set. */
29  let queryProperties: Array<huks.HuksParam> = [
30    {
31      tag: huks.HuksTag.HUKS_TAG_AUTH_STORAGE_LEVEL,
32      value: huks.HuksAuthStorageLevel.HUKS_AUTH_STORAGE_LEVEL_DE
33    }
34  ];
35  let queryOptions: huks.HuksOptions = {
36    properties: queryProperties
37  };
38
39  try {
40    /* 2. Query key aliases. */
41    let result: huks.HuksListAliasesReturnResult = await huks.listAliases(queryOptions);
42    console.info(`promise: listAliases success`);
43  } catch (error) {
44    console.error(`promise: listAliases fail`);
45  }
46}
47```
48