Class Credentials

constructor

• new Credentials(client): Credentials

• Credentials

  Parameters

  • client: SignifyClient

  Returns Credentials

client

get

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

• Get a credential

  Parameters

  • said: string

    SAID of the credential

  • Optional includeCESR: boolean = false

    Optional flag export the credential in CESR format

  Returns Promise<any>

  A promise to the credential

  Async

issue

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

• Issue a credential

  Parameters

  • name: string

  • args: CredentialData

  Returns Promise<IssueCredentialResult>

list

• list(kargs?): Promise<any>

• List credentials

  Parameters

  • Optional kargs: CredentialFilter = {}

    Optional parameters to filter the credentials

  Returns Promise<any>

  A promise to the list of credentials

  Async

present

• present(name, said, recipient, include?): Promise<string>

• Present a credential

  Parameters

  • name: string

    Name or alias of the identifier

  • said: string

    SAID of the credential

  • recipient: string

    Identifier prefix of the receiver of the presentation

  • Optional include: boolean = true

    Flag to indicate whether to stream credential alongside presentation exchange message

  Returns Promise<string>

  A promise to the long-running operation

  Async

request

• request(name, recipient, schema, issuer?): Promise<string>

• Request a presentation of a credential

  Parameters

  • name: string

    Name or alias of the identifier

  • recipient: string

    Identifier prefix of the receiver of the presentation

  • schema: string

    SAID of the schema

  • Optional issuer: string

    Optional prefix of the issuer of the credential

  Returns Promise<string>

  A promise to the long-running operation

  Async

revoke

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

• Revoke credential

  Parameters

  • name: string

    Name or alias of the identifier

  • said: string

    SAID of the credential

  • Optional datetime: string

    date time of revocation

  Returns Promise<RevokeCredentialResult>

  A promise to the long-running operation

  Async