Skip to main content

AuthFoundation/public

Index

Claims

Classes

Enumerations

Interfaces

JWT

Type Aliases

Claims

IsClaim

IsClaim<T>: { rawValue: String }

Indicates the supplied type can be used as a claim within HasClaims.

Type parameters

  • T

Type declaration

  • [id string]: T | string
  • readonlyrawValue: String

    The raw string value of the claim.

    For languages that support a string value backing an enumeration case, this property need not be implemented.

Type Aliases

APIClientError

APIClientError: Error

APIRateLimit

APIRateLimit: { delay?: TimeInterval; limit: number; remaining: number; reset: TimeInterval }

Describes information related to the organization's current rate limit.

Type declaration

  • optionalreadonlydelay?: TimeInterval

    The calculated delay from the reset limit and the date header.

  • readonlylimit: number

    The current limit.

  • readonlyremaining: number

    The rate limit remaining.

  • readonlyreset: TimeInterval

    The time offset from UTC when the rate limit will reset, and a request may be retried.

APIResponse

APIResponse<ResponseType>: { date: Date; links: { [ LINK in self | next | previous ]: URL }; rateInfo?: APIRateLimit; requestId?: String; result: ResponseType; statusCode: Number }

Describes a response from a network request, which includes the supplied result, and other associated response metadata used by the client.

Type parameters

  • ResponseType

    The response model type expected.

Type declaration

  • readonlydate: Date

    The date the response was received, as reported by the server.

  • readonlylinks: { [ LINK in self | next | previous ]: URL }

    Information about links between related resources.

  • optionalreadonlyrateInfo?: APIRateLimit

    Information about the current rate limit.

  • optionalreadonlyrequestId?: String

    The ID for the current request.

  • readonlyresult: ResponseType

    Result provided from the request.

  • readonlystatusCode: Number

    The actual HTTP status code for the result.

APIRetry

APIRetry: { retryCount?: number; shouldRetry: boolean }

Configurtes the available retry options.

Type declaration

  • optionalretryCount?: number

    The maximum number of times the request should be retried.

  • shouldRetry: boolean

    Whether or not the request should be retried.

HTTPBody

HTTPBody: string

HTTPMethod

HTTPMethod: GET | DELETE | HEAD | POST | PUT | PATCH

HTTPRequest

HTTPRequest: { headers: {}; method: HTTPMethod; url: string }

Type declaration

  • headers: {}
    • [index string]: string
  • method: HTTPMethod
  • url: string

HTTPResponse

HTTPResponse: { body: HTTPBody; headers: {}; statusCode: Number }

Type declaration

  • body: HTTPBody
  • headers: {}
    • [index string]: string
  • statusCode: Number

NetworkInterface

NetworkInterface: any

OAuth2ClientAuthenticationType

OAuth2ClientAuthenticationType: OAuth2ClientAuthenticationNone | OAuth2ClientAuthenticationClientSecret

TimeInterval

TimeInterval: Number

UserInfo

UserInfo: {}

User profile information.

This provides a convenience mechanism for accessing information related to a user. It supports the `HasClaims` protocol, to simplify common operations against user information, and to provide consistency with the `JWT` class.

For more information about the members to use, please refer to `JSONClaimContainer`.

Type declaration

    Page Options