Class export=

constructor

• new "export="(): export=

  Returns export=

Static ReadonlyEVENTS

Static ReadonlyREALM_PREFIX

Staticcanonical

• canonical(value: any): string

  Writes a value as canonical JSON, members sorted at every level, so two records that say the same thing compare equal.

  Parameters

  • value: any

    the value

  Returns string

  the JSON text

Statichistory

• history(key: string): SubordinateEvent[]

  Reads a subordinate's history, oldest first, each event once (the earliest copy of an id a cluster recorded twice).

  Parameters

  • key: string

    the subordinate's key

  Returns SubordinateEvent[]

  the events

StaticinformationUriOf

• informationUriOf(value: any): string

  Checks a value as the draft's information_uri: an http or https URL with no user information, at most 2048 characters.

  Parameters

  • value: any

    the value

  Returns string

  the URL, '' when the value is empty, or null when it is something else

Staticknown

• known(key: string): boolean

  Answers whether anything was ever recorded about a subordinate.

  Parameters

  • key: string

    the subordinate's key

  Returns boolean

  true when it has a history

StaticrealmCreated

• realmCreated(realmId: string, createdAt: any): void

  Records a realm's creation as its registration, in the default realm's register, while the default topology makes every realm a subordinate.

  Parameters

  • realmId: string

    the realm id

  • createdAt: any

    when it was created, which fixes the event's id on every node

  Returns void

StaticrealmKey

• realmKey(realmId: string): string

  Answers the key a realm of this service is recorded under.

  Parameters

  • realmId: string

    the realm id

  Returns string

  realm: and the id

StaticrealmKeys

• realmKeys(): string[]

  Lists the keys of every realm of this service recorded in the ambient realm's register, live or deleted.

  Returns string[]

  the keys

StaticrealmKeysChanged

• realmKeysChanged(realmId: string, what: string): void

  Records a change to a realm's Federation Entity Keys as a jwks_update, in the default realm's register.

  Parameters

  • realmId: string

    the realm id

  • what: string

    the event's description

  Returns void

StaticrealmOfKey

• realmOfKey(key: string): string

  Answers the realm id a key names.

  Parameters

  • key: string

    a subordinate's key

  Returns string

  the realm id, or '' for a registered subordinate's key

StaticrealmRemoved

• realmRemoved(realmId: string, createdAt: any): void

  Records a realm's deletion as its revocation, in the default realm's register, while the default topology makes every realm a subordinate.

  Parameters

  • realmId: string

    the realm id

  • createdAt: any

    when it was created, which fixes the event's id on every node

  Returns void

Staticrecord

• record(
      key: string,
      entityId: string,
      event: string,
      options?: any,
  ): SubordinateEvent

  Records one event about a subordinate.

  A failure to write is logged under STS-OIDFED-0065 and never fails the act that caused it.

  Parameters

  • key: string

    the subordinate's key

  • entityId: string

    its Entity Identifier, where known

  • event: string

    one of EVENTS

  • Optionaloptions: any

    description, informationUri, atMs (default now) and id (default random)

  Returns SubordinateEvent

  the event as written, or null when the register could not be written

  Throws

  Error when event is not a subordinate event

StaticupdatesBetween

• updatesBetween(before: any, after: any): string[]

  Lists the update events between two records of one registered subordinate, one per part that changed, in the draft's order.

  Parameters

  • before: any

    the record before

  • after: any

    the record after

  Returns string[]

  the events: metadata_policy_update, metadata_update, jwks_update and constraints_update, as they apply