signify-ts
    Preparing search index...

    Class Credentials

    Credentials

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    Methods

    • Delete a credential from the DB

      Parameters

      • said: string

        SAID of the credential

      Returns Promise<void>

    • Get a credential

      Parameters

      • said: string

        SAID of the credential

      Returns Promise<
          {
              anc: | {
                  a: { d: string; i?: string; s: string }[];
                  d: string;
                  i: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: { d: string; i?: string; s: string }[];
                  d: string;
                  i: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  di: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  di: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              };
              ancatc: string;
              anchor: { d: string; pre: string; sn: number };
              atc: string;
              chains: { [key: string]: unknown }[];
              iss: {
                  d: string;
                  dt: string;
                  i: string;
                  ri: string;
                  s: string;
                  t: "iss" | "bis";
                  v: string;
              };
              issatc: string;
              pre: string;
              sad: | {
                  a?: { dt?: string; i?: string; u?: string } & {
                      [key: string]: unknown;
                  };
                  d: string;
                  e?: string;
                  i: string;
                  r?: string;
                  ri?: string;
                  s: string;
                  u?: string;
                  v: string;
              }
              | {
                  A?: string
                  | unknown[];
                  d: string;
                  e?: string;
                  i: string;
                  r?: string;
                  ri?: string;
                  s: string;
                  u?: string;
                  v: string;
              }
              | {
                  a?: { dt?: string; i?: string; u?: string } & {
                      [key: string]: unknown;
                  };
                  d: string;
                  e?: string;
                  i: string;
                  r?: string;
                  rd?: string;
                  s: string;
                  u?: string;
                  v: string;
              }
              | {
                  A?: string
                  | unknown[];
                  d: string;
                  e?: string;
                  i: string;
                  r?: string;
                  rd?: string;
                  s: string;
                  u?: string;
                  v: string;
              };
              schema: {
                  $id: string;
                  $schema: string;
                  additionalProperties: boolean;
                  credentialType: string;
                  description: string;
                  properties: { [key: string]: unknown };
                  required: string[];
                  title: string;
                  type: string;
                  version: string;
              };
              status: | {
                  a: { d: string; i?: string; s: string };
                  d: string;
                  dt: string;
                  et: "iss" | "rev";
                  i: string;
                  ra: Record<string, never>;
                  ri: string;
                  s: string;
                  vn: unknown;
              }
              | {
                  a: { d: string; i?: string; s: string };
                  d: string;
                  dt: string;
                  et: "bis" | "brv";
                  i: string;
                  ra: { d: string; i: string; s: string };
                  ri: string;
                  s: string;
                  vn: unknown;
              };
          },
      >

      A promise to the credential

    • Get a credential

      Parameters

      • said: string

        SAID of the credential

      • includeCESR: false

        Optional flag export the credential in CESR format

      Returns Promise<
          {
              anc: | {
                  a: { d: string; i?: string; s: string }[];
                  d: string;
                  i: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: { d: string; i?: string; s: string }[];
                  d: string;
                  i: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  di: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  di: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              };
              ancatc: string;
              anchor: { d: string; pre: string; sn: number };
              atc: string;
              chains: { [key: string]: unknown }[];
              iss: {
                  d: string;
                  dt: string;
                  i: string;
                  ri: string;
                  s: string;
                  t: "iss" | "bis";
                  v: string;
              };
              issatc: string;
              pre: string;
              sad: | {
                  a?: { dt?: string; i?: string; u?: string } & {
                      [key: string]: unknown;
                  };
                  d: string;
                  e?: string;
                  i: string;
                  r?: string;
                  ri?: string;
                  s: string;
                  u?: string;
                  v: string;
              }
              | {
                  A?: string
                  | unknown[];
                  d: string;
                  e?: string;
                  i: string;
                  r?: string;
                  ri?: string;
                  s: string;
                  u?: string;
                  v: string;
              }
              | {
                  a?: { dt?: string; i?: string; u?: string } & {
                      [key: string]: unknown;
                  };
                  d: string;
                  e?: string;
                  i: string;
                  r?: string;
                  rd?: string;
                  s: string;
                  u?: string;
                  v: string;
              }
              | {
                  A?: string
                  | unknown[];
                  d: string;
                  e?: string;
                  i: string;
                  r?: string;
                  rd?: string;
                  s: string;
                  u?: string;
                  v: string;
              };
              schema: {
                  $id: string;
                  $schema: string;
                  additionalProperties: boolean;
                  credentialType: string;
                  description: string;
                  properties: { [key: string]: unknown };
                  required: string[];
                  title: string;
                  type: string;
                  version: string;
              };
              status: | {
                  a: { d: string; i?: string; s: string };
                  d: string;
                  dt: string;
                  et: "iss" | "rev";
                  i: string;
                  ra: Record<string, never>;
                  ri: string;
                  s: string;
                  vn: unknown;
              }
              | {
                  a: { d: string; i?: string; s: string };
                  d: string;
                  dt: string;
                  et: "bis" | "brv";
                  i: string;
                  ra: { d: string; i: string; s: string };
                  ri: string;
                  s: string;
                  vn: unknown;
              };
          },
      >

      A promise to the credential

    • Get a credential

      Parameters

      • said: string

        SAID of the credential

      • includeCESR: true

        Optional flag export the credential in CESR format

      Returns Promise<string>

      A promise to the credential

    • List credentials

      Parameters

      • Optionalkargs: CredentialFilter = {}

        Optional parameters to filter the credentials

      Returns Promise<
          {
              anc: | {
                  a: { d: string; i?: string; s: string }[];
                  d: string;
                  i: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: { d: string; i?: string; s: string }[];
                  d: string;
                  i: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  di: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  b: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  di: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              }
              | {
                  a: unknown;
                  ba: string[];
                  br: string[];
                  bt: string;
                  c: string[];
                  d: string;
                  i: string;
                  k: string[];
                  kt: string;
                  n: string[];
                  nt: string;
                  p: string;
                  s: string;
                  t: string;
                  v: string;
              };
              ancatc: string;
              anchor: { d: string; pre: string; sn: number };
              atc: string;
              chains: { [key: string]: unknown }[];
              iss: {
                  d: string;
                  dt: string;
                  i: string;
                  ri: string;
                  s: string;
                  t: "iss" | "bis";
                  v: string;
              };
              issatc: string;
              pre: string;
              sad: | {
                  a?: { dt?: string; i?: string; u?: string } & {
                      [key: string]: unknown;
                  };
                  d: string;
                  e?: string;
                  i: string;
                  r?: string;
                  ri?: string;
                  s: string;
                  u?: string;
                  v: string;
              }
              | {
                  A?: string
                  | unknown[];
                  d: string;
                  e?: string;
                  i: string;
                  r?: string;
                  ri?: string;
                  s: string;
                  u?: string;
                  v: string;
              }
              | {
                  a?: { dt?: string; i?: string; u?: string } & {
                      [key: string]: unknown;
                  };
                  d: string;
                  e?: string;
                  i: string;
                  r?: string;
                  rd?: string;
                  s: string;
                  u?: string;
                  v: string;
              }
              | {
                  A?: string
                  | unknown[];
                  d: string;
                  e?: string;
                  i: string;
                  r?: string;
                  rd?: string;
                  s: string;
                  u?: string;
                  v: string;
              };
              schema: {
                  $id: string;
                  $schema: string;
                  additionalProperties: boolean;
                  credentialType: string;
                  description: string;
                  properties: { [key: string]: unknown };
                  required: string[];
                  title: string;
                  type: string;
                  version: string;
              };
              status: | {
                  a: { d: string; i?: string; s: string };
                  d: string;
                  dt: string;
                  et: "iss" | "rev";
                  i: string;
                  ra: Record<string, never>;
                  ri: string;
                  s: string;
                  vn: unknown;
              }
              | {
                  a: { d: string; i?: string; s: string };
                  d: string;
                  dt: string;
                  et: "bis" | "brv";
                  i: string;
                  ra: { d: string; i: string; s: string };
                  ri: string;
                  s: string;
                  vn: unknown;
              };
          }[],
      >

      A promise to the list of credentials

    • Revoke credential

      Parameters

      • name: string

        Name or alias of the identifier

      • said: string

        SAID of the credential

      • Optionaldatetime: string

        date time of revocation

      Returns Promise<RevokeCredentialResult>

      A promise to the long-running operation

    • Get the state of a credential

      Parameters

      • ri: string

        management registry identifier

      • said: string

        SAID of the credential

      Returns Promise<
          | {
              a: { d: string; i?: string; s: string };
              d: string;
              dt: string;
              et: "iss" | "rev";
              i: string;
              ra: Record<string, never>;
              ri: string;
              s: string;
              vn: unknown;
          }
          | {
              a: { d: string; i?: string; s: string };
              d: string;
              dt: string;
              et: "bis" | "brv";
              i: string;
              ra: { d: string; i: string; s: string };
              ri: string;
              s: string;
              vn: unknown;
          },
      >

      A promise to the credential registry state