Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OAuthWebService

Hierarchy

  • OAuthWebService

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected http

http: Http

Protected options

options: OAuthWebServiceOptions

Static Protected instance

instance: OAuthWebService

Methods

clientCredentials

  • clientCredentials(): Promise<OAuthCredentials>

  • Perform a "client_credentials" authentication using the OAuth 2.0 server.

    Returns Promise<OAuthCredentials>

password

  • password(data: object): Promise<OAuthCredentials>

  • Perform a "password" authentication using the OAuth 2.0 server.

    Parameters

    • data: object

      The user credentials.

      • password: string
      • Optional scope?: string
      • username: string

    Returns Promise<OAuthCredentials>

refreshToken

  • refreshToken(data: object): Promise<OAuthCredentials>

  • Performs a "refresh_token" authentication using the OAuth 2.0 server.

    Parameters

    • data: object
      • refreshToken: string

    Returns Promise<OAuthCredentials>

revoke

  • revoke(accessToken?: string): Promise<void>

  • Revokes one or all tokens from a user using the OAuth 2.0 server.

    Parameters

    • Optional accessToken: string

      The user access token.

    Returns Promise<void>

secret

  • secret(accessToken: string, resources: OAuthSecretTokenResource, scopes?: string[]): Promise<OAuthSecretToken>

  • Get a secret token using a accessToken

    Parameters

    • accessToken: string

      The user access token

    • resources: OAuthSecretTokenResource

      The resources the secret token will have access to

    • Optional scopes: string[]

    Returns Promise<OAuthSecretToken>

status

  • Get the server status.

    Returns Promise<OAuthStatusResponse>

Static getBasicToken

  • getBasicToken(data: object): string

  • Get a basic token for client credentials authentication.

    Parameters

    • data: object
      • clientId: string
      • clientSecret: string

    Returns string

Static getInstance

Static initialize

Generated using TypeDoc