Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FederationClient

Defines a basic interface for a federation endpoint that provides a security token for authentication. NOTE: Some class that implements this interface may not be async in nature. But since some class's method are async, keep it consistent by making it async.

Hierarchy

  • FederationClient

Implemented by

Methods

getSecurityToken

  • getSecurityToken(): Promise<string>

getStringClaim

  • getStringClaim(key: string): Promise<string | null>

refreshAndGetSecurityToken

  • refreshAndGetSecurityToken(): Promise<string>
  • Gets a security token from the federation endpoint. This will always retreive a new token from the federation endpoint and does not use a cached token.

    Returns Promise<string>

    A security token that can be used to authenticate requests.