Class default

constructor

• new default(options): default

• The constructor for the OIDC client

  Parameters

  • options: ConstructorObject

    The configuration object for the OIDC client

  Returns default

Readonlyattributes

ReadonlycallbackURL

ReadonlyclientID

ReadonlyspidLevel

ReadonlytrustMarks

authorization

• authorization(idp): Promise<{
      error?: string;
      ok: boolean;
      url?: string;
  }>

• Get the login URL for the given IDP, to which the user will be redirected to, in order to start the authentication process

  Parameters

  • idp: string

    The IDP ID for which to get the login URL

  Returns Promise<{
      error?: string;
      ok: boolean;
      url?: string;
  }>

  The response object

callback

• callback(__namedParameters): Promise<{
      error?: string;
      ok: boolean;
      payload?: Record<string, string>;
  }>

• Handle a callback from the IDP after the authentication process has been completed

  Parameters

  • __namedParameters: {
        code: string;
        iss: string;
        state: string;
    }

    • code: string

    • iss: string

    • state: string

  Returns Promise<{
      error?: string;
      ok: boolean;
      payload?: Record<string, string>;
  }>

  The requested user information

federationEndpoint

• federationEndpoint(federation_entity, opts?): Promise<string | object>

• Get the OIDC Federation endpoint for the IDP

  Parameters

  • federation_entity: {
        contacts: string[];
        organization_name: string;
    }

    Object that will be included in the federation_entity field of the federation

    • contacts: string[]

    • organization_name: string

  • opts: {
        json: boolean;
    } = ...

    Additional options

    • json: boolean

  Returns Promise<string | object>

  The requested entity statement

getProvider

• getProvider(idp): Promise<ParsedIDP>

• Get the information about a provider, automatically validating it if necessary, otherwise returning the cached version

  Parameters

  • idp: string

    Identity provider ID (as defined in the configuration)

  Returns Promise<ParsedIDP>

  The provider object

  Throws

  If it's not possibile to find the provider, its configuration or validating it