Class Credentials

constructor

• new Credentials(client: SignifyClient): Credentials

  Credentials

  Parameters

  • client: SignifyClient

  Returns Credentials

client

delete

• delete(said: string): Promise<void>

  Delete a credential from the DB

  Parameters

  • said: string

    SAID of the credential

  Returns Promise<void>

  Async

get

• get(said: string, includeCESR?: boolean): Promise<any>

  Get a credential

  Parameters

  • said: string

    SAID of the credential
  • OptionalincludeCESR: boolean = false

    Optional flag export the credential in CESR format

  Returns Promise<any>

  A promise to the credential

  Async

issue

• issue(name: string, args: CredentialData): Promise<IssueCredentialResult>

  Creates a credential in the specified registry to be GRANTed with IPEX to the intended recipient

  Parameters

  • name: string
  • args: CredentialData

  Returns Promise<IssueCredentialResult>

list

• list(kargs?: CredentialFilter): Promise<any>

  List credentials

  Parameters

  • Optionalkargs: CredentialFilter = {}

    Optional parameters to filter the credentials

  Returns Promise<any>

  A promise to the list of credentials

  Async

revoke

• revoke(
      name: string,
      said: string,
      datetime?: string,
  ): Promise<RevokeCredentialResult>

  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

  Async

state

• state(ri: string, said: string): Promise<CredentialState>

  Get the state of a credential

  Parameters

  • ri: string

    management registry identifier
  • said: string

    SAID of the credential

  Returns Promise<CredentialState>

  A promise to the credential registry state

  Async