Class Identifier

constructor

• new Identifier(client): Identifier

• Identifier

  Parameters

  • client: IdentifierDeps

  Returns Identifier

client

addEndRole

• addEndRole(name, role, eid?, stamp?): Promise<EventResult>

• Authorize an endpoint provider in a given role for a managed identifier

  Parameters

  • name: string

    Name or alias of the identifier

  • role: string

    Authorized role for eid

  • Optional eid: string

    Optional qb64 of endpoint provider to be authorized

  • Optional stamp: string

    Optional date-time-stamp RFC-3339 profile of iso8601 datetime. Now is the default if not provided

  Returns Promise<EventResult>

  A promise to the result of the authorization

  Remarks

  Typically used to authorize the agent to be the endpoint provider for the identifier in the role of agent

  Async

create

• create(name, kargs?): Promise<EventResult>

• Create a managed identifier

  Parameters

  • name: string

    Name or alias of the identifier

  • Optional kargs: CreateIdentiferArgs = {}

    Optional parameters to create the identifier

  Returns Promise<EventResult>

  The inception result

  Async

createInteract

• createInteract(name, data?): Promise<{
      jsondata: any;
      serder: any;
      sigs: any;
  }>

• Parameters

  • name: string

  • Optional data: any

  Returns Promise<{
      jsondata: any;
      serder: any;
      sigs: any;
  }>

get

• get(name): Promise<HabState>

• Get information for a managed identifier

  Parameters

  • name: string

    Prefix or alias of the identifier

  Returns Promise<HabState>

  A promise to the identifier information

  Async

interact

• interact(name, data?): Promise<EventResult>

• Generate an interaction event in a managed identifier

  Parameters

  • name: string

    Prefix or alias of the identifier

  • Optional data: any

    Option data to be anchored in the interaction event

  Returns Promise<EventResult>

  A promise to the interaction event result

  Async

list

• list(start?, end?): Promise<any>

• List managed identifiers

  Parameters

  • Optional start: number = 0

    Start index of list of notifications, defaults to 0

  • Optional end: number = 24

    End index of list of notifications, defaults to 24

  Returns Promise<any>

  A promise to the list of managed identifiers

  Async

members

• members(name): Promise<any>

• Get the members of a group identifier

  Parameters

  • name: string

    Name or alias of the identifier

  Returns Promise<any>

  • A promise to the list of members

  Async

rotate

• rotate(name, kargs?): Promise<EventResult>

• Generate a rotation event in a managed identifier

  Parameters

  • name: string

    Name or alias of the identifier

  • Optional kargs: RotateIdentifierArgs = {}

    Optional parameters requiered to generate the rotation event

  Returns Promise<EventResult>

  A promise to the rotation event result

update

• update(name, info): Promise<HabState>

• Update managed identifier

  Parameters

  • name: string

    Prefix or alias of the identifier

  • info: IdentifierInfo

    Information to update for the given identifier

  Returns Promise<HabState>

  A promise to the identifier information after updating

  Async