Class IBMCloudAuth

Simplified factory to create an for IBM Cloud.

Hierarchy

OpenIDConnectAuth
- IBMCloudAuth

Index

Methods

Methods

Static create

create(vertx: Vertx, region: string, clientId: string, clientSecret: string, guid: string): OAuth2Auth
create(vertx: Vertx, region: string, clientId: string, clientSecret: string, guid: string, httpClientOptions: HttpClientOptions): OAuth2Auth

- Defined in io.vertx/vertx-auth-oauth2/target/npm/index.d.ts:309
Create a OAuth2Auth provider for IBM Cloud

Parameters
- vertx: Vertx
- region: string
- clientId: string
- clientSecret: string
- guid: string
Returns OAuth2Auth
- Defined in io.vertx/vertx-auth-oauth2/target/npm/index.d.ts:314
Create a OAuth2Auth provider for IBM Cloud

Parameters
- vertx: Vertx
- region: string
- clientId: string
- clientSecret: string
- guid: string
- httpClientOptions: HttpClientOptions
Returns OAuth2Auth

Static discover

discover(vertx: Vertx, config: OAuth2Options): PromiseLike<OAuth2Auth>
discover(vertx: Vertx, config: OAuth2Options, handler: ((res: AsyncResult<OAuth2Auth>) => void) | Handler<AsyncResult<OAuth2Auth>>): void

Overrides OpenIDConnectAuth.discover
- Defined in io.vertx/vertx-auth-oauth2/target/npm/index.d.ts:324
Create a OAuth2Auth provider for OpenID Connect Discovery. The discovery will use the default site in the configuration options and attempt to load the well known descriptor. If a site is provided (for example when running on a custom instance) that site will be used to do the lookup.

If the discovered config includes a json web key url, it will be also fetched and the JWKs will be loaded into the OAuth provider so tokens can be decoded.

Parameters
- vertx: Vertx
- config: OAuth2Options
Returns PromiseLike<OAuth2Auth>
Overrides OpenIDConnectAuth.discover
- Defined in io.vertx/vertx-auth-oauth2/target/npm/index.d.ts:334
Create a OAuth2Auth provider for OpenID Connect Discovery. The discovery will use the default site in the configuration options and attempt to load the well known descriptor. If a site is provided (for example when running on a custom instance) that site will be used to do the lookup.

If the discovered config includes a json web key url, it will be also fetched and the JWKs will be loaded into the OAuth provider so tokens can be decoded.

Parameters
- vertx: Vertx
- config: OAuth2Options
- handler: ((res: AsyncResult<OAuth2Auth>) => void) | Handler<AsyncResult<OAuth2Auth>>
Returns void

Generated using TypeDoc